mi::neuraylib::IFunctor_base Class Reference

Base class for functors. More...

#include <ifunctor.h>

Inheritance diagram for mi::neuraylib::IFunctor_base:

Public Member Functions
virtual IDictionary *	get_default_options () const =0
	Returns the default options for this functor. More...
virtual bool	options_valid (const IDictionary *options)=0
	Checks whether the options are valid for the functor. More...
virtual const IDictionary *	get_options_type () const =0
	Returns the types of all options. More...
virtual const IDictionary *	get_options_description () const =0
	Returns the descriptions of all options. More...
virtual const char *	error_text () const =0
	Returns a descriptive string for the last error. 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< 0xee412b14, ... >
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< 0xee412b14, ... >
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

Base class for functors.

This base class provides common support for options handling and similar things. Functors are interfaces whose purpose is a single computation, like a conventional function call.

Member Function Documentation

error_text()

virtual const char * mi::neuraylib::IFunctor_base::error_text ( ) const

pure virtual

Returns a descriptive string for the last error.

The returned pointer is valid until the next function call or until this interface is released, whichever happens first.

Returns

A description of the error from the last function call, or nullptr if the last function call was successful.

get_default_options()

virtual IDictionary * mi::neuraylib::IFunctor_base::get_default_options ( ) const

pure virtual

Returns the default options for this functor.

Returns

A dictionary that contains all permissible options keys and their default values for this functor.

get_options_description()

virtual const IDictionary * mi::neuraylib::IFunctor_base::get_options_description ( ) const

pure virtual

Returns the descriptions of all options.

Returns

A dictionary that maps the key names of the default options to a corresponding description describing the meaning of the value.

get_options_type()

virtual const IDictionary * mi::neuraylib::IFunctor_base::get_options_type ( ) const

pure virtual

Returns the types of all options.

Returns

A dictionary that maps the key names of the default options to the corresponding types.

options_valid()

virtual bool mi::neuraylib::IFunctor_base::options_valid ( const IDictionary *  options )

pure virtual

Checks whether the options are valid for the functor.

Returns

true if and only if the options are valid, i.e., all keys and their values are permissible for the functor.