Notation used in Ruby API documentation
Module: rdb
Description: A value object inside the report database
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).
| new RdbItemValue ptr | new | (double f) | Creates a value representing a numeric value |
| new RdbItemValue ptr | new | (string s) | Creates a value representing a string |
| new RdbItemValue ptr | new | (const DPolygon p) | Creates a value representing a DPolygon object |
| new RdbItemValue ptr | new | (const DPath p) | Creates a value representing a DPath object |
| new RdbItemValue ptr | new | (const DText t) | Creates a value representing a DText object |
| new RdbItemValue ptr | new | (const DEdge e) | Creates a value representing a DEdge object |
| new RdbItemValue ptr | new | (const DEdgePair ee) | Creates a value representing a DEdgePair object |
| new RdbItemValue ptr | new | (const DBox b) | Creates a value representing a DBox object |
| [const] | RdbItemValue ptr | _const_cast | Returns a non-const reference to self. | |
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly destroys the object | ||
| [const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
| [const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
| void | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. | ||
| void | assign | (const RdbItemValue other) | Assigns another object to self | |
| [const] | DBox | box | Gets the box if the value represents one. | |
| [const] | new RdbItemValue ptr | dup | Creates a copy of self | |
| [const] | DEdge | edge | Gets the edge if the value represents one. | |
| [const] | DEdgePair | edge_pair | Gets the edge pair if the value represents one. | |
| [const] | double | float | Gets the numeric value. | |
| [const] | bool | is_box? | Returns true if the value object represents a box | |
| [const] | bool | is_edge? | Returns true if the value object represents an edge | |
| [const] | bool | is_edge_pair? | Returns true if the value object represents an edge pair | |
| [const] | bool | is_float? | Returns true if the value object represents a numeric value | |
| [const] | bool | is_path? | Returns true if the value object represents a path | |
| [const] | bool | is_polygon? | Returns true if the value object represents a polygon | |
| [const] | bool | is_string? | Returns true if the object represents a string value | |
| [const] | bool | is_text? | Returns true if the value object represents a text | |
| [const] | DPath | path | Gets the path if the value represents one. | |
| [const] | DPolygon | polygon | Gets the polygon if the value represents one. | |
| [const] | string | string | Gets the string representation of the value. | |
| [const] | unsigned long | tag_id | Gets the tag ID if the value is a tagged value or 0 if not | |
| void | tag_id= | (unsigned long id) | Sets the tag ID to make the value a tagged value or 0 to reset it | |
| [const] | DText | text | Gets the text if the value represents one. | |
| [const] | string | to_s | Converts a value to a string |
| RdbItemValue ptr | from_s | (string s) | Creates a value object from a string |
| void | create | Use of this method is deprecated. Use _create instead | ||
| void | destroy | Use of this method is deprecated. Use _destroy instead | ||
| [const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
_const_cast | Signature: [const] RdbItemValue ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6. | ||
_create | Signature: void _create Description: 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. | ||
_destroy | Signature: void _destroy Description: 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. | ||
_destroyed? | Signature: [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. | ||
_is_const_object? | Signature: [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. | ||
_manage | Signature: void _manage Description: 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. | ||
_unmanage | Signature: void _unmanage Description: 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. | ||
assign | Signature: void assign (const RdbItemValue other) Description: Assigns another object to self | ||
box | Signature: [const] DBox box Description: Gets the box if the value represents one.
| ||
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead 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. | ||
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead 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. | ||
destroyed? | Signature: [const] bool destroyed? Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead 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. | ||
dup | Signature: [const] new RdbItemValue ptr dup Description: Creates a copy of self Python specific notes: | ||
edge | Signature: [const] DEdge edge Description: Gets the edge if the value represents one.
| ||
edge_pair | Signature: [const] DEdgePair edge_pair Description: Gets the edge pair if the value represents one.
| ||
float | Signature: [const] double float Description: Gets the numeric value.
This method has been introduced in version 0.24. | ||
from_s | Signature: [static] RdbItemValue ptr from_s (string s) Description: Creates a value object from a string The string format is the same than obtained by the to_s method. | ||
is_box? | Signature: [const] bool is_box? Description: Returns true if the value object represents a box | ||
is_const_object? | Signature: [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 This method returns true, if self is a const reference. In that case, only const methods may be called on self. | ||
is_edge? | Signature: [const] bool is_edge? Description: Returns true if the value object represents an edge | ||
is_edge_pair? | Signature: [const] bool is_edge_pair? Description: Returns true if the value object represents an edge pair | ||
is_float? | Signature: [const] bool is_float? Description: Returns true if the value object represents a numeric value This method has been introduced in version 0.24. | ||
is_path? | Signature: [const] bool is_path? Description: Returns true if the value object represents a path This method has been introduced in version 0.22. | ||
is_polygon? | Signature: [const] bool is_polygon? Description: Returns true if the value object represents a polygon | ||
is_string? | Signature: [const] bool is_string? Description: Returns true if the object represents a string value | ||
is_text? | Signature: [const] bool is_text? Description: Returns true if the value object represents a text This method has been introduced in version 0.22. | ||
new | (1) Signature: [static] new RdbItemValue ptr new (double f) Description: Creates a value representing a numeric value This variant has been introduced in version 0.24 Python specific notes: | ||
(2) Signature: [static] new RdbItemValue ptr new (string s) Description: Creates a value representing a string Python specific notes: | |||
(3) Signature: [static] new RdbItemValue ptr new (const DPolygon p) Description: Creates a value representing a DPolygon object Python specific notes: | |||
(4) Signature: [static] new RdbItemValue ptr new (const DPath p) Description: Creates a value representing a DPath object This method has been introduced in version 0.22. Python specific notes: | |||
(5) Signature: [static] new RdbItemValue ptr new (const DText t) Description: Creates a value representing a DText object This method has been introduced in version 0.22. Python specific notes: | |||
(6) Signature: [static] new RdbItemValue ptr new (const DEdge e) Description: Creates a value representing a DEdge object Python specific notes: | |||
(7) Signature: [static] new RdbItemValue ptr new (const DEdgePair ee) Description: Creates a value representing a DEdgePair object Python specific notes: | |||
(8) Signature: [static] new RdbItemValue ptr new (const DBox b) Description: Creates a value representing a DBox object Python specific notes: | |||
path | Signature: [const] DPath path Description: Gets the path if the value represents one.
This method has been introduced in version 0.22. | ||
polygon | Signature: [const] DPolygon polygon Description: Gets the polygon if the value represents one.
| ||
string | Signature: [const] string string Description: Gets the string representation of the value.
| ||
tag_id | Signature: [const] unsigned long tag_id Description: Gets the tag ID if the value is a tagged value or 0 if not
See tag_id= for details about tagged values. Tagged values have been added in version 0.24. Python specific notes: | ||
tag_id= | Signature: void tag_id= (unsigned long id) Description: Sets the tag ID to make the value a tagged value or 0 to reset it
To get a tag ID, use RdbDatabase#user_tag_id (preferred) or RdbDatabase#tag_id (for internal use). Tagged values have been added in version 0.24. Tags can be given to identify a value, for example to attache measurement values to an item. To attach a value for a specific measurement, a tagged value can be used where the tag ID describes the measurement made. In that way, multiple values for different measurements can be attached to an item. This variant has been introduced in version 0.24 Python specific notes: | ||
text | Signature: [const] DText text Description: Gets the text if the value represents one.
This method has been introduced in version 0.22. | ||
to_s | Signature: [const] string to_s Description: Converts a value to a string
The string can be used by the string constructor to create another object from it. Python specific notes: |