NVIDIA Iray: Math API nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::base::IPlugin_descriptor Class Referenceabstract

Represents a plugin. More...

+ Inheritance diagram for mi::base::IPlugin_descriptor:

Public Types

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...
 

Public Member Functions

virtual base::Pluginget_plugin () const =0
 Returns the plugin itself. More...
 
virtual const char * get_plugin_library_path () const =0
 Returns the library path of the plugin. More...
 
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...
 

Static Public Member Functions

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

Represents a plugin.

This interface is used to represent loaded plugins as reference-counted interfaces since mi::base::Plugin is not reference-counted. In addition, it provides the path from where the plugin was loaded.

Member Typedef Documentation

typedef Uuid_t<id1,id2,id3,id4,id5,id6,id7,id8,id9,id10,id11> mi::base::Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IInterface >::IID
inherited

Declares the interface ID (IID) of this interface.

typedef Interface_declare<id1,id2,id3,id4,id5,id6,id7,id8,id9,id10,id11,IInterface > mi::base::Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IInterface >::Self
inherited

Own type.

Member Function Documentation

static bool mi::base::Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IInterface >::compare_iid ( const Uuid iid)
inlinestaticinherited

Compares the interface ID iid against the interface ID of this interface and of its ancestors.

Returns
true if iid == IID() or is equal to one of the interface IDs of its ancestors, and false otherwise.
virtual Uuid mi::base::IInterface::get_iid ( ) const
pure virtualinherited

Returns the interface ID of the most derived interface.

Implemented in mi::base::Interface_implement_singleton< IAllocator >.

virtual const IInterface* mi::base::IInterface::get_interface ( const Uuid interface_id) const
pure virtualinherited

Acquires a const interface from another.

If this interface supports the interface with the passed interface_id, then the method returns a non-NULL const mi::base::IInterface* that can be casted via static_cast to an interface pointer of the interface type corresponding to the passed interface_id. Otherwise, the method returns NULL.

In the case of a non-NULL return value, the caller receives ownership of the new interface pointer, whose reference count has been retained once. The caller must release the returned interface pointer at the end to prevent a memory leak.

Parameters
interface_idInterface ID of the interface to acquire.

Implemented in mi::base::Interface_implement_singleton< IAllocator >.

template<class T >
const T* mi::base::IInterface::get_interface ( ) const
inlineinherited

Acquires a const interface from another.

If this interface supports the interface T, then the method returns a non-NULL const pointer to the interface T. Otherwise, the method returns NULL.

In the case of a non-NULL return value, the caller receives ownership of the new interface pointer, whose reference count has been retained once. The caller must release the returned interface pointer at the end to prevent a memory leak.

This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to apply static_cast to the returned pointer, since the return type already is a const pointer to the type T specified as template parameter.

Template Parameters
TThe requested interface type.
virtual IInterface* mi::base::IInterface::get_interface ( const Uuid interface_id)
pure virtualinherited

Acquires a mutable interface from another.

If this interface supports the interface with the passed interface_id, then the methods returns a non-NULL mi::base::IInterface* that can be casted via static_cast to an interface pointer of the interface type corresponding to the passed interface_id. Otherwise, the method returns NULL.

In the case of a non-NULL return value, the caller receives ownership of the new interface pointer, whose reference count has been retained once. The caller must release the returned interface pointer at the end to prevent a memory leak.

Parameters
interface_idInterface ID of the interface to acquire.

Implemented in mi::base::Interface_implement_singleton< IAllocator >.

template<class T >
T* mi::base::IInterface::get_interface ( )
inlineinherited

Acquires a mutable interface from another.

If this interface supports the interface T, then the method returns a non-NULL pointer to the interface T. Otherwise, the method returns NULL.

In the case of a non-NULL return value, the caller receives ownership of the new interface pointer, whose reference count has been retained once. The caller must release the returned interface pointer at the end to prevent a memory leak.

This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to apply static_cast to the returned pointer, since the return type already is a pointer to the type T specified as template parameter.

Template Parameters
TThe requested interface type.
virtual base::Plugin* mi::base::IPlugin_descriptor::get_plugin ( ) const
pure virtual

Returns the plugin itself.

Note
The returned pointer is not referenced-counted. It is only valid as long as the plugin descriptor is valid.
Returns
The plugin.
virtual const char* mi::base::IPlugin_descriptor::get_plugin_library_path ( ) const
pure virtual

Returns the library path of the plugin.

Returns
The library path of the plugin, or NULL in case of failure.
virtual Uint32 mi::base::IInterface::release ( ) const
pure virtualinherited

Decrements the reference count.

Decrements the reference count of the object referenced through this interface and returns the new reference count. If the reference count dropped to zero, the object will be deleted. The operation is thread-safe.

Returns
The new, decremented reference count.

Implemented in mi::base::Interface_implement_singleton< IAllocator >.

virtual Uint32 mi::base::IInterface::retain ( ) const
pure virtualinherited

Increments the reference count.

Increments the reference count of the object referenced through this interface and returns the new reference count. The operation is thread-safe.

Returns
The new, incremented reference count.

Implemented in mi::base::Interface_implement_singleton< IAllocator >.