eVaf::Plugins::iPlugin Class Reference

Common interface for all the eVaf modules. More...

#include <Plugins/iplugin.h>

Public Member Functions
virtual void	done ()=0
	Finalizes the module. More...
virtual bool	init (const QString &args)=0
	Initializes the module that implements the iPlugin interface. More...
	iPlugin ()
	Empty constructor. More...
virtual bool	isReady () const =0
	Ready flag. More...
virtual	~iPlugin ()
	Empty virtual destructor. More...

Detailed Description

Common interface for all the eVaf modules.

#include <Plugins/iPlugin>

The iPlugin interface is the common interface implemented by all the eVaf modules.

Definition at line 38 of file iplugin.h.

Constructor & Destructor Documentation

eVaf::Plugins::iPlugin::iPlugin ( )

inline

Empty constructor.

Definition at line 45 of file iplugin.h.

virtual eVaf::Plugins::iPlugin::~iPlugin ( )

inlinevirtual

Empty virtual destructor.

Definition at line 48 of file iplugin.h.

Member Function Documentation

virtual void eVaf::Plugins::iPlugin::done ( )

pure virtual

Finalizes the module.

The plugin manager calls the done() function for every eVaf module during the finalization of the application. Modules implementing the iPlugin interface shall finalize and release all the resources in the done() function.

Implemented in eVaf::ScosTime::Module.

virtual bool eVaf::Plugins::iPlugin::init ( const QString &  args )

pure virtual

Initializes the module that implements the iPlugin interface.

Parameters

args	Arguments for the initialization

Returns

True if ok; false if initialization failed

The plugin manager calls the init() function for every eVaf module during the initialization of the application. Modules implementing the iPlugin interface shall allocate and initialize all the required resources in the init() function.

Modules can assume that the init() function is always called once after loading the module and creating the interface object. Every init() function call is followed by a done() function call during the finalization of the application. Modules can be initialized multiple times without destroying the interface object, but init() function calls are always followed by a done() function call.

When the init() function returns true, then the initialization of the module shall be completed and all the interfaces and other resources published by the module safe to use.

Implemented in eVaf::ScosTime::Module.

virtual bool eVaf::Plugins::iPlugin::isReady ( ) const

pure virtual

Ready flag.

Returns

True if the module is ready.

The ready flag indicates that the module is initialized and all the published interfaces and resources safe to use.

Implemented in eVaf::ScosTime::Module.

---

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

• libs/Plugins/iplugin.h