Class InstElement (version 0.18)

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.

Class overview

Index

Method Overview

[static] InstElement newDefault constructor
[static] InstElement new( Instance inst )Create an instance element from a single instance alone
[static] InstElement new( Instance inst, unsigned long a_index, unsigned long b_indexStartingwithversion0.15 )Create an instance element from an array instance pointing into a certain array member
[const] const ref CellInstArray cell_instAccessor to the cell instance (array).
[const] unsigned int prop_idAccessor to the property attached to this instance.
[const] bool <( InstElement b )Provide an order criterion for two InstElement objects
[const] bool !=( InstElement b )Inequality of two InstElement objects
[const] bool ==( InstElement b )Equality of two InstElement objects
[const] Trans specific_transReturns the specific transformation for this instance
[const] CplxTrans specific_cplx_transReturns the specific complex transformation for this instance
[const] Trans array_member_transReturns the transformation for this array member
assign( InstElement other )Assign the contents of another object to self
[const] InstElement dupCreates a copy of self.
destroyExplicitly destroy the object
[const] bool destroyedTell, if the object was destroyed

[const] bool !=( InstElement b )

Description: Inequality of two InstElement objects

Warning: this operator returns true if both instance elements refer to the same instance, not just identical ones.

[const] bool <( InstElement b )

Description: Provide an order criterion for two InstElement objects

Warning: this operator is just provided to establish any order, not a particular one.

[const] bool ==( InstElement b )

Description: Equality of two InstElement objects

See the hint on the < operator.

[const] Trans array_member_trans

Description: 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.

assign( InstElement other )

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

[const] const ref CellInstArray cell_inst

Description: Accessor to the cell instance (array).

destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[const] bool destroyed

Description: Tell, if the object was 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] InstElement dup

Description: Creates a copy of self.

[static] InstElement new( Instance inst )
synonym: [static] InstElement new_i( 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.

[static] InstElement new

Description: Default constructor

[static] InstElement new( Instance inst, unsigned long a_index, unsigned long b_indexStartingwithversion0.15 )
synonym: [static] InstElement new_iab( Instance inst, unsigned long a_index, unsigned long b_indexStartingwithversion0.15 )

Description: Create an instance element from an array instance pointing into a certain array member

[const] unsigned int prop_id

Description: Accessor to the property attached to this instance.

[const] CplxTrans specific_cplx_trans

Description: 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_trans

Description: 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.