Notation used in Ruby API documentation
Module: rdb
Description: An item inside the report database
An item is the basic information entity in the RDB. It is associated with a cell and a category. It can be assigned values which encapsulate other objects such as strings and geometrical objects. In addition, items can be assigned an image (i.e. a screenshot image) and tags which are basically boolean flags that can be defined freely.
| new RdbItem ptr | new | Creates a new object of this class |
| [const] | RdbItem 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 | add_tag | (unsigned long tag_id) | Adds a tag with the given id to the item | |
| void | add_value | (const RdbItemValue value) | Adds a value object to the values of this item | |
| void | add_value | (const DPolygon value) | Adds a polygon object to the values of this item | |
| void | add_value | (const DBox value) | Adds a box object to the values of this item | |
| void | add_value | (const DEdge value) | Adds an edge object to the values of this item | |
| void | add_value | (const DEdgePair value) | Adds an edge pair object to the values of this item | |
| void | add_value | (string value) | Adds a string object to the values of this item | |
| void | add_value | (double value) | Adds a numeric value to the values of this item | |
| void | add_value | (const Shape shape, const CplxTrans trans) | Adds a geometrical value object from a shape | |
| void | assign | (const RdbItem other) | Assigns another object to self | |
| [const] | unsigned long | category_id | Gets the category ID | |
| [const] | unsigned long | cell_id | Gets the cell ID | |
| void | clear_values | Removes all values from this item | ||
| [const] | string | comment | Gets the common associated with this item as a string | |
| void | comment= | (string comment) | Sets the common associated with this item as a string | |
| [const] | const ReportDatabase ptr | database | Gets the database object that item is associated with | |
| [const] | new RdbItem ptr | dup | Creates a copy of self | |
| [const,iter] | RdbItemValue | each_value | Iterates over all values | |
| [const] | bool | has_image? | Gets a value indicating that the item has an image attached | |
| [const] | bool | has_tag? | (unsigned long tag_id) | Returns a value indicating whether the item has a tag with the given ID |
| [const] | QImage | image | Gets the attached image as a QImage object | |
| void | image= | (const QImage arg1) | Sets the attached image from a QImage object | |
| [const] | string | image_str | Gets the image associated with this item as a string | |
| void | image_str= | (string image) | Sets the image from a string | |
| [const] | bool | is_visited? | Gets a value indicating whether the item was already visited | |
| void | remove_tag | (unsigned long tag_id) | Remove the tag with the given id from the item | |
| void | remove_tags | Removes all tags from the item | ||
| [const] | string | tags_str | Returns a string listing all tags of this item | |
| void | tags_str= | (string tags) | Sets the tags 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] RdbItem 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. | |||
add_tag | Signature: void add_tag (unsigned long tag_id) Description: Adds a tag with the given id to the item Each tag can be added once to the item. The tags of an item thus form a set. If a tag with that ID already exists, this method does nothing. | |||
add_value | (1) Signature: void add_value (const RdbItemValue value) Description: Adds a value object to the values of this item
| |||
(2) Signature: void add_value (const DPolygon value) Description: Adds a polygon object to the values of this item
This method has been introduced in version 0.25 as a convenience method. | ||||
(3) Signature: void add_value (const DBox value) Description: Adds a box object to the values of this item
This method has been introduced in version 0.25 as a convenience method. | ||||
(4) Signature: void add_value (const DEdge value) Description: Adds an edge object to the values of this item
This method has been introduced in version 0.25 as a convenience method. | ||||
(5) Signature: void add_value (const DEdgePair value) Description: Adds an edge pair object to the values of this item
This method has been introduced in version 0.25 as a convenience method. | ||||
(6) Signature: void add_value (string value) Description: Adds a string object to the values of this item
This method has been introduced in version 0.25 as a convenience method. | ||||
(7) Signature: void add_value (double value) Description: Adds a numeric value to the values of this item
This method has been introduced in version 0.25 as a convenience method. | ||||
(8) Signature: void add_value (const Shape shape, const CplxTrans trans) Description: Adds a geometrical value object from a shape
The transformation can be used to convert database units to micron units. This method has been introduced in version 0.25.3. | ||||
assign | Signature: void assign (const RdbItem other) Description: Assigns another object to self | |||
category_id | Signature: [const] unsigned long category_id Description: Gets the category ID
Returns the ID of the category that this item is associated with. | |||
cell_id | Signature: [const] unsigned long cell_id Description: Gets the cell ID
Returns the ID of the cell that this item is associated with. | |||
clear_values | Signature: void clear_values Description: Removes all values from this item | |||
comment | Signature: [const] string comment Description: Gets the common associated with this item as a string
The comment string is an arbitrary string added by the user to the item. This attribute has been added in version 0.29.1. Python specific notes: | |||
comment= | Signature: void comment= (string comment) Description: Sets the common associated with this item as a string See comment for a description of that attribute. This attribute has been added in version 0.29.1. Python specific notes: | |||
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. | |||
database | Signature: [const] const ReportDatabase ptr database Description: Gets the database object that item is associated with This method has been introduced in version 0.23. | |||
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 RdbItem ptr dup Description: Creates a copy of self Python specific notes: | |||
each_value | Signature: [const,iter] RdbItemValue each_value Description: Iterates over all values | |||
has_image? | Signature: [const] bool has_image? Description: Gets a value indicating that the item has an image attached See image_str how to obtain the image. This method has been introduced in version 0.28. | |||
has_tag? | Signature: [const] bool has_tag? (unsigned long tag_id) Description: Returns a value indicating whether the item has a tag with the given ID
| |||
image | Signature: [const] QImage image Description: Gets the attached image as a QImage object This method has been added in version 0.28. Python specific notes: | |||
image= | Signature: void image= (const QImage arg1) Description: Sets the attached image from a QImage object This method has been added in version 0.28. Python specific notes: | |||
image_str | Signature: [const] string image_str Description: Gets the image associated with this item as a string
Python specific notes: | |||
image_str= | Signature: void image_str= (string image) Description: Sets the image from a string
Python specific notes: | |||
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_visited? | Signature: [const] bool is_visited? Description: Gets a value indicating whether the item was already visited
| |||
new | Signature: [static] new RdbItem ptr new Description: Creates a new object of this class Python specific notes: | |||
remove_tag | Signature: void remove_tag (unsigned long tag_id) Description: Remove the tag with the given id from the item If a tag with that ID does not exists on this item, this method does nothing. | |||
remove_tags | Signature: void remove_tags Description: Removes all tags from the item This method has been introduced in version 0.29.1. | |||
tags_str | Signature: [const] string tags_str Description: Returns a string listing all tags of this item
Python specific notes: | |||
tags_str= | Signature: void tags_str= (string tags) Description: Sets the tags from a string
Python specific notes: |