An annotation definition. More...

#include <iexpression.h>

Inheritance diagram for mi::neuraylib::IAnnotation_definition:

Public Types
enum	Semantics { AS_UNKNOWN = 0 , AS_INTRINSIC_ANNOTATION = 0x0100 , AS_ANNOTATION_FIRST = AS_INTRINSIC_ANNOTATION , AS_THROWS_ANNOTATION , AS_SINCE_ANNOTATION , AS_REMOVED_ANNOTATION , AS_CONST_EXPR_ANNOTATION , AS_DERIVABLE_ANNOTATION , AS_NATIVE_ANNOTATION , AS_UNUSED_ANNOTATION , AS_NOINLINE_ANNOTATION , AS_SOFT_RANGE_ANNOTATION , AS_HARD_RANGE_ANNOTATION , AS_HIDDEN_ANNOTATION , AS_DEPRECATED_ANNOTATION , AS_VERSION_NUMBER_ANNOTATION , AS_VERSION_ANNOTATION , AS_DEPENDENCY_ANNOTATION , AS_UI_ORDER_ANNOTATION , AS_USAGE_ANNOTATION , AS_ENABLE_IF_ANNOTATION , AS_THUMBNAIL_ANNOTATION , AS_DISPLAY_NAME_ANNOTATION , AS_IN_GROUP_ANNOTATION , AS_DESCRIPTION_ANNOTATION , AS_AUTHOR_ANNOTATION , AS_CONTRIBUTOR_ANNOTATION , AS_COPYRIGHT_NOTICE_ANNOTATION , AS_CREATED_ANNOTATION , AS_MODIFIED_ANNOTATION , AS_KEYWORDS_ANNOTATION , AS_ORIGIN_ANNOTATION , AS_NODE_OUTPUT_PORT_DEFAULT_ANNOTATION , AS_ANNOTATION_LAST = AS_NODE_OUTPUT_PORT_DEFAULT_ANNOTATION , AS_FORCE_32_BIT = 0xffffffffU }
	All known semantics of annotation definitions. More...

Public Types inherited from mi::base::Interface_declare< 0xa453318b, ... >
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...

Public Member Functions
virtual const char *	get_module () const =0
	Returns the DB name of the module containing this annotation definition. More...

virtual const char *	get_name () const =0
	Returns the MDL name of the annotation definition. More...

virtual const char *	get_mdl_module_name () const =0
	Returns the MDL name of the module containing this annotation definition. More...

virtual const char *	get_mdl_simple_name () const =0
	Returns the simple MDL name of the annotation definition. More...

virtual const char *	get_mdl_parameter_type_name (Size index) const =0
	Returns the type name of the parameter at `index`. More...

virtual Semantics	get_semantic () const =0
	Returns the semantic of this annotation definition. More...

virtual bool	is_exported () const =0
	Indicates whether the annotation definition is exported by its module. More...

virtual void	get_mdl_version (Mdl_version &since, Mdl_version &removed) const =0
	Returns the MDL version when this annotation definition was added and removed. More...

virtual Size	get_parameter_count () const =0
	Returns the parameter count of the annotation definition. More...

virtual const char *	get_parameter_name (Size index) const =0
	Returns the parameter name of the given index. More...

virtual Size	get_parameter_index (const char *name) const =0
	Returns the parameter index of the given name. More...

virtual const IType_list *	get_parameter_types () const =0
	Returns the parameter types of the annotation definition. More...

virtual const IExpression_list *	get_defaults () const =0
	Returns the parameter defaults of the annotation definition. More...

virtual const IAnnotation_block *	get_annotations () const =0
	Returns the annotations of this definition or `NULL` if no annotations exist. More...

virtual const IAnnotation *	create_annotation (const IExpression_list *arguments) const =0
	Creates an 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 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
Static Public Member Functions inherited from mi::base::Interface_declare< 0xa453318b, ... >
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 definition.

Member Enumeration Documentation

^◆ Semantics

enum mi::neuraylib::IAnnotation_definition::Semantics

All known semantics of annotation definitions.

Note: Do not rely on the numeric values of the enumerators since they may change without further notice.

Enumerator
AS_UNKNOWN	Unknown semantics.
AS_INTRINSIC_ANNOTATION	This is the internal intrinsic() annotation.
AS_THROWS_ANNOTATION	This is the internal throws() annotation.
AS_SINCE_ANNOTATION	This is the internal since() annotation.
AS_REMOVED_ANNOTATION	This is the internal removed() annotation.
AS_CONST_EXPR_ANNOTATION	This is the internal const_expr() annotation.
AS_DERIVABLE_ANNOTATION	This is the internal derivable() annotation.
AS_NATIVE_ANNOTATION	This is the internal native() annotation.
AS_UNUSED_ANNOTATION	This is the unused() annotation.
AS_NOINLINE_ANNOTATION	This is the noinline() annotation.
AS_SOFT_RANGE_ANNOTATION	This is the soft_range() annotation.
AS_HARD_RANGE_ANNOTATION	This is the hard_range() annotation.
AS_HIDDEN_ANNOTATION	This is the hidden() annotation.
AS_DEPRECATED_ANNOTATION	This is the deprecated() annotation.
AS_VERSION_NUMBER_ANNOTATION	This is the (old) version_number() annotation.
AS_VERSION_ANNOTATION	This is the version() annotation.
AS_DEPENDENCY_ANNOTATION	This is the dependency() annotation.
AS_UI_ORDER_ANNOTATION	This is the ui_order() annotation.
AS_USAGE_ANNOTATION	This is the usage() annotation.
AS_ENABLE_IF_ANNOTATION	This is the enable_if() annotation.
AS_THUMBNAIL_ANNOTATION	This is the thumbnail() annotation.
AS_DISPLAY_NAME_ANNOTATION	This is the display_name() annotation.
AS_IN_GROUP_ANNOTATION	This is the in_group() annotation.
AS_DESCRIPTION_ANNOTATION	This is the description() annotation.
AS_AUTHOR_ANNOTATION	This is the author() annotation.
AS_CONTRIBUTOR_ANNOTATION	This is the contributor() annotation.
AS_COPYRIGHT_NOTICE_ANNOTATION	This is the copyright_notice() annotation.
AS_CREATED_ANNOTATION	This is the created() annotation.
AS_MODIFIED_ANNOTATION	This is the modified() annotation.
AS_KEYWORDS_ANNOTATION	This is the key_words() annotation.
AS_ORIGIN_ANNOTATION	This is the origin() annotation.
AS_NODE_OUTPUT_PORT_DEFAULT_ANNOTATION	This is the node_output_port_default() annotation.

Member Function Documentation

^◆ create_annotation()

virtual const IAnnotation * mi::neuraylib::IAnnotation_definition::create_annotation ( const IExpression_list * arguments ) const

pure virtual

Creates an annotation.

Parameters

arguments The arguments for new annotation.

Returns: The created annotation or NULL if one of the arguments does not correspond to an actual parameter of the annotation or is not a constant expression.

^◆ get_annotations()

virtual const IAnnotation_block * mi::neuraylib::IAnnotation_definition::get_annotations ( ) const

pure virtual

Returns the annotations of this definition or NULL if no annotations exist.

^◆ get_defaults()

virtual const IExpression_list * mi::neuraylib::IAnnotation_definition::get_defaults ( ) const

pure virtual

Returns the parameter defaults of the annotation definition.

^◆ get_mdl_module_name()

virtual const char * mi::neuraylib::IAnnotation_definition::get_mdl_module_name ( ) const

pure virtual

Returns the MDL name of the module containing this annotation definition.

^◆ get_mdl_parameter_type_name()

virtual const char * mi::neuraylib::IAnnotation_definition::get_mdl_parameter_type_name ( Size index ) const

pure virtual

Returns the type name of the parameter at index.

Note: The type names provided here are substrings of the MDL name returned by get_name(). They are provided here such that parsing of the MDL name is not necessary. However, for most use cases it is strongly recommended to use get_parameter_types() instead.

Parameters

index The index of the parameter.

Returns: The type name of the parameter, or NULL if index is out of range.

^◆ get_mdl_simple_name()

virtual const char * mi::neuraylib::IAnnotation_definition::get_mdl_simple_name ( ) const

pure virtual

Returns the simple MDL name of the annotation definition.

The simple name is the last component of the MDL name, i.e., without any packages and scope qualifiers, and without the parameter type names.

Returns: The simple MDL name of the annotation definition.

^◆ get_mdl_version()

virtual void mi::neuraylib::IAnnotation_definition::get_mdl_version	(	Mdl_version &	since,
		Mdl_version &	removed
	)		const

pure virtual

Returns the MDL version when this annotation definition was added and removed.

Parameters

[out]	since	The MDL version in which this annotation definition was added. If the annotation definition does not belong to the standard library, the MDL version of the corresponding module is returned.
[out]	removed	The MDL version in which this annotation definition was removed, or mi::neuraylib::MDL_VERSION_INVALID if the annotation has not been removed so far or does not belong to the standard library.

^◆ get_module()

virtual const char * mi::neuraylib::IAnnotation_definition::get_module ( ) const

pure virtual

Returns the DB name of the module containing this annotation definition.

The type of the module is mi::neuraylib::IModule.

^◆ get_name()

virtual const char * mi::neuraylib::IAnnotation_definition::get_name ( ) const

pure virtual

Returns the MDL name of the annotation definition.

^◆ get_parameter_count()

virtual Size mi::neuraylib::IAnnotation_definition::get_parameter_count ( ) const

pure virtual

Returns the parameter count of the annotation definition.

^◆ get_parameter_index()

virtual Size mi::neuraylib::IAnnotation_definition::get_parameter_index ( const char * name ) const

pure virtual

Returns the parameter index of the given name.

Parameters

name	The parameter name.

Returns: The index of the parameter or -1 if there is no parameter of that name.

^◆ get_parameter_name()

virtual const char * mi::neuraylib::IAnnotation_definition::get_parameter_name ( Size index ) const

pure virtual

Returns the parameter name of the given index.

Parameters

index The parameter index.

Returns: The name of the parameter or NULL if index is out of range.

^◆ get_parameter_types()

virtual const IType_list * mi::neuraylib::IAnnotation_definition::get_parameter_types ( ) const

pure virtual

Returns the parameter types of the annotation definition.

^◆ get_semantic()

virtual Semantics mi::neuraylib::IAnnotation_definition::get_semantic ( ) const

pure virtual

Returns the semantic of this annotation definition.

^◆ is_exported()

virtual bool mi::neuraylib::IAnnotation_definition::is_exported ( ) const

pure virtual

Indicates whether the annotation definition is exported by its module.

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Semantics

Member Function Documentation

◆ create_annotation()

◆ get_annotations()

◆ get_defaults()

◆ get_mdl_module_name()

◆ get_mdl_parameter_type_name()

◆ get_mdl_simple_name()

◆ get_mdl_version()

◆ get_module()

◆ get_name()

◆ get_parameter_count()

◆ get_parameter_index()

◆ get_parameter_name()

◆ get_parameter_types()

◆ get_semantic()

◆ is_exported()

^◆ Semantics

^◆ create_annotation()

^◆ get_annotations()

^◆ get_defaults()

^◆ get_mdl_module_name()

^◆ get_mdl_parameter_type_name()

^◆ get_mdl_simple_name()

^◆ get_mdl_version()

^◆ get_module()

^◆ get_name()

^◆ get_parameter_count()

^◆ get_parameter_index()

^◆ get_parameter_name()

^◆ get_parameter_types()

^◆ get_semantic()

^◆ is_exported()