MDL SDK API nvidia_logo_transpbg.gif Up
mi::neuraylib::IAnnotation Class Referenceabstract

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

#include <iexpression.h>

Inheritance diagram for mi::neuraylib::IAnnotation:

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_definitionget_definition () const =0
 Returns the definition of this annotation. 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 IInterfaceget_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 IInterfaceget_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< 0xa9c652e7, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0> IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0xa9c652e7, ... >
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 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

 get_arguments()

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.

 get_definition()

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

Returns the definition of this annotation.

 get_name()

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

Returns the name of the annotation.

 set_name()

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

Sets the name of the annotation.