KLayout Manual: Main Index » Class Index » API reference - Class CellInstArray

API reference - Class CellInstArray

Notation used in Ruby API documentation

Description: A single or array cell instance

• Public constructors
• Public methods
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

This object represents either single or array cell instances. A cell instance array is a regular array, described by two displacement vectors (a, b) and the instance count along that axes (na, nb).

In addition, this object represents either instances with simple transformations or instances with complex transformations. The latter includes magnified instances and instances rotated by an arbitrary angle.

The cell which is instantiated is given by a cell index. The cell index can be converted to a cell pointer by using Layout#cell. The cell index of a cell can be obtained using Cell#cell_index.

See The Database API for more details about the database objects.

Public constructors

Public methods

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

Detailed description

[const] bool !=(const CellInstArray other)

Description: Compare operator for inequality

[const] bool <(const CellInstArray other)

Description: Less operator

[const] bool ==(const CellInstArray other)

Description: Compare operator for equality

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.

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.

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

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

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.

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.

[const] Point a

Description: Return the displacement vector for the 'a' axis

Python specific notes:

The object exposes a readable attribute 'a'. This is the getter.

void a=(const Point vector)

Description: Sets the displacement vector for the 'a' axis

If the instance was not regular before this property is set, it will be initialized to a regular instance. This method was introduced in version 0.22.

Python specific notes:

The object exposes a writable attribute 'a'. This is the setter.

void assign(const CellInstArray other)

Description: Assigns another object to self

[const] Point b

Description: Return the displacement vector for the 'b' axis

Python specific notes:

The object exposes a readable attribute 'b'. This is the getter.

void b=(const Point vector)

Description: Sets the displacement vector for the 'b' axis

If the instance was not regular before this property is set, it will be initialized to a regular instance. This method was introduced in version 0.22.

Python specific notes:

The object exposes a writable attribute 'b'. This is the setter.

[const] Box bbox(const Layout layout)

Description: The bounding box of the array

The bounding box incorporates all instances that the array represents. It needs the layout object to access the actual cell from the cell index.

[const] Box bbox_per_layer(const Layout layout,unsigned int layer_index)

Description: The bounding box of the array with respect to one layer

The bounding box incorporates all instances that the array represents. It needs the layout object to access the actual cell from the cell index.

[const] unsigned int cell_index

Description: Get the cell index of the cell instantiated

Python specific notes:

The object exposes a readable attribute 'cell_index'. This is the getter.

void cell_index=(unsigned int index)

Description: Set the index of the cell this instance refers to

Python specific notes:

The object exposes a writable attribute 'cell_index'. This is the setter.

[const] CplxTrans cplx_trans

Description: Get the complex transformation of the first instance in the array

This method is always valid compared to trans, since simple transformations can be expressed as complex transformations as well.

Python specific notes:

The object exposes a readable attribute 'cplx_trans'. This is the getter.

void cplx_trans=(const CplxTrans trans)

Description: Sets the complex transformation of the instance or the first instance in the array

This method was introduced in version 0.22.

Python specific notes:

The object exposes a writable attribute 'cplx_trans'. This is the setter.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[const] new CellInstArray ptr dup

Description: Creates a copy of self

void invert

Description: Invert an array reference

The inverted array reference describes in which transformations the parent cell is seen from the current cell.

[const] bool is_complex?

Description: Test, if the array is a complex array

Returns true if the array represents complex instances (that is, with magnification and arbitrary rotation angles).

[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

[const] bool is_regular_array?

Description: Test, if this instance is a regular array

[const] unsigned long na

Description: Return the number of instances in the 'a' axis

Python specific notes:

The object exposes a readable attribute 'na'. This is the getter.

void na=(unsigned long n)

Description: Sets the number of instances in the 'a' axis

If the instance was not regular before this property is set to a value larger than zero, it will be initialized to a regular instance. To make an instance a single instance, set na or nb to 0. This method was introduced in version 0.22.

Python specific notes:

The object exposes a writable attribute 'na'. This is the setter.

[const] unsigned long nb

Description: Return the number of instances in the 'b' axis

Python specific notes:

The object exposes a readable attribute 'nb'. This is the getter.

void nb=(unsigned long n)

Description: Sets the number of instances in the 'b' axis

If the instance was not regular before this property is set to a value larger than zero, it will be initialized to a regular instance. To make an instance a single instance, set na or nb to 0. This method was introduced in version 0.22.

Python specific notes:

The object exposes a writable attribute 'nb'. This is the setter.

[static] new CellInstArray ptr new

Description: Default constructor

Python specific notes:

This method is the default initializer of the object

[static] new CellInstArray ptr new(unsigned int cell_index,const Trans trans)

Description: Create a single cell instance

Python specific notes:

This method is the default initializer of the object

[static] new CellInstArray ptr new(unsigned int cell_index,const CplxTrans trans)

Description: Create a single cell instance with a complex transformation

Python specific notes:

This method is the default initializer of the object

[static] new CellInstArray ptr new(unsigned int cell_index,const Trans trans,const Point a,const Point b,unsigned int na,unsigned int nb)

Description: Create a single cell instance

Python specific notes:

This method is the default initializer of the object

[static] new CellInstArray ptr new(unsigned int cell_index,const CplxTrans trans,const Point a,const Point b,unsigned int na,unsigned int nb)

Description: Create a single cell instance with a complex transformation

Python specific notes:

This method is the default initializer of the object

[static] new CellInstArray ptr new_inst(unsigned int cell_index,const Trans trans)

Description: Create a single cell instance

Use of this method is deprecated. Use new instead

[static] new CellInstArray ptr new_inst_array(unsigned int cell_index,const Trans trans,const Point a,const Point b,unsigned int na,unsigned int nb)

Description: Create a single cell instance

Use of this method is deprecated. Use new instead

[static] new CellInstArray ptr new_inst_array_cplx(unsigned int cell_index,const CplxTrans trans,const Point a,const Point b,unsigned int na,unsigned int nb)

Description: Create a single cell instance with a complex transformation

Use of this method is deprecated. Use new instead

[static] new CellInstArray ptr new_inst_cplx(unsigned int cell_index,const CplxTrans trans)

Description: Create a single cell instance with a complex transformation

Use of this method is deprecated. Use new instead

[const] unsigned long size

Description: The number of single instances in the array

If the instance represents a single instance, the count is 1. Otherwise it is na*nb.

Python specific notes:

This method is also available as 'len(object)'

[const] string to_s

Description: Converts the array to a string

This method was introduced in version 0.22.

Python specific notes:

This method is also available as 'str(object)'

[const] Trans trans

Description: Get the transformation of the first instance in the array

The transformation returned is only valid if the array does not represent a complex transformation array

Python specific notes:

The object exposes a readable attribute 'trans'. This is the getter.

void trans=(const Trans t)

Description: Sets the transformation of the instance or the first instance in the array

This method was introduced in version 0.22.

Python specific notes:

The object exposes a writable attribute 'trans'. This is the setter.

void transform(const Trans trans)

Description: Transform the cell instance with the given transformation

This method has been introduced in version 0.20.

void transform(const CplxTrans trans)

Description: Transform the cell instance with the given complex transformation

This method has been introduced in version 0.20.

void transform(const ICplxTrans trans)

Description: Transform the cell instance with the given complex transformation

This method has been introduced in version 0.20.

[const] CellInstArray transformed(const Trans trans)

Description: Returns the transformed cell instance

This method has been introduced in version 0.20.

[const] CellInstArray transformed(const CplxTrans trans)

Description: Returns the transformed cell instance (complex transformation)

This method has been introduced in version 0.20.

[const] CellInstArray transformed(const ICplxTrans trans)

Description: Returns the transformed cell instance (complex transformation)

This method has been introduced in version 0.20.