neuray API Programmer's Manual

mi::neuraylib::Tag Class Reference

[Mi_neuray_dice]

Description

A tag represents a unique identifier for database elements in the database.

See also:

the underlying POD type mi::neuraylib::Tag_struct.

Public Typedefs

typedef bool(Tag::*  bool_conversion_support
Helper typedef. More...

Public Constructors

 Tag()
Constructor. More...
 Tag( Tag_struct tag_struct)
Constructor from the underlying storage type.

Public Member Functions

bool  is_valid() const
Returns true if the tag is valid, i.e., is not equal to NULL_TAG.
 operator bool_conversion_support() const
Helper function for the conversion of a Tag to a bool. More...

Typedefs

typedef bool(Tag::* mi::​neuraylib::​Tag::bool_conversion_support

Helper typedef. This typedef represents the type of is_valid() used by the bool_conversion_support() operator.

Constructors

mi::​neuraylib::​Tag::Tag() [inline]

Constructor. Sets the ID initially to 0, i.e., creates an invalid tag.

mi::​neuraylib::​Tag::Tag( Tag_struct tag_struct) [inline]

Constructor from the underlying storage type.

Member Functions

bool mi::​neuraylib::​Tag::is_valid() const [inline]

Returns true if the tag is valid, i.e., is not equal to NULL_TAG.

mi::​neuraylib::​Tag::operator bool_conversion_support() const [inline]

Helper function for the conversion of a Tag to a bool. This helper function allows to write

Tag t (...);
     if (t) ...
instead of
Tag t (...);
     if (t.is_valid()) ...