Class LayerInfo (version 0.20)

Description: A structure encapsulating the layer properties

The layer properties describe how a layer is stored in a GDSII or OASIS file for example.

Class overview

Index

Method Overview

[static] LayerInfo new	The default constructor.
[static] LayerInfo new( int layer, int datatype )	The constructor for a layer/datatype pair.
[static] LayerInfo new( string name )	The constructor for a named layer.
[static] LayerInfo new( int layer, int datatype, string name )	The constructor for a named layer with layer and datatype.
[const] string to_s	Convert the layer info object to a string
[const] bool ==( LayerInfo b )	Compare two layer info objects
[const] bool !=( LayerInfo b )	Compare two layer info objects
[const] bool is_equivalent?( LayerInfo b )	Equivalence of two layer info objects
[const] bool is_named?	Returns true, if the layer is purely specified by name.
name=( string name )	Set the layer name
[const] string name	Gets the layer name
layer=( int layer )	Sets the layer number
[const] int layer	Gets the layer number
datatype=( int datatype )	Set the datatype
[const] int datatype	Gets the datatype
assign( LayerInfo other )	Assign the contents of another object to self
[const] LayerInfo dup	Creates a copy of self.
destroy	Explicitly destroy the object
[const] bool destroyed	Tell, if the object was destroyed

[const] bool !=( LayerInfo b )

Description: Compare two layer info objects

This method was added in version 0.18.

returns:

True, if both are not equal

[const] bool ==( LayerInfo b )

Description: Compare two layer info objects

This method was added in version 0.18.

returns:

True, if both are equal

assign( LayerInfo 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] int datatype

Description: Gets the datatype

datatype=( int datatype )

Description: Set the datatype

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

Description: Creates a copy of self.

[const] bool is_equivalent?( LayerInfo b )

Description: Equivalence of two layer info objects

First, layer and datatype are compared. The name is of second order and used only if no layer or datatype is given. This is basically a weak comparison that reflects the search preferences.

This method was added in version 0.18.

returns:

True, if both are equivalent

[const] bool is_named?

Description: Returns true, if the layer is purely specified by name.

This method was added in version 0.18.

returns:

True, if no layer or datatype is given.

[const] int layer

Description: Gets the layer number

layer=( int layer )

Description: Sets the layer number

[const] string name

Description: Gets the layer name

name=( string name )

Description: Set the layer name

The name is set on OASIS input for example, if the layer has a name.

[static] LayerInfo new

Description: The default constructor.

Creates a default LayerInfo object.

This method was added in version 0.18.

[static] LayerInfo new( int layer, int datatype, string name )

Description: The constructor for a named layer with layer and datatype.

Creates a LayerInfo object representing a named layer with layer and datatype.

This method was added in version 0.18.

layer:	The layer number
datatype:	The datatype number
name:	The name

[static] LayerInfo new( int layer, int datatype )

Description: The constructor for a layer/datatype pair.

Creates a LayerInfo object representing a layer and datatype.

This method was added in version 0.18.

layer:	The layer number
datatype:	The datatype number

[static] LayerInfo new( string name )

Description: The constructor for a named layer.

Creates a LayerInfo object representing a named layer.

This method was added in version 0.18.

name:

The name

[const] string to_s

Description: Convert the layer info object to a string

This method was added in version 0.18.

returns:

The string