[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

VOS::VOSPlugin Class Reference

#include <vosplugin.hh>

Inheritance diagram for VOS::VOSPlugin:

List of all members.

---

Detailed Description

Definition at line 19 of file vosplugin.hh.

Public Member Functions

• virtual std::string getModuleName ()=0

  Get the name for this loadable plugin.
  

• virtual void getModuleVersion (int &major, int &minor)=0

  Get the version of the plugin module.
  

• virtual void getHelp (PluginHelp &ph)=0

  Fills in the supplied plugin help structure.
  

• virtual void initialize ()=0

  Trigger the actual loading, setup and execution of the module.
  

• virtual void setSearchPath (std::vector< std::string > &path)
• virtual std::vector< std::string > getSearchPath ()

Protected Member Functions

• VOSPlugin (VOS::VobjectBase *superobject)

Protected Attributes

• std::vector< std::string > searchPath

Classes

• struct HelpOption
• struct PluginHelp

---

Constructor & Destructor Documentation

VOS::VOSPlugin::VOSPlugin

(

VOS::VobjectBase *

superobject

)

[protected]

---

Member Function Documentation

virtual void VOS::VOSPlugin::getHelp

(

PluginHelp &

ph

)

[pure virtual]

Fills in the supplied plugin help structure.

Implemented in VOS::VOSPluginSharedObject.

virtual std::string VOS::VOSPlugin::getModuleName

(

)

[pure virtual]

Get the name for this loadable plugin.

Implemented in VOS::VOSPluginSharedObject.

virtual void VOS::VOSPlugin::getModuleVersion	(	int &	major,
		int &	minor
	)			[pure virtual]

Get the version of the plugin module.

Implemented in VOS::VOSPluginSharedObject.

virtual std::vector<std::string> VOS::VOSPlugin::getSearchPath

(

)

[virtual]

virtual void VOS::VOSPlugin::initialize

(

)

[pure virtual]

Trigger the actual loading, setup and execution of the module.

Implemented in VOS::VOSPluginSharedObject.

virtual void VOS::VOSPlugin::setSearchPath

(

std::vector< std::string > &

path

)

[virtual]

---

Member Data Documentation

std::vector<std::string> VOS::VOSPlugin::searchPath [protected]

Definition at line 23 of file vosplugin.hh.

---

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

• /home/tetron/hack/vos/libs/vos/vos/vosplugin.hh