VInitialization Struct Reference

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

#include </home/werner/origo/vish/ocean/plankton/VInit.hpp>

List of all members.

Public Types

• typedef std::string string

Public Member Functions

• bool acceptable ()
• bool IsCompatible (const char *what=VISH_RELEASE_IDENTIFIER)
• VInitialization (const char *ModuleLoadName)

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?
  

• const char *const ModuleLoadName
• int ModuleMajorVersion

  Version information for module.
  

• int ModuleMinorVersion
• int ModuleReleaseNumber
• const char * ModuleReleaseString
• string URLdoc

  URL where module documentation can be found.
  

• string URLupdate

  URL where new module may be found.
  

Static Public Attributes

• static const char *const VishReleaseString = VISH_RELEASE_IDENTIFIER

---

Detailed Description

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

VISH_INITIALIZER bool VISH_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.

Examples:

abcexample.cpp.

---

The documentation for this struct was generated from the following files:

• ocean/plankton/VInit.hpp
• ocean/plankton/VInit.cpp