Material Definition Language API nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::neuraylib::IValue_struct Class Referenceabstract

A value of type struct. More...

Inheritance diagram for mi::neuraylib::IValue_struct:
mi::base::Interface_declare< 0xcbe089ce, 0x4aea, 0x474d, 0x94, 0x5f, 0x52, 0x13, 0xef, 0x01, 0xce, 0x81, neuraylib::IValue_compound > mi::neuraylib::IValue_compound mi::base::Interface_declare< 0xdabc8fe3, 0x5c70, 0x4ef0, 0xa2, 0xf7, 0x34, 0x30, 0xb5, 0x67, 0xdc, 0x75, neuraylib::IValue > mi::neuraylib::IValue mi::base::Interface_declare< 0xbf837f4a, 0x9034, 0x4f32, 0xaf, 0x5c, 0x75, 0xb3, 0x67, 0x64, 0x53, 0x23 > mi::base::IInterface

Public Member Functions

virtual const IType_structget_type () const =0
 Returns the type of this value. More...
 
virtual const IValueget_field (const char *name) const =0
 Returns a field by name in linear time. More...
 
template<class T >
const T * get_field (const char *name) const
 Returns a field by name in linear time. More...
 
virtual IValueget_field (const char *name)=0
 Returns a field by name in linear time. More...
 
template<class T >
T * get_field (const char *name)
 Returns a field by name in linear time. More...
 
virtual Sint32 set_field (const char *name, IValue *value)=0
 Sets a field by name in linear time. More...
 

Static Public Attributes

static const Kind s_kind = VK_STRUCT
 The kind of this subclass. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0xcbe089ce, 0x4aea, 0x474d, 0x94, 0x5f, 0x52, 0x13, 0xef, 0x01, 0xce, 0x81, neuraylib::IValue_compound >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
neuraylib::IValue_compound
Self
 Own type. More...
 
typedef Uuid_t< id1, id2, id3,
id4, id5, id6, id7, id8, id9,
id10, id11 > 
IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0xcbe089ce, 0x4aea, 0x474d, 0x94, 0x5f, 0x52, 0x13, 0xef, 0x01, 0xce, 0x81, neuraylib::IValue_compound >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 

Detailed Description

A value of type struct.

Member Function Documentation

virtual const IValue* mi::neuraylib::IValue_struct::get_field ( const char *  name) const
pure virtual

Returns a field by name in linear time.

Parameters
nameThe name of the field.
Returns
The value of the field, or NULL if there is no such field.
template<class T >
const T* mi::neuraylib::IValue_struct::get_field ( const char *  name) const
inline

Returns a field by name in linear time.

Parameters
nameThe name of the field.
Returns
The value of the field, or NULL if there is no such field.
virtual IValue* mi::neuraylib::IValue_struct::get_field ( const char *  name)
pure virtual

Returns a field by name in linear time.

Parameters
nameThe name of the field.
Returns
The value of the field, or NULL if there is no such field.
template<class T >
T* mi::neuraylib::IValue_struct::get_field ( const char *  name)
inline

Returns a field by name in linear time.

Parameters
nameThe name of the field.
Returns
The value of the field, or NULL if there is no such field.
virtual const IType_struct* mi::neuraylib::IValue_struct::get_type ( ) const
pure virtual

Returns the type of this value.

Implements mi::neuraylib::IValue_compound.

virtual Sint32 mi::neuraylib::IValue_struct::set_field ( const char *  name,
IValue value 
)
pure virtual

Sets a field by name in linear time.

Parameters
nameThe name of the field.
valueThe new value of the field.
Returns
  • 0: Success.
  • -1: Invalid parameter (NULL pointer).
  • -2: There is no such field of the given name.
  • -3: Incorrect type of value.

Member Data Documentation

const Kind mi::neuraylib::IValue_struct::s_kind = VK_STRUCT
static

The kind of this subclass.