Interaction::InteractionBasePlugin Class Reference

Implements the interface between the InteractionBase plug-in and Envision. More...

Inheritance diagram for Interaction::InteractionBasePlugin:

Public Member Functions
virtual bool	initialize (Core::EnvisionManager &) override
	Initializes the plug-in. More...
virtual void	selfTest (QString testid) override
	Starts the indicated self-test for this plug-in. More...
virtual void	unload () override
	Frees up all resources allocated by this plug-in and prepares it to be unloaded. More...
Public Member Functions inherited from Core::EnvisionPlugin
virtual	~EnvisionPlugin ()=default

Static Public Member Functions
static Logger::Log &	log ()

Detailed Description

Implements the interface between the InteractionBase plug-in and Envision.

The Envision core will use this interface to communicate with the plug-in. The plug-in will be initialized before any other operations are performed.

The plug-in can use the supplied EnvisionManager object to find out more about the running environment.

Member Function Documentation

initialize()

bool Interaction::InteractionBasePlugin::initialize ( Core::EnvisionManager &  manager )

overridevirtual

Initializes the plug-in.

This function is called by the core system as soon as the plug-in is loaded. All initializatoin should happen within this function.

Parameters

manager

The EnvisionManager object that can be used to query various aspects of the Envision system.

Returns

True if the initialization was successful, false otherwise.

Implements Core::EnvisionPlugin.

log()

Log & Interaction::InteractionBasePlugin::log ( )

static

selfTest()

void Interaction::InteractionBasePlugin::selfTest ( QString  testid )

overridevirtual

Starts the indicated self-test for this plug-in.

If the Envision system was started with a command line argument that indicates a particular plug-in should be tested, this method will be invoked for that plug-in. Optionally a particular test can be requested.

This method will only be invoked once all plug-ins are loaded.

To request that a plug-in be tested use the –test option when starting envision.

E.G. to run all tests of the File persistence module: Envision –test filepersistence

to only run the 'load' test: Envision –test filepersistence:load

Parameters

testid

The string id of the test to run. If this string is empty all tests should be run.

Implements Core::EnvisionPlugin.

unload()

void Interaction::InteractionBasePlugin::unload ( )

overridevirtual

Frees up all resources allocated by this plug-in and prepares it to be unloaded.

This function is called when Envision is about to exit or when a plug-in has manually been unloaded. At the time when this function is called there will be no plug-ins dependent on this one.

Implements Core::EnvisionPlugin.