Class ParentInstArray (version 0.18)

Description: A parent instance

A parent instance is basically an inverse instance: instead of pointing to the child cell, it is pointing to the parent cell and the transformation is representing the shift of the parent cell relative to the child cell. For memory performance, a parent instance is not stored as a instance but rather as a reference to a child instance and a reference to the cell which is the parent. The parent instance itself is computed on the fly. It is representative for a set of instances belonging to the same cell index. The special parent instance iterator takes care of producing the right sequence.

Class overview

Index

Method Overview

[const] unsigned int parent_cell_indexRetrieve the reference to the parent cell
[const] Instance child_instRetrieve the child instance associated with this parent instance
[const] CellInstArray instCompute the inverse instance by which the parent is seen from the child
assign( ParentInstArray other )Assign the contents of another object to self
[const] ParentInstArray dupCreates a copy of self.
destroyExplicitly destroy the object
[const] bool destroyedTell, if the object was destroyed

assign( ParentInstArray 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] Instance child_inst

Description: Retrieve the child instance associated with this parent instance

Starting with version 0.15, this method returns an Instance object rather than a CellInstArray reference.

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] ParentInstArray dup

Description: Creates a copy of self.

[const] CellInstArray inst

Description: Compute the inverse instance by which the parent is seen from the child

[const] unsigned int parent_cell_index

Description: Retrieve the reference to the parent cell