#include <Plugin.h>

Inheritance diagram for beliefstate::plugins::Plugin:

Public Member Functions
void	addDependency (std::string strPluginName)
void	closeRequestID (int nID)
virtual void	consumeEvent (Event evEvent)
virtual Event	consumeServiceEvent (ServiceEvent seServiceEvent)
virtual Result	cycle ()
Result	cycleResults ()
virtual Result	deinit ()
std::list< std::string >	dependencies ()
bool	dependsOn (std::string strPluginName)
void	deployCycleData (Result &resDeployTo)
void	deployEvent (Event evDeploy, bool bWaitForEvent=false)
ServiceEvent	deployServiceEvent (ServiceEvent seDeploy, bool bWaitForEvent=false)
bool	developmentPlugin ()
void	fail (std::string strMessage, bool bImportant=false)
CDesignator *	getIndividualConfig ()
void	info (std::string strMessage, bool bImportant=false)
virtual Result	init (int argc, char **argv)
bool	isAnyRequestIDOpen ()
bool	isRequestIDOpen (int nID)
bool	offersService (std::string strServiceName)
int	openNewRequestID ()
	Plugin ()
int	pluginID ()
std::string	pluginIdentifierString (bool bBold)
std::string	pluginName ()
std::string	pluginVersion ()
bool	running ()
void	setDevelopmentPlugin (bool bDevelopmentPlugin)
void	setOffersService (std::string strServiceName, bool bOffering)
void	setPluginID (int nID)
void	setPluginName (std::string strName)
void	setPluginVersion (std::string strVersion)
void	setRunning (bool bRunCycle)
void	setSubscribedToEvent (std::string strEventName, bool bSubscribed)
bool	subscribedToEvent (std::string strEventName)
void	success (std::string strMessage, bool bImportant=false)
void	unimplemented (std::string strMessage)
void	waitForEvent (Event evWait)
ServiceEvent	waitForEvent (ServiceEvent seWait)
void	warn (std::string strMessage, bool bImportant=false)
virtual	~Plugin ()
Protected Attributes
std::list< Event >	m_lstEvents
std::list< std::string >	m_lstOfferedServices
std::list< int >	m_lstOpenRequestIDs
std::list< ServiceEvent >	m_lstReceivedServiceEventResponses
std::list< ServiceEvent >	m_lstServiceEvents
std::list< string >	m_lstSubscribedEventNames
std::mutex	m_mtxEventsStore
std::mutex	m_mtxReceivedServiceEventResponses
std::mutex	m_mtxServiceEventsStore
Private Attributes
bool	m_bDevelopmentPlugin
bool	m_bRunCycle
std::list< std::string >	m_lstDependencies
std::mutex	m_mtxRunCycle
int	m_nID
std::string	m_strName
std::string	m_strVersion

Detailed Description

Definition at line 59 of file Plugin.h.

Constructor & Destructor Documentation

beliefstate::plugins::Plugin::Plugin ( )

Definition at line 45 of file Plugin.cpp.

beliefstate::plugins::Plugin::~Plugin ( ) [virtual]

Definition at line 57 of file Plugin.cpp.

Member Function Documentation

void beliefstate::plugins::Plugin::addDependency ( std::string strPluginName )

Definition at line 155 of file Plugin.cpp.

void beliefstate::plugins::Plugin::closeRequestID ( int nID )

Definition at line 278 of file Plugin.cpp.

void beliefstate::plugins::Plugin::consumeEvent ( Event evEvent ) [virtual]

Reimplemented in beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, and beliefstate::plugins::PLUGIN_CLASS.

Definition at line 121 of file Plugin.cpp.

Event beliefstate::plugins::Plugin::consumeServiceEvent ( ServiceEvent seServiceEvent ) [virtual]

Reimplemented in beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, and beliefstate::plugins::PLUGIN_CLASS.

Definition at line 143 of file Plugin.cpp.

Result beliefstate::plugins::Plugin::cycle ( ) [virtual]

Reimplemented in beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, and beliefstate::plugins::PLUGIN_CLASS.

Definition at line 98 of file Plugin.cpp.

Result beliefstate::plugins::Plugin::cycleResults ( )

Result beliefstate::plugins::Plugin::deinit ( ) [virtual]

Reimplemented in beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, and beliefstate::plugins::PLUGIN_CLASS.

Definition at line 93 of file Plugin.cpp.

std::list< std::string > beliefstate::plugins::Plugin::dependencies ( )

Definition at line 170 of file Plugin.cpp.

bool beliefstate::plugins::Plugin::dependsOn ( std::string strPluginName )

Definition at line 160 of file Plugin.cpp.

void beliefstate::plugins::Plugin::deployCycleData ( Result & resDeployTo )

Definition at line 174 of file Plugin.cpp.

void beliefstate::plugins::Plugin::deployEvent	(	Event	evDeploy,
		bool	bWaitForEvent = `false`
	)

Definition at line 194 of file Plugin.cpp.

ServiceEvent beliefstate::plugins::Plugin::deployServiceEvent	(	ServiceEvent	seDeploy,
		bool	bWaitForEvent = `false`
	)

Definition at line 206 of file Plugin.cpp.

bool beliefstate::plugins::Plugin::developmentPlugin ( )

Definition at line 69 of file Plugin.cpp.

void beliefstate::plugins::Plugin::fail	(	std::string	strMessage,
		bool	bImportant = `false`
	)		`[virtual]`

Reimplemented from beliefstate::UtilityBase.

Definition at line 345 of file Plugin.cpp.

CDesignator * beliefstate::plugins::Plugin::getIndividualConfig ( )

Definition at line 61 of file Plugin.cpp.

void beliefstate::plugins::Plugin::info	(	std::string	strMessage,
		bool	bImportant = `false`
	)		`[virtual]`

Reimplemented from beliefstate::UtilityBase.

Definition at line 337 of file Plugin.cpp.

Result beliefstate::plugins::Plugin::init	(	int	argc,
		char **	argv
	)		`[virtual]`

Reimplemented in beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, beliefstate::plugins::PLUGIN_CLASS, and beliefstate::plugins::PLUGIN_CLASS.

Definition at line 88 of file Plugin.cpp.

bool beliefstate::plugins::Plugin::isAnyRequestIDOpen ( )

Definition at line 282 of file Plugin.cpp.

bool beliefstate::plugins::Plugin::isRequestIDOpen ( int nID )

Definition at line 268 of file Plugin.cpp.

bool beliefstate::plugins::Plugin::offersService ( std::string strServiceName )

Definition at line 133 of file Plugin.cpp.

int beliefstate::plugins::Plugin::openNewRequestID ( )

Definition at line 256 of file Plugin.cpp.

int beliefstate::plugins::Plugin::pluginID ( )

Definition at line 84 of file Plugin.cpp.

std::string beliefstate::plugins::Plugin::pluginIdentifierString ( bool bBold )

Definition at line 242 of file Plugin.cpp.

std::string beliefstate::plugins::Plugin::pluginName ( )

Definition at line 230 of file Plugin.cpp.

std::string beliefstate::plugins::Plugin::pluginVersion ( )

Definition at line 238 of file Plugin.cpp.

bool beliefstate::plugins::Plugin::running ( )

Definition at line 292 of file Plugin.cpp.

void beliefstate::plugins::Plugin::setDevelopmentPlugin ( bool bDevelopmentPlugin )

Definition at line 65 of file Plugin.cpp.

void beliefstate::plugins::Plugin::setOffersService	(	std::string	strServiceName,
		bool	bOffering
	)

Definition at line 125 of file Plugin.cpp.

void beliefstate::plugins::Plugin::setPluginID ( int nID )

Definition at line 73 of file Plugin.cpp.

void beliefstate::plugins::Plugin::setPluginName ( std::string strName )

Definition at line 224 of file Plugin.cpp.

void beliefstate::plugins::Plugin::setPluginVersion ( std::string strVersion )

Definition at line 234 of file Plugin.cpp.

void beliefstate::plugins::Plugin::setRunning ( bool bRunCycle )

Definition at line 286 of file Plugin.cpp.

void beliefstate::plugins::Plugin::setSubscribedToEvent	(	std::string	strEventName,
		bool	bSubscribed
	)

Definition at line 103 of file Plugin.cpp.

bool beliefstate::plugins::Plugin::subscribedToEvent ( std::string strEventName )

Definition at line 111 of file Plugin.cpp.

void beliefstate::plugins::Plugin::success	(	std::string	strMessage,
		bool	bImportant = `false`
	)		`[virtual]`

Reimplemented from beliefstate::UtilityBase.

Definition at line 333 of file Plugin.cpp.

void beliefstate::plugins::Plugin::unimplemented ( std::string strMessage )

Definition at line 252 of file Plugin.cpp.

void beliefstate::plugins::Plugin::waitForEvent ( Event evWait )

Definition at line 300 of file Plugin.cpp.

ServiceEvent beliefstate::plugins::Plugin::waitForEvent ( ServiceEvent seWait )

Definition at line 308 of file Plugin.cpp.

void beliefstate::plugins::Plugin::warn	(	std::string	strMessage,
		bool	bImportant = `false`
	)		`[virtual]`

Reimplemented from beliefstate::UtilityBase.

Definition at line 341 of file Plugin.cpp.

Member Data Documentation

bool beliefstate::plugins::Plugin::m_bDevelopmentPlugin [private]

Definition at line 67 of file Plugin.h.

bool beliefstate::plugins::Plugin::m_bRunCycle [private]

Definition at line 65 of file Plugin.h.

std::list<std::string> beliefstate::plugins::Plugin::m_lstDependencies [private]

Definition at line 61 of file Plugin.h.

std::list<Event> beliefstate::plugins::Plugin::m_lstEvents [protected]

Definition at line 70 of file Plugin.h.

std::list<std::string> beliefstate::plugins::Plugin::m_lstOfferedServices [protected]

Definition at line 75 of file Plugin.h.

std::list<int> beliefstate::plugins::Plugin::m_lstOpenRequestIDs [protected]

Definition at line 76 of file Plugin.h.

std::list<ServiceEvent> beliefstate::plugins::Plugin::m_lstReceivedServiceEventResponses [protected]

Definition at line 77 of file Plugin.h.

std::list<ServiceEvent> beliefstate::plugins::Plugin::m_lstServiceEvents [protected]

Definition at line 73 of file Plugin.h.

std::list<string> beliefstate::plugins::Plugin::m_lstSubscribedEventNames [protected]

Definition at line 72 of file Plugin.h.

std::mutex beliefstate::plugins::Plugin::m_mtxEventsStore [protected]

Definition at line 71 of file Plugin.h.

std::mutex beliefstate::plugins::Plugin::m_mtxReceivedServiceEventResponses [protected]

Definition at line 78 of file Plugin.h.

std::mutex beliefstate::plugins::Plugin::m_mtxRunCycle [private]

Definition at line 66 of file Plugin.h.

std::mutex beliefstate::plugins::Plugin::m_mtxServiceEventsStore [protected]

Definition at line 74 of file Plugin.h.

int beliefstate::plugins::Plugin::m_nID [private]

Definition at line 64 of file Plugin.h.

std::string beliefstate::plugins::Plugin::m_strName [private]

Definition at line 62 of file Plugin.h.

std::string beliefstate::plugins::Plugin::m_strVersion [private]

Definition at line 63 of file Plugin.h.

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

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation