mi::IEnum_decl Class Reference
[Types]
Description
An enum declaration is used to describe enum types. An enum type is represented by a map from names (of type const char*) to values (of type mi::Sint32). Such a pair of name and value is also called enumerator. Note that different enumerators can have the same value (but need to have different names).
Enum declarations can be used to create new enum types. In this case, they are populated through a sequence of add_enumerator() calls. Finally, such a declaration is registered via mi::neuraylib::IExtension_api::register_enum_decl(). The name used for registration can later be used as a type name to create instances of the type described by the declaration.
See also:
Public Member Functions
- virtual Sint32 add_enumerator( const char* name, Sint32 value) =0
- Adds a new enumerator to the enum declaration. More...
- virtual const char* get_enum_type_name() const =0
- Returns the type name used to register this enum declaration. More...
- virtual Size get_index( const char* name) const =0
- Returns the index for an enumerator identified by its name. More...
- virtual Size get_index( Sint32 value) const =0
- Returns the index for an enumerator identified by its value. More...
- virtual Size get_length() const =0
- Returns the number of enumerators.
- virtual const char* get_name( Size index) const =0
- Returns the name of an enumerator. More...
- virtual Sint32 get_value( Size index) const =0
- Returns the value of an enumerator. More...
- virtual Sint32 remove_enumerator( const char* name) =0
- Removes an enumerator from the enum declaration. More...
Member Functions
- virtual Sint32 mi::IEnum_decl::add_enumerator( const char* name, Sint32 value) [pure virtual]
-
Adds a new enumerator to the enum declaration.
Parameters
- name
- The name of the new enumerator.
- value
- The value of the new enumerator.
Returns
- 0: Success.
- -1: Invalid parameters (NULL pointer).
- -2: There is already an enumerator with name name.
- virtual const char* mi::IEnum_decl::get_enum_type_name() const [pure virtual]
-
Returns the type name used to register this enum declaration. Note that the type name will only be available after registration, i.e., if the declaration has been obtained from mi::IEnum::get_enum_decl() or mi::neuraylib::IFactory::get_enum_decl().
The type name might start with '{' which indicates that it has been automatically generated. In this case the type name should be treated as an opaque string since its format might change unexpectedly. It is perfectly fine to pass it to other methods, e.g., mi::neuraylib::IFactory::create(), but you should not attempt to interpret the value in any way. Use the methods on this interface to obtain information about the type itself.
Returns
The type name under which this enum declaration was registered, or NULL in case of failure.
- virtual Size mi::IEnum_decl::get_index( const char* name) const [pure virtual]
-
Returns the index for an enumerator identified by its name.
Parameters
- name
- The name of the requested enumerator.
Returns
The index of the enumerator with name name , or -1 if name is invalid.
- virtual Size mi::IEnum_decl::get_index( Sint32 value) const [pure virtual]
-
Returns the index for an enumerator identified by its value.
Parameters
- value
- The value of the requested enumerator.
Returns
The smallest index of an enumerator with value value , or -1 if value is invalid.
- virtual Size mi::IEnum_decl::get_length() const [pure virtual]
-
Returns the number of enumerators.
- virtual const char* mi::IEnum_decl::get_name( Size index) const [pure virtual]
-
Returns the name of an enumerator.
Parameters
- index
- The index of the requested enumerator.
Returns
The name of that enumerator, or NULL if index is out of bounds.
- virtual Sint32 mi::IEnum_decl::get_value( Size index) const [pure virtual]
-
Returns the value of an enumerator.
Parameters
- index
- The index of the requested enumerator (invalid indices are treated as index 0).
Returns
The value of that enumerator.
- virtual Sint32 mi::IEnum_decl::remove_enumerator( const char* name) [pure virtual]
-
Removes an enumerator from the enum declaration.
Parameters
- name
- The name of the enumerator to remove.
Returns
- 0: Success.
- -1: Invalid parameters (NULL pointer).
- -2: There is no enumerator with name name.