adtf::ucom::ant::IPlugin Class Reference

#include <plugin_intf.h>

Inherits adtf::ucom::ant::IObject.

Public Types
enum class	tPluginState : uint32_t { Deinitialized = 0 , Initialized = 1 }
	lists the several types of plugin states
enum class	tPluginBuildType : uint32_t { Release = 0 , Debug = 1 }
	lists the several types of plugin states

Public Member Functions
	ADTF_IID (IPlugin, "plugin.ant.ucom.adtf.iid")
virtual const char *	GetLabel () const =0
virtual iterator_adapter< const tNamedVersion, pointer_iterator >	GetVersions () const =0
virtual uint32_t	GetBuildType () const =0
virtual tResult	SetState (tPluginState eState)=0
virtual tPluginState	GetState () const =0
virtual tResult	GetClassFactory (iobject_ptr< const IClassFactory > &pClassFactory) const =0
virtual void	SetHandle (tHandle hModule)=0
virtual tHandle	GetHandle () const =0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
	~IPlugin ()=default
	Protected destructor --> Only the final implementation can be destroyed!
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

Plugin interface.

Member Function Documentation

ADTF_IID()

adtf::ucom::ant::IPlugin::ADTF_IID	(	IPlugin	,
		"plugin.ant.ucom.adtf.iid"	)

Marks the IPlugin to be castable with the ucom_cast<>

See also

ADTF_IID(_interface, _striid)

GetBuildType()

virtual uint32_t adtf::ucom::ant::IPlugin::GetBuildType ( ) const

pure virtual

Returns the versions of the plugin.

Returns

list of versions to iteratate.

GetClassFactory()

virtual tResult adtf::ucom::ant::IPlugin::GetClassFactory ( iobject_ptr< const IClassFactory > & pClassFactory ) const

pure virtual

Retrieve the class factory of the plugin.

Parameters

pClassFactory

Class factory reference

Returns

Returns a standard result code.

GetHandle()

virtual tHandle adtf::ucom::ant::IPlugin::GetHandle ( ) const

pure virtual

Get native handle. The GetHandle method returns the native handle of a plugin, if the operating system provides such information.

Returns

Returns the native handle of the plugin or nullptr if the operating system does not provide such information.

See also

SetHandle

GetLabel()

virtual const char * adtf::ucom::ant::IPlugin::GetLabel ( ) const

pure virtual

Returns a label for the plugin

Returns

The label as null terminated string.

GetState()

virtual tPluginState adtf::ucom::ant::IPlugin::GetState ( ) const

pure virtual

Get plugin state. The GetState method returns the plugin state.

Returns

Returns the state of a plugin.

GetVersions()

virtual iterator_adapter< const tNamedVersion, pointer_iterator > adtf::ucom::ant::IPlugin::GetVersions ( ) const

pure virtual

Returns the versions of the plugin.

Returns

list of versions to iteratate.

SetHandle()

virtual void adtf::ucom::ant::IPlugin::SetHandle ( tHandle hModule )

pure virtual

Sets the native handle (during loading of the plugin)

Parameters

[in]

hModule

handle of system dependend plugin handle

SetState()

virtual tResult adtf::ucom::ant::IPlugin::SetState ( tPluginState eState )

pure virtual

Changes the state of the plugin.

Parameters

[in]

eState

The new state

Returns

Returns a standard result code.

---

The documentation for this class was generated from the following file:

• src/libraries/ucom3/include/adtfucom3/interfaces/plugin_intf.h