IServerExtensionDesc Class Referenceabstract

Server Extension plugin descriptor. More...

Inheritance diagram for IServerExtensionDesc:
IPluginObjectDesc IObject

Public Member Functions

virtual OpenViBE::boolean getServerExtentionPrototype (OpenViBE::Kernel::IServerExtensionProto &rServerExtensionPrototype) const =0
 Gets the prototype for this extension. More...
 
- Public Member Functions inherited from IPluginObjectDesc
virtual void release (void)=0
 Informs the plugin description it won't be used any more. More...
 
virtual OpenViBE::CIdentifier getCreatedClass (void) const =0
 Gives a tip on what this plugin descriptor is able to create. More...
 
virtual OpenViBE::CIdentifier getCreatedClassIdentifier (void) const
 
virtual
OpenViBE::Plugins::IPluginObject
create (void)=0
 Creates the plugin object itself. More...
 
virtual OpenViBE::CString getName (void) const
 Gets the plugin name. More...
 
virtual OpenViBE::CString getAuthorName (void) const
 Gets the author name for this plugin. More...
 
virtual OpenViBE::CString getAuthorCompanyName (void) const
 Gets the author company name for this plugin. More...
 
virtual OpenViBE::CString getShortDescription (void) const
 Gets a short description of the plugin. More...
 
virtual OpenViBE::CString getDetailedDescription (void) const
 Gets a detailed description of the plugin. More...
 
virtual OpenViBE::CString getCategory (void) const
 Gets a basic category of the plugin. More...
 
virtual OpenViBE::CString getVersion (void) const
 Gets the version of the plugin. More...
 
virtual OpenViBE::boolean hasFunctionality (OpenViBE::Kernel::EPluginFunctionality ePF) const
 Tests whether the plugin has a given functionality. More...
 
virtual OpenViBE::boolean hasLicenceType (OpenViBE::Kernel::ELicenseType eLT) const
 Tests the licence type for this plugin. More...
 
- Public Member Functions inherited from IObject
virtual OpenViBE::CIdentifier getClassIdentifier (void) const =0
 Returns the final class identifier of the concrete class. More...
 
virtual OpenViBE::boolean isDerivedFromClass (const OpenViBE::CIdentifier &rClassIdentifier) const
 Checks if this object is compatible with a class identifier. More...
 
virtual OpenViBE::boolean acceptVisitor (OpenViBE::IObjectVisitor &rObjectVisitor)
 Requests this object to accept a visitor. More...
 

Detailed Description

Server Extension plugin descriptor.

Author
Jozef Legény (Inria)
Date
2013-06-11 This class should be derived by any plugin which is an Acquisition Server extension.

Member Function Documentation

virtual OpenViBE::boolean getServerExtentionPrototype ( OpenViBE::Kernel::IServerExtensionProto rServerExtensionPrototype) const
pure virtual

Gets the prototype for this extension.

Parameters
rServerExtensionPrototype[out] : the prototype to fill
Returns
true in case of success false in other cases

After calling this function the returned prototype should be filled by the descriptor so the Acquisition Server knows the structure of the extension (its parameters).

See Also
OpenViBE::Plugins::IServerExtensionProto