Notation used in Ruby API documentation
Module: db
Description: A single or array cell instance in micrometer units
This object is identical to CellInstArray, except that it holds coordinates in micron units instead of database units.
This class has been introduced in version 0.25.
new DCellInstArray ptr | new | Creates en empty cell instance with size 0 | |
new DCellInstArray ptr | new | (unsigned int cell_index, const DTrans trans) | Creates a single cell instance |
new DCellInstArray ptr | new | (const Cell ptr cell, const DTrans trans) | Creates a single cell instance |
new DCellInstArray ptr | new | (unsigned int cell_index, const DVector disp) | Creates a single cell instance |
new DCellInstArray ptr | new | (const Cell ptr cell, const DVector disp) | Creates a single cell instance |
new DCellInstArray ptr | new | (unsigned int cell_index, const DCplxTrans trans) | Creates a single cell instance with a complex transformation |
new DCellInstArray ptr | new | (const Cell ptr cell, const DCplxTrans trans) | Creates a single cell instance with a complex transformation |
new DCellInstArray ptr | new | (unsigned int cell_index, const DTrans trans, const DVector a, const DVector b, unsigned long na, unsigned long nb) | Creates a single cell instance |
new DCellInstArray ptr | new | (const Cell ptr cell, const DTrans trans, const DVector a, const DVector b, unsigned long na, unsigned long nb) | Creates a single cell instance |
new DCellInstArray ptr | new | (unsigned int cell_index, const DVector disp, const DVector a, const DVector b, unsigned long na, unsigned long nb) | Creates a single cell instance |
new DCellInstArray ptr | new | (const Cell ptr cell, const DVector disp, const DVector a, const DVector b, unsigned long na, unsigned long nb) | Creates a single cell instance |
new DCellInstArray ptr | new | (unsigned int cell_index, const DCplxTrans trans, const DVector a, const DVector b, unsigned long na, unsigned long nb) | Creates a single cell instance with a complex transformation |
new DCellInstArray ptr | new | (const Cell ptr cell, const DCplxTrans trans, const DVector a, const DVector b, unsigned long na, unsigned long nb) | Creates a single cell instance with a complex transformation |
[const] | bool | != | (const DCellInstArray other) | Compares two arrays for inequality |
[const] | bool | < | (const DCellInstArray other) | Compares two arrays for 'less' |
[const] | bool | == | (const DCellInstArray other) | Compares two arrays for equality |
[const] | DCellInstArray 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. | ||
[const] | DVector | a | Gets the displacement vector for the 'a' axis | |
void | a= | (const DVector vector) | Sets the displacement vector for the 'a' axis | |
void | assign | (const DCellInstArray other) | Assigns another object to self | |
[const] | DVector | b | Gets the displacement vector for the 'b' axis | |
void | b= | (const DVector vector) | Sets the displacement vector for the 'b' axis | |
[const] | DBox | bbox | (const Layout layout, unsigned int layer_index) | Gets the bounding box of the array with respect to one layer |
[const] | DBox | bbox | (const Layout layout) | Gets the bounding box of the array |
void | cell= | (Cell ptr cell) | Sets the cell this instance refers to | |
[const] | unsigned int | cell_index | Gets the cell index of the cell instantiated | |
void | cell_index= | (unsigned int index) | Sets the index of the cell this instance refers to | |
[const] | DCplxTrans | cplx_trans | Gets the complex transformation of the first instance in the array | |
void | cplx_trans= | (const DCplxTrans trans) | Sets the complex transformation of the instance or the first instance in the array | |
[const] | new DCellInstArray ptr | dup | Creates a copy of self | |
[const,iter] | DCplxTrans | each_cplx_trans | Gets the complex transformations represented by this instance | |
[const,iter] | DTrans | each_trans | Gets the simple transformations represented by this instance | |
[const] | unsigned long | hash | Computes a hash value | |
void | invert | Inverts the array reference | ||
[const] | bool | is_complex? | Gets a value indicating whether the array is a complex array | |
[const] | bool | is_regular_array? | Gets a value indicating whether this instance is a regular array | |
[const] | unsigned long | na | Gets the number of instances in the 'a' axis | |
void | na= | (unsigned long n) | Sets the number of instances in the 'a' axis | |
[const] | unsigned long | nb | Gets the number of instances in the 'b' axis | |
void | nb= | (unsigned long n) | Sets the number of instances in the 'b' axis | |
[const] | unsigned long | size | Gets the number of single instances in the array | |
[const] | string | to_s | Converts the array to a string | |
[const] | DTrans | trans | Gets the transformation of the first instance in the array | |
void | trans= | (const DTrans t) | Sets the transformation of the instance or the first instance in the array | |
void | transform | (const DTrans trans) | Transforms the cell instance with the given transformation | |
void | transform | (const DCplxTrans trans) | Transforms the cell instance with the given complex transformation | |
[const] | DCellInstArray | transformed | (const DTrans trans) | Gets the transformed cell instance |
[const] | DCellInstArray | transformed | (const DCplxTrans trans) | Gets the transformed cell instance (complex transformation) |
[const] | DBox | bbox_per_layer | (const Layout layout, unsigned int layer_index) | Use of this method is deprecated. Use bbox instead |
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 |
!= | Signature: [const] bool != (const DCellInstArray other) Description: Compares two arrays for inequality | |||||||||||
< | Signature: [const] bool < (const DCellInstArray other) Description: Compares two arrays for 'less' The comparison provides an arbitrary sorting criterion and not specific sorting order. It is guaranteed that if an array a is less than b, b is not less than a. In addition, it a is not less than b and b is not less than a, then a is equal to b. | |||||||||||
== | Signature: [const] bool == (const DCellInstArray other) Description: Compares two arrays for equality | |||||||||||
_const_cast | Signature: [const] DCellInstArray 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. | |||||||||||
a | Signature: [const] DVector a Description: Gets the displacement vector for the 'a' axis Python specific notes: | |||||||||||
a= | Signature: void a= (const DVector 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. Python specific notes: | |||||||||||
assign | Signature: void assign (const DCellInstArray other) Description: Assigns another object to self | |||||||||||
b | Signature: [const] DVector b Description: Gets the displacement vector for the 'b' axis Python specific notes: | |||||||||||
b= | Signature: void b= (const DVector 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. Python specific notes: | |||||||||||
bbox | (1) Signature: [const] DBox bbox (const Layout layout, unsigned int layer_index) Description: Gets 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. 'bbox' is the preferred synonym since version 0.28. | |||||||||||
(2) Signature: [const] DBox bbox (const Layout layout) Description: Gets 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. | ||||||||||||
bbox_per_layer | Signature: [const] DBox bbox_per_layer (const Layout layout, unsigned int layer_index) Description: Gets the bounding box of the array with respect to one layer Use of this method is deprecated. Use bbox instead The bounding box incorporates all instances that the array represents. It needs the layout object to access the actual cell from the cell index. 'bbox' is the preferred synonym since version 0.28. | |||||||||||
cell= | Signature: void cell= (Cell ptr cell) Description: Sets the cell this instance refers to This is a convenience method and equivalent to 'cell_index = cell.cell_index()'. There is no getter for the cell pointer because the CellInstArray object only knows about cell indexes. This convenience method has been introduced in version 0.28. Python specific notes: | |||||||||||
cell_index | Signature: [const] unsigned int cell_index Description: Gets the cell index of the cell instantiated Use Layout#cell to get the Cell object from the cell index. Python specific notes: | |||||||||||
cell_index= | Signature: void cell_index= (unsigned int index) Description: Sets the index of the cell this instance refers to Python specific notes: | |||||||||||
cplx_trans | Signature: [const] DCplxTrans cplx_trans Description: Gets the complex transformation of the first instance in the array This method is always applicable, compared to trans, since simple transformations can be expressed as complex transformations as well. Python specific notes: | |||||||||||
cplx_trans= | Signature: void cplx_trans= (const DCplxTrans trans) Description: Sets the complex transformation of the instance or the first instance in the array Python specific notes: | |||||||||||
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. | |||||||||||
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 DCellInstArray ptr dup Description: Creates a copy of self Python specific notes: | |||||||||||
each_cplx_trans | Signature: [const,iter] DCplxTrans each_cplx_trans Description: Gets the complex transformations represented by this instance For a single instance, this iterator will deliver the single, complex transformation. For array instances, the iterator will deliver each complex transformation of the expanded array. This iterator is a generalization of each_trans for general complex transformations. | |||||||||||
each_trans | Signature: [const,iter] DTrans each_trans Description: Gets the simple transformations represented by this instance For a single instance, this iterator will deliver the single, simple transformation. For array instances, the iterator will deliver each simple transformation of the expanded array. This iterator will only deliver valid transformations if the instance array is not of complex type (see is_complex?). A more general iterator that delivers the complex transformations is each_cplx_trans. | |||||||||||
hash | Signature: [const] unsigned long hash Description: Computes a hash value Returns a hash value for the given cell instance. This method enables cell instances as hash keys. This method has been introduced in version 0.25. Python specific notes: | |||||||||||
invert | Signature: void invert Description: Inverts the array reference The inverted array reference describes in which transformations the parent cell is seen from the current cell. | |||||||||||
is_complex? | Signature: [const] bool is_complex? Description: Gets a value indicating whether the array is a complex array Returns true if the array represents complex instances (that is, with magnification and arbitrary rotation angles). | |||||||||||
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_regular_array? | Signature: [const] bool is_regular_array? Description: Gets a value indicating whether this instance is a regular array | |||||||||||
na | Signature: [const] unsigned long na Description: Gets the number of instances in the 'a' axis Python specific notes: | |||||||||||
na= | Signature: 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. Python specific notes: | |||||||||||
nb | Signature: [const] unsigned long nb Description: Gets the number of instances in the 'b' axis Python specific notes: | |||||||||||
nb= | Signature: 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. Python specific notes: | |||||||||||
new | (1) Signature: [static] new DCellInstArray ptr new Description: Creates en empty cell instance with size 0 Python specific notes: | |||||||||||
(2) Signature: [static] new DCellInstArray ptr new (unsigned int cell_index, const DTrans trans) Description: Creates a single cell instance
Python specific notes: | ||||||||||||
(3) Signature: [static] new DCellInstArray ptr new (const Cell ptr cell, const DTrans trans) Description: Creates a single cell instance
This convenience variant takes a Cell pointer and is equivalent to using 'cell.cell_index()'. It has been introduced in version 0.28. Python specific notes: | ||||||||||||
(4) Signature: [static] new DCellInstArray ptr new (unsigned int cell_index, const DVector disp) Description: Creates a single cell instance
This convenience initializer has been introduced in version 0.28. Python specific notes: | ||||||||||||
(5) Signature: [static] new DCellInstArray ptr new (const Cell ptr cell, const DVector disp) Description: Creates a single cell instance
This convenience variant takes a Cell pointer and is equivalent to using 'cell.cell_index()'. It has been introduced in version 0.28. Python specific notes: | ||||||||||||
(6) Signature: [static] new DCellInstArray ptr new (unsigned int cell_index, const DCplxTrans trans) Description: Creates a single cell instance with a complex transformation
Python specific notes: | ||||||||||||
(7) Signature: [static] new DCellInstArray ptr new (const Cell ptr cell, const DCplxTrans trans) Description: Creates a single cell instance with a complex transformation
This convenience variant takes a Cell pointer and is equivalent to using 'cell.cell_index()'. It has been introduced in version 0.28. Python specific notes: | ||||||||||||
(8) Signature: [static] new DCellInstArray ptr new (unsigned int cell_index, const DTrans trans, const DVector a, const DVector b, unsigned long na, unsigned long nb) Description: Creates a single cell instance
Python specific notes: | ||||||||||||
(9) Signature: [static] new DCellInstArray ptr new (const Cell ptr cell, const DTrans trans, const DVector a, const DVector b, unsigned long na, unsigned long nb) Description: Creates a single cell instance
This convenience variant takes a Cell pointer and is equivalent to using 'cell.cell_index()'. It has been introduced in version 0.28. Python specific notes: | ||||||||||||
(10) Signature: [static] new DCellInstArray ptr new (unsigned int cell_index, const DVector disp, const DVector a, const DVector b, unsigned long na, unsigned long nb) Description: Creates a single cell instance
This convenience initializer has been introduced in version 0.28. Python specific notes: | ||||||||||||
(11) Signature: [static] new DCellInstArray ptr new (const Cell ptr cell, const DVector disp, const DVector a, const DVector b, unsigned long na, unsigned long nb) Description: Creates a single cell instance
This convenience variant takes a Cell pointer and is equivalent to using 'cell.cell_index()'. It has been introduced in version 0.28. Python specific notes: | ||||||||||||
(12) Signature: [static] new DCellInstArray ptr new (unsigned int cell_index, const DCplxTrans trans, const DVector a, const DVector b, unsigned long na, unsigned long nb) Description: Creates a single cell instance with a complex transformation
Python specific notes: | ||||||||||||
(13) Signature: [static] new DCellInstArray ptr new (const Cell ptr cell, const DCplxTrans trans, const DVector a, const DVector b, unsigned long na, unsigned long nb) Description: Creates a single cell instance with a complex transformation
This convenience variant takes a Cell pointer and is equivalent to using 'cell.cell_index()'. It has been introduced in version 0.28. Python specific notes: | ||||||||||||
size | Signature: [const] unsigned long size Description: Gets the number of single instances in the array If the instance represents a single instance, the count is 1. Otherwise it is na*nb. Starting with version 0.27, there may be iterated instances for which the size is larger than 1, but is_regular_array? will return false. In this case, use each_trans or each_cplx_trans to retrieve the individual placements of the iterated instance. Python specific notes: | |||||||||||
to_s | Signature: [const] string to_s Description: Converts the array to a string Python specific notes: | |||||||||||
trans | Signature: [const] DTrans trans Description: Gets 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: | |||||||||||
trans= | Signature: void trans= (const DTrans t) Description: Sets the transformation of the instance or the first instance in the array Python specific notes: | |||||||||||
transform | (1) Signature: void transform (const DTrans trans) Description: Transforms the cell instance with the given transformation | |||||||||||
(2) Signature: void transform (const DCplxTrans trans) Description: Transforms the cell instance with the given complex transformation | ||||||||||||
transformed | (1) Signature: [const] DCellInstArray transformed (const DTrans trans) Description: Gets the transformed cell instance | |||||||||||
(2) Signature: [const] DCellInstArray transformed (const DCplxTrans trans) Description: Gets the transformed cell instance (complex transformation) |