Notation used in Ruby API documentation
Module: db
Description: A Library
A library is basically a wrapper around a layout object. The layout object provides cells and potentially PCells that can be imported into other layouts.
The library provides a name which is used to identify the library and a description which is used for identifying the library in a user interface.
After a library is created and the layout is filled, it must be registered using the register method.
This class has been introduced in version 0.22.
| new Library ptr | new | Creates a new, empty library |
| [const] | Library ptr | _const_cast | Returns a non-const reference to self. | |
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly destroys the object | ||
| [const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
| [const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
| void | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. | ||
| void | add_technology | (string tech) | Additionally associates the library with the given technology. | |
| void | assign | (const Library other) | Assigns another object to self | |
| void | clear_technologies | Clears the list of technologies the library is associated with. | ||
| void | delete | Deletes the library | ||
| [const] | string | description | Returns the libraries' description text | |
| void | description= | (string description) | Sets the libraries' description text | |
| [const] | new Library ptr | dup | Creates a copy of self | |
| [const] | bool | for_technologies | Returns a value indicating whether the library is associated with any technology. | |
| [const] | unsigned long | id | Returns the library's ID | |
| [const] | bool | is_for_technology | (string tech) | Returns a value indicating whether the library is associated with the given technology. |
| Layout | layout | The layout object where the cells reside that this library defines | ||
| [const] | Layout | layout_const | The layout object where the cells reside that this library defines (const version) | |
| [const] | string | name | Returns the libraries' name | |
| void | refresh | Updates all layouts using this library. | ||
| void | register | (string name) | Registers the library with the given name | |
| [const] | string[] | technologies | Gets the list of technologies this library is associated with. | |
| void | technology= | (string technology) | sets the name of the technology the library is associated with |
| Library ptr | library_by_id | (unsigned long id) | Gets the library object for the given ID | |
| Library ptr | library_by_name | (string name, string for_technology = unspecific) | Gets a library by name | |
| unsigned long[] | library_ids | Returns a list of valid library IDs. | ||
| string[] | library_names | Returns a list of the names of all libraries registered in the system. |
| void | create | Use of this method is deprecated. Use _create instead | ||
| void | destroy | Use of this method is deprecated. Use _destroy instead | ||
| [const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead | |
| string | technology | Use of this method is deprecated |
_const_cast | Signature: [const] Library ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6. |
_create | Signature: void _create Description: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. |
_destroy | Signature: void _destroy Description: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. |
_destroyed? | Signature: [const] bool _destroyed? Description: Returns a value indicating whether the object was already destroyed This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. |
_is_const_object? | Signature: [const] bool _is_const_object? Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. |
_manage | Signature: void _manage Description: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. |
_unmanage | Signature: void _unmanage Description: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. |
add_technology | Signature: void add_technology (string tech) Description: Additionally associates the library with the given technology. See also clear_technologies. This method has been introduced in version 0.27 |
assign | Signature: void assign (const Library other) Description: Assigns another object to self |
clear_technologies | Signature: void clear_technologies Description: Clears the list of technologies the library is associated with. See also add_technology. This method has been introduced in version 0.27 |
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. |
delete | Signature: void delete Description: Deletes the library This method will delete the library object. Library proxies pointing to this library will become invalid and the library object cannot be used any more after calling this method. This method has been introduced in version 0.25. |
description | Signature: [const] string description Description: Returns the libraries' description text Python specific notes: |
description= | Signature: void description= (string description) Description: Sets the libraries' description text Python specific notes: |
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. |
destroyed? | Signature: [const] bool destroyed? Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. |
dup | Signature: [const] new Library ptr dup Description: Creates a copy of self Python specific notes: |
for_technologies | Signature: [const] bool for_technologies Description: Returns a value indicating whether the library is associated with any technology. This method has been introduced in version 0.27 |
id | Signature: [const] unsigned long id Description: Returns the library's ID The ID is set when the library is registered and cannot be changed |
is_const_object? | Signature: [const] bool is_const_object? Description: Returns a value indicating whether the reference is a const reference Use of this method is deprecated. Use _is_const_object? instead This method returns true, if self is a const reference. In that case, only const methods may be called on self. |
is_for_technology | Signature: [const] bool is_for_technology (string tech) Description: Returns a value indicating whether the library is associated with the given technology. The method is equivalent to checking whether the technologies list is empty. This method has been introduced in version 0.27 |
layout | Signature: Layout layout Description: The layout object where the cells reside that this library defines |
layout_const | Signature: [const] Layout layout_const Description: The layout object where the cells reside that this library defines (const version) |
library_by_id | Signature: [static] Library ptr library_by_id (unsigned long id) Description: Gets the library object for the given ID If the ID is not valid, nil is returned. This method has been introduced in version 0.27. |
library_by_name | Signature: [static] Library ptr library_by_name (string name, string for_technology = unspecific) Description: Gets a library by name Returns the library object for the given name. If the name is not a valid library name, nil is returned. Different libraries can be registered under the same names for different technologies. When a technology name is given in 'for_technologies', the first library matching this technology is returned. If no technology is given, the first library is returned. The technology selector has been introduced in version 0.27. |
library_ids | Signature: [static] unsigned long[] library_ids Description: Returns a list of valid library IDs. See library_names for the reasoning behind this method. This method has been introduced in version 0.27. |
library_names | Signature: [static] string[] library_names Description: Returns a list of the names of all libraries registered in the system. NOTE: starting with version 0.27, the name of a library does not need to be unique if libraries are associated with specific technologies. This method will only return the names and it's not possible not unambiguously derive the library object. It is recommended to use library_ids and library_by_id to obtain the library unambiguously. |
name | Signature: [const] string name Description: Returns the libraries' name The name is set when the library is registered and cannot be changed |
new | Signature: [static] new Library ptr new Description: Creates a new, empty library Python specific notes: |
refresh | Signature: void refresh Description: Updates all layouts using this library. This method will retire cells or update layouts in the attached clients. It will also recompute the PCells inside the library. This method has been introduced in version 0.27.8. |
register | Signature: void register (string name) Description: Registers the library with the given name This method can be called in the constructor to register the library after the layout object has been filled with content. If a library with that name already exists for the same technologies, it will be replaced with this library. This method will set the libraries' name. The technology specific behaviour has been introduced in version 0.27. |
technologies | Signature: [const] string[] technologies Description: Gets the list of technologies this library is associated with. This method has been introduced in version 0.27 |
technology | Signature: string technology Description: Returns name of the technology the library is associated with Use of this method is deprecated If this attribute is a non-empty string, this library is only offered for selection if the current layout uses this technology. This attribute has been introduced in version 0.25. In version 0.27 this attribute is deprecated as a library can now be associated with multiple technologies. Python specific notes: |
technology= | Signature: void technology= (string technology) Description: sets the name of the technology the library is associated with See technology for details. This attribute has been introduced in version 0.25. In version 0.27, a library can be associated with multiple technologies and this method will revert the selection to a single one. Passing an empty string is equivalent to clear_technologies. Python specific notes: |