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

An annotation is similar to a direct call expression, but without return type. More...

Inheritance diagram for mi::neuraylib::IAnnotation:
mi::base::Interface_declare< 0xa9c652e7, 0x952e, 0x4887, 0x93, 0xb4, 0x55, 0xc8, 0x66, 0xd0, 0x1a, 0x1f > mi::base::IInterface

Public Member Functions

virtual const char * get_name () const =0
 Returns the name of the annotation. More...
 
virtual void set_name (const char *name)=0
 Sets the name of the annotation. More...
 
virtual const IExpression_listget_arguments () const =0
 Returns the arguments of the annotation. More...
 
virtual const
IAnnotation_definition
get_definition () const =0
 Returns the definition of this annotation. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0xa9c652e7, 0x952e, 0x4887, 0x93, 0xb4, 0x55, 0xc8, 0x66, 0xd0, 0x1a, 0x1f >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
IInterface
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< 0xa9c652e7, 0x952e, 0x4887, 0x93, 0xb4, 0x55, 0xc8, 0x66, 0xd0, 0x1a, 0x1f >
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

An annotation is similar to a direct call expression, but without return type.

Its definition can be obtained by calling mi::neuraylib::IAnnotation::get_definition().

Annotations can be created with mi::neuraylib::IExpression_factory::create_annotation() or mi::neuraylib::IAnnotation_definition::create_annotation().

Member Function Documentation

virtual const IExpression_list* mi::neuraylib::IAnnotation::get_arguments ( ) const
pure virtual

Returns the arguments of the annotation.

The arguments of annotations are always constant expressions.

virtual const IAnnotation_definition* mi::neuraylib::IAnnotation::get_definition ( ) const
pure virtual

Returns the definition of this annotation.

virtual const char* mi::neuraylib::IAnnotation::get_name ( ) const
pure virtual

Returns the name of the annotation.

virtual void mi::neuraylib::IAnnotation::set_name ( const char *  name)
pure virtual

Sets the name of the annotation.