Class RdbItem (version 0.20)

Description: A RDB item

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.

Class overview

Index

Method Overview

[const] unsigned int cell_id Gets the cell ID

[const] unsigned int category_id Gets the category ID

[const] bool is_visited? Gets a value indicating whether the item was already visited

add_tag( unsigned int tag_id ) Adds a tag with the given id to the item

remove_tag( unsigned int tag_id ) Remove the tag with the given id from the item

[const] bool has_tag?( unsigned int tag_id ) Returns a value indicating whether the item has a tag with the given ID

[const] string tags_str Returns a string listing all tags of this item

tags_str=( string tags ) Sets the tags from a string

[const] string image_str Gets the image associated with this item as a string

image_str=( string image ) Sets the image from a string

add_value( RdbItemValue value ) Adds a value object to the values of this item

clear_values Removes all values from this item

yield ref RdbItemValue each_value Iterates over all values

destroy Explicitly destroy the object

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

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.

add_value( RdbItemValue value )

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

value: The value to add.

[const] unsigned int category_id

Description: Gets the category ID

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

returns: The category ID

[const] unsigned int cell_id

Description: Gets the cell ID

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

returns: The cell ID

clear_values

Description: Removes all values from this item

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.