mi::neuraylib::IStruct_category_list Class Reference

An ordered collection of struct categories identified by name or index. More...

#include <itype.h>

Inheritance diagram for mi::neuraylib::IStruct_category_list:

Public Member Functions
virtual Size	get_size () const =0
	Returns the number of elements. More...
virtual Size	get_index (const char *name) const =0
	Returns the index for the given name, or -1 if there is no such struct category. More...
virtual const char *	get_name (Size index) const =0
	Returns the name for the given index, or nullptr if there is no such struct category. More...
virtual const IStruct_category *	get_struct_category (Size index) const =0
	Returns the struct category for index, or nullptr if there is no such struct category. More...
template<class T>
const T *	get_struct_category (Size index) const
	Returns the struct category for index, or nullptr if there is no such struct category. More...
virtual const IStruct_category *	get_struct_category (const char *name) const =0
	Returns the struct category for name, or nullptr if there is no such struct category. More...
template<class T>
const T *	get_struct_category (const char *name) const
	Returns the struct category for name, or nullptr if there is no such struct category. More...
virtual Sint32	set_struct_category (Size index, const IStruct_category *struct_category)=0
	Sets a struct category at a given index. More...
virtual Sint32	set_struct_category (const char *name, const IStruct_category *struct_category)=0
	Sets a struct category identified by name. More...
virtual Sint32	add_struct_category (const char *name, const IStruct_category *struct_category)=0
	Adds a struct category at the end of the list. More...
Public Member Functions inherited from mi::base::IInterface
virtual Uint32	retain () const =0
	Increments the reference count. More...
virtual Uint32	release () const =0
	Decrements the reference count. More...
virtual const IInterface *	get_interface (const Uuid &interface_id) const =0
	Acquires a const interface from another. More...
template<class T>
const T *	get_interface () const
	Acquires a const interface from another. More...
virtual IInterface *	get_interface (const Uuid &interface_id)=0
	Acquires a mutable interface from another. More...
template<class T>
T *	get_interface ()
	Acquires a mutable interface from another. More...
virtual Uuid	get_iid () const =0
	Returns the interface ID of the most derived interface. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x509417fe, ... >
using	Self = Interface_declare< id1, ... >
	Own type. More...
using	IID = Uuid_t< id1, ... >
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::base::IInterface
using	IID = Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>
	Declares the interface ID (IID) of this interface. More...
Static Public Member Functions inherited from mi::base::Interface_declare< 0x509417fe, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
Static Public Member Functions inherited from mi::base::IInterface
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface. More...

Detailed Description

An ordered collection of struct categories identified by name or index.

Struct category lists can be created with mi::neuraylib::IType_factory::create_struct_category_list().

Member Function Documentation

add_struct_category()

virtual Sint32 mi::neuraylib::IStruct_category_list::add_struct_category ( const char *  name, const IStruct_category *  struct_category  )

pure virtual

Adds a struct category at the end of the list.

Returns

• 0: Success.
• -1: Invalid parameters (nullptr).
• -2: There is already a struct category mapped to name in the list.

get_index()

virtual Size mi::neuraylib::IStruct_category_list::get_index ( const char *  name ) const

pure virtual

Returns the index for the given name, or -1 if there is no such struct category.

get_name()

virtual const char * mi::neuraylib::IStruct_category_list::get_name ( Size  index ) const

pure virtual

Returns the name for the given index, or nullptr if there is no such struct category.

get_size()

virtual Size mi::neuraylib::IStruct_category_list::get_size ( ) const

pure virtual

Returns the number of elements.

get_struct_category() [1/4]

template<class T>

const T * mi::neuraylib::IStruct_category_list::get_struct_category ( const char *  name ) const

inline

Returns the struct category for name, or nullptr if there is no such struct category.

get_struct_category() [2/4]

virtual const IStruct_category * mi::neuraylib::IStruct_category_list::get_struct_category ( const char *  name ) const

pure virtual

Returns the struct category for name, or nullptr if there is no such struct category.

get_struct_category() [3/4]

template<class T>

const T * mi::neuraylib::IStruct_category_list::get_struct_category ( Size  index ) const

inline

Returns the struct category for index, or nullptr if there is no such struct category.

get_struct_category() [4/4]

virtual const IStruct_category * mi::neuraylib::IStruct_category_list::get_struct_category ( Size  index ) const

pure virtual

Returns the struct category for index, or nullptr if there is no such struct category.

set_struct_category() [1/2]

virtual Sint32 mi::neuraylib::IStruct_category_list::set_struct_category ( const char *  name, const IStruct_category *  struct_category  )

pure virtual

Sets a struct category identified by name.

Returns

• 0: Success.
• -1: Invalid parameters (nullptr).
• -2: There is no struct category mapped to name in the list.

set_struct_category() [2/2]

virtual Sint32 mi::neuraylib::IStruct_category_list::set_struct_category ( Size  index, const IStruct_category *  struct_category  )

pure virtual

Sets a struct category at a given index.

Returns

• 0: Success.
• -1: Invalid parameters (nullptr).
• -2: index is out of bounds.