Class RdbItemValue (version 0.20)

Description: A RDB value object

Value objects are attached to items to provide markers. An arbitrary number of such value objects can be attached to an item. Currently, a value can represent a box, a polygon or an edge. Geometrical objects are represented in micron units and are therefore "D" type objects (DPolygon, DEdge and DBox).

Class overview

Index

Method Overview

[static] RdbItemValue from_s( string ) Creates a value object from a string

[static] ref RdbItemValue new( string ) Creates a value representing a string

[static] ref RdbItemValue new( DPolygon ) Creates a value representing a DPolygon object

[static] ref RdbItemValue new( DEdge ) Creates a value representing a DEdge object

[static] ref RdbItemValue new( DBox ) Creates a value representing a DBox object

[const] string to_s Converts a value to a string

[const] bool is_string? Returns true if the value object represents a string

[const] string string Gets the string if the value represents one or nil if it does not.

[const] bool is_polygon? Returns true if the value object represents a polygon

[const] DPolygon polygon Gets the polygon if the value represents one or nil if it does not.

[const] bool is_edge? Returns true if the value object represents an edge

[const] DEdge edge Gets the edge if the value represents one or nil if it does not.

[const] bool is_box? Returns true if the value object represents a box

[const] DBox box Gets the box if the value represents one or nil if it does not.

assign( RdbItemValue other ) Assign the contents of another object to self

[const] RdbItemValue dup Creates a copy of self.

destroy Explicitly destroy the object

[const] bool destroyed Tell, if the object was destroyed

assign( RdbItemValue 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] DBox box

Description: Gets the box if the value represents one or nil if it does not.

returns: The DBox object or nil

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.