API reference - Class InstElementNotation used in Ruby API documentation Description: An element in an instantiation path
This objects are used to reference a single instance in a instantiation path. The object is composed of a CellInstArray object (accessible through the cell_inst accessor) that describes the basic instance, which may be an array. The particular instance within the array can be further retrieved using the array_member_trans, specific_trans or specific_cplx_trans methods. Public constructors
Public methods
Deprecated methods (protected, public, static, non-static and constructors)
Detailed description[const] bool !=(const InstElement b)Description: Inequality of two InstElement objects See the comments on the == operator. [const] bool <(const InstElement b)Description: Provides an order criterion for two InstElement objects Note: this operator is just provided to establish any order, not a particular one. [const] bool ==(const InstElement b)Description: Equality of two InstElement objects Note: this operator returns true if both instance elements refer to the same instance, not just identical ones. void _createDescription: 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 _destroyDescription: 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 _manageDescription: 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 _unmanageDescription: 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] Trans array_member_transDescription: Returns the transformation for this array member The array member transformation is the one applicable in addition to the global transformation for the member selected from an array. If this instance is not an array instance, the specific transformation is a unit transformation without displacement. void assign(const InstElement other)Description: Assigns another object to self [const] const CellInstArray ptr cell_instDescription: Accessor to the cell instance (array). This method is equivalent to "self.inst.cell_inst" and provided for convenience. void createDescription: Ensures the C++ object is created Use of this method is deprecated. Use _create instead void destroyDescription: 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 InstElement ptr dupDescription: Creates a copy of self [const] Instance instDescription: Gets the Instance object held in this instance path element. This method has been added in version 0.24. [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 [static] new InstElement ptr newDescription: Default constructor Python specific notes:This method is the default initializer of the object [static] new InstElement ptr new(const Instance inst)Description: Create an instance element from a single instance alone Starting with version 0.15, this method takes an Instance object (an instance reference) as the argument. Python specific notes:This method is the default initializer of the object [static] new InstElement ptr new(const Instance inst,unsigned long a_index,unsigned long b_index)Description: Create an instance element from an array instance pointing into a certain array member Starting with version 0.15, this method takes an Instance object (an instance reference) as the first argument. Python specific notes:This method is the default initializer of the object [static] new InstElement ptr new_i(const Instance inst)Description: Create an instance element from a single instance alone Use of this method is deprecated. Use new instead [static] new InstElement ptr new_iab(const Instance inst,unsigned long a_index,unsigned long b_index)Description: Create an instance element from an array instance pointing into a certain array member Use of this method is deprecated. Use new instead [const] unsigned long prop_idDescription: Accessor to the property attached to this instance. This method is equivalent to "self.inst.prop_id" and provided for convenience. [const] CplxTrans specific_cplx_transDescription: Returns the specific complex transformation for this instance The specific transformation is the one applicable for the member selected from an array. This is the effective transformation applied for this array member. array_member_trans gives the transformation applied additionally to the instances' global transformation (in other words, specific_cplx_trans = array_member_trans * cell_inst.cplx_trans). [const] Trans specific_transDescription: Returns the specific transformation for this instance The specific transformation is the one applicable for the member selected from an array. This is the effective transformation applied for this array member. array_member_trans gives the transformation applied additionally to the instances' global transformation (in other words, specific_trans = array_member_trans * cell_inst.trans). This method delivers a simple transformation that does not include magnification components. To get these as well, use specific_cplx_trans. |