API reference - Class Library

Notation used in Ruby API documentation

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.

Public constructors

new Library ptrnewCreates a new, empty library

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly 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_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voiddeleteDeletes the library
[const]stringdescriptionReturns the libraries' description text
voiddescription=(string description)Sets the libraries' description text
[const]unsigned longidReturns the library's ID
LayoutlayoutThe layout object where the cells reside that this library defines
[const]Layoutlayout_constThe layout object where the cells reside that this library defines (const version)
[const]stringnameReturns the libraries' name
voidregister(string name)Registers the library with the given name
[const]stringtechnologyReturns name of the technology the library is associated with
voidtechnology=(string technology)sets the name of the technology the library is associated with

Public static methods and constants

Library ptrlibrary_by_name(string name)Gets a library by name
string[]library_namesReturns a list of the names of all libraries registered in the system.

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

_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.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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:
The object exposes a readable attribute 'description'. This is the getter.

description=

Signature: void description= (string description)

Description: Sets the libraries' description text

Python specific notes:
The object exposes a writable attribute 'description'. This is the setter.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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

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

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_name

Signature: [static] Library ptr library_by_name (string name)

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.

library_names

Signature: [static] string[] library_names

Description: Returns a list of the names of all libraries registered in the system.

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:
This method is the default initializer of the object

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, it will be replaced with this library.

This method will set the libraries' name.

technology

Signature: [const] string technology

Description: Returns name of the technology the library is associated with

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.

Python specific notes:
The object exposes a readable attribute 'technology'. This is the getter.

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.

Python specific notes:
The object exposes a writable attribute 'technology'. This is the setter.