VInitialization Struct Reference

Initialization: Each Plugin should (MacOS: Must) contain a function. More...

#include <ocean/plankton/VInit.hpp>

Public Attributes
string	author
	Author list, human readable form.
string	date
	Age of module.
string	email
	Author list, valid email address(es).
double	InitiatilizationCompletion
	The fraction to which extend the initialization could be performed. Whatever that means in detail...
bool	isInitialized
	Could this module be initialized?
int	ModuleMajorVersion
	Version information for module.
string	URLdoc
	URL where module documentation can be found.
string	URLupdate
	URL where new module may be found.

Detailed Description

Initialization: Each Plugin should (MacOS: Must) contain a function.

VISH_INITIALIZER bool ${VISH_API_VERSION}XXXXXXXX(VInitialization*VInit)
{
        return VInit->IsCompatible();
}

where XXXXXXXX is is the name of the plugin, i.e. the file name of the compiled binary. This module initialization function is be called after loading the module as shared library. It should furthermore set all the elements of the VInit parameter to meaningful values that allow the user to deal conveniently with the module.