DtVrfPlugin Class Reference

The plugin manager will load external loadable objects in order to provide additional functionality to the front-end. More...

List of all members.

Public Member Functions
	DtVrfPlugin (const DtString &libName, bool addPlatExt=true, bool useLazyEval=true)
virtual	~DtVrfPlugin ()
virtual bool	init ()
	Sets member variables.
virtual bool	checkVersion (const DtString &curVersion)
	Returns false if there is a version mismatch.
virtual bool	initializePlugin (DtCgf *)
virtual bool	postInitializePlugin (DtCgf *)
virtual void	unloadPlugin ()
const DtVrfPluginInformation &	pluginInformation () const
virtual void	pluginInformation (std::string &) const
	Outputs all plugin information into string form.
virtual bool	isValid () const
virtual DtString	libraryName () const
virtual const char *	error () const
Protected Attributes
DtVrfPluginInformation	myPluginInformation
DtInitializeVrfPluginFcn	myInitializePlugin
DtPostInitializeVrfPluginFcn	myPostInitializePlugin
DtPluginInformationFcn	myPluginInformationFcn
DtVrfUnloadPluginFcn	myUnloadPlugin
DtDynamicLibrary *	myDynamicLibrary

---

Detailed Description

The plugin manager will load external loadable objects in order to provide additional functionality to the front-end.

The file vrfPluginExtension.h defines the template for what you can and/or need to define in order to be considered a plugin to the front-end.

The plugin manager will, upon calling the init() method, read plugins from the supplied .mtl file. It will also scan the argv command line for the --loadPlugin command to schedule to load a plugin.

---

Constructor & Destructor Documentation

DtVrfPlugin::DtVrfPlugin	(	const DtString &	libName,
		bool	addPlatExt = true,
		bool	useLazyEval = true
	)

virtual DtVrfPlugin::~DtVrfPlugin

(

)

[virtual]

---

Member Function Documentation

virtual bool DtVrfPlugin::init

(

)

[virtual]

Sets member variables.

virtual bool DtVrfPlugin::checkVersion

(

const DtString &

curVersion

)

[virtual]

Returns false if there is a version mismatch.

virtual bool DtVrfPlugin::initializePlugin

(

DtCgf *

)

[virtual]

virtual bool DtVrfPlugin::postInitializePlugin

(

DtCgf *

)

[virtual]

virtual void DtVrfPlugin::unloadPlugin

(

)

[virtual]

const DtVrfPluginInformation & DtVrfPlugin::pluginInformation

(

)

const [inline]

References myPluginInformation.

virtual void DtVrfPlugin::pluginInformation

(

std::string &

)

const [virtual]

Outputs all plugin information into string form.

virtual bool DtVrfPlugin::isValid

(

)

const [virtual]

virtual DtString DtVrfPlugin::libraryName

(

)

const [virtual]

virtual const char* DtVrfPlugin::error

(

)

const [virtual]

---

Member Data Documentation

DtVrfPluginInformation DtVrfPlugin::myPluginInformation [protected]

Referenced by pluginInformation().

DtInitializeVrfPluginFcn DtVrfPlugin::myInitializePlugin [protected]

DtPostInitializeVrfPluginFcn DtVrfPlugin::myPostInitializePlugin [protected]

DtPluginInformationFcn DtVrfPlugin::myPluginInformationFcn [protected]

DtVrfUnloadPluginFcn DtVrfPlugin::myUnloadPlugin [protected]

DtDynamicLibrary* DtVrfPlugin::myDynamicLibrary [protected]

---

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

• include/vrfcgf/vrfPluginManager.h