API reference - Class RdbItem

Notation used in Ruby API documentation

Description: A RDB item

• Public methods
• Detailed description

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.

Public methods

Detailed description

void add_tag(unsigned int 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.

void add_value(const RdbItemValue value)

Description: Adds a value object to the values of this item

[const] unsigned int category_id

Description: Gets the category ID

Returns the ID of the category that this item is associated with.

[const] unsigned int cell_id

Description: Gets the cell ID

Returns the ID of the cell that this item is associated with.

void clear_values

Description: Removes all values from this item

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.

void 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: 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.

[const,iter] RdbItemValue each_value

Description: Iterates over all values

[const] bool has_tag?(unsigned int tag_id)

Description: Returns a value indicating whether the item has a tag with the given ID

[const] string image_str

Description: Gets the image associated with this item as a string

void image_str=(string image)

Description: Sets the image from a string

[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.

[const] bool is_visited?

Description: Gets a value indicating whether the item was already visited

void remove_tag(unsigned int 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.

[const] string tags_str

Description: Returns a string listing all tags of this item

void tags_str=(string tags)

Description: Sets the tags from a string