beliefstate Namespace Reference

Main beliefstate system class. More...

Namespaces
namespace	plugins
Classes
class	ArbitraryMappingsHolder
class	Beliefstate
class	BeliefstateROS
class	CExporter
class	CExporterDot
class	CExporterFileoutput
class	CExporterOwl
class	CImageCapturer
struct	ConfigSettings
	Configuration settings container. More...
class	DecisionTree
struct	Event
	Central Event structure, allowing information flow between components. More...
struct	InteractiveMenuEntry
class	InteractiveObject
struct	InteractiveObjectCallbackResult
class	JSON
class	Node
	Class describing a single node entity. More...
class	PluginInstance
class	PluginSystem
class	Property
struct	Result
	Central Result container for requests of all types. More...
struct	ServiceEvent
	Central ServiceEvent structure, allowing asynchronous services between components. More...
struct	StatusMessage
	Structure describing a status message to be printed to the screen. More...
class	UtilityBase
Enumerations
enum	ResultIdentifier {   RI_NONE, RI_PLUGIN_LOADING_FAILED, RI_CONFIG_FILE_NOT_FOUND, RI_FILE_NOT_FOUND,   RI_PLUGIN_DEPENDENCY_NOT_MET, RI_PLUGIN_DEVELOPMENT_NOT_LOADING }
	Enumeration of fixed result types. More...
enum	ServiceIdentifier { SI_REQUEST, SI_RESPONSE }
	Enumeration of possible ServiceEvent types. More...
enum	ServiceModifier { SM_FIRST_RESULT, SM_AGGREGATE_RESULTS, SM_IGNORE_RESULTS }
	Enumeration of possible ServiceEvent modificator flags. More...
Functions
string	colorSpecifierForID (int nID, bool bBold=false)
ConfigSettings	configSettings ()
bool	contextIDTaken (int nID)
int	createContextID ()
plugins::PLUGIN_CLASS *	createInstance ()
int	createPluginID ()
Event	defaultEvent (std::string strEventName="")
Event	defaultEvent (string strEventName)
Result	defaultResult ()
ServiceEvent	defaultServiceEvent (std::string strServiceName="")
ServiceEvent	defaultServiceEvent (string strServiceName)
void	deleteDirectory (string strPath, bool bEvenIfNonEmpty=true)
void	destroyInstance (plugins::PLUGIN_CLASS *icDestroy)
Event	eventInResponseTo (Event evRequest, std::string strEventName="")
ServiceEvent	eventInResponseTo (ServiceEvent seRequest, std::string strServiceName="")
void	freeContextID (int nID)
void	freePluginID (int nID)
CDesignator *	getPluginConfig (string strPluginName)
void	issueGlobalToken (std::string strToken)
int	nextSequenceNumber ()
string	normalColorSpecifier ()
bool	pluginIDTaken (int nID)
list< StatusMessage >	queuedMessages ()
void	queueMessage (StatusMessage msgQueue)
StatusMessage	queueMessage (string strColorCode, bool bBold, string strPrefix, string strMessage)
void	resetSequenceNumbers ()
void	revokeGlobalToken (std::string strToken)
int	rmfile (const char *path, const struct stat *sb, int flag, struct FTW *ftwbuf)
void	setConfigSettings (ConfigSettings cfgsetSettings)
bool	waitForGlobalToken (std::string strToken, float fTimeout=2.0)
bool	wasGlobalTokenIssued (std::string strToken)
Variables
static ConfigSettings	g_cfgsetSettings
static std::list< int >	g_lstContextIDs
static std::list< int >	g_lstPluginIDs
static std::list< StatusMessage >	g_lstStatusMessages
static std::map< std::string, int >	g_mapIssuedGlobalTokens
static std::map< std::string, CDesignator * >	g_mapPluginSettings
static std::mutex	g_mtxGlobalSettings
static std::mutex	g_mtxGlobalTokensLock
static std::mutex	g_mtxStatusMessages
static int	g_nHighestSequenceNumber = 0
static std::mutex	m_mtxSequenceNumberLock

---

Detailed Description

Main beliefstate system class.

Author:

Jan Winkler

Jan Winkler

This class manages the distribution of messages and service events, triggers the loading of plugins, and loads configuration files.

---

Enumeration Type Documentation

enum beliefstate::ResultIdentifier

Enumeration of fixed result types.

The fixed result types are mostly used internally, for plugin loading.

Enumerator:

RI_NONE	No specific fixed result identifier. This is the default value for most cases.
RI_PLUGIN_LOADING_FAILED	Loading a plugin failed.
RI_CONFIG_FILE_NOT_FOUND	A configuration file was not found.
RI_FILE_NOT_FOUND	A file to load was not found.
RI_PLUGIN_DEPENDENCY_NOT_MET	Dependencies for loading a plugin were not met.
RI_PLUGIN_DEVELOPMENT_NOT_LOADING	A plugin is not loading because it is a development plugin. Plugins can be specifically declared as development plugins. When the central system is configured to not load development plugins, these are not loaded, and don't signal a failure. Is the system is configured to load development plugins, this plugin setting is ignored. A message will be displayed in both cases, informing the user about the development plugin and how it is handled.

Definition at line 80 of file Types.h.

enum beliefstate::ServiceIdentifier

Enumeration of possible ServiceEvent types.

Enumerator:

SI_REQUEST	This is a service request.
SI_RESPONSE	This is a service response.

Definition at line 59 of file Types.h.

enum beliefstate::ServiceModifier

Enumeration of possible ServiceEvent modificator flags.

Enumerator:

SM_FIRST_RESULT	Only return the first response for this service request.
SM_AGGREGATE_RESULTS	Return all responses for this service request.
SM_IGNORE_RESULTS	Don't collect results for this service request.

Definition at line 67 of file Types.h.

---

Function Documentation

string beliefstate::colorSpecifierForID	(	int	nID,
		bool	bBold = false
	)

Definition at line 233 of file GlobalFunctions.cpp.

ConfigSettings beliefstate::configSettings

(

)

Definition at line 245 of file GlobalFunctions.cpp.

bool beliefstate::contextIDTaken

(

int

nID

)

Definition at line 115 of file GlobalFunctions.cpp.

int beliefstate::createContextID

(

)

Definition at line 103 of file GlobalFunctions.cpp.

plugins::PLUGIN_CLASS * beliefstate::createInstance

(

)

Definition at line 282 of file PluginConsole.cpp.

int beliefstate::createPluginID

(

)

Definition at line 131 of file GlobalFunctions.cpp.

Event beliefstate::defaultEvent

(

std::string

strEventName = ""

)

Event beliefstate::defaultEvent

(

string

strEventName

)

Definition at line 196 of file GlobalFunctions.cpp.

Result beliefstate::defaultResult

(

)

Definition at line 159 of file GlobalFunctions.cpp.

ServiceEvent beliefstate::defaultServiceEvent

(

std::string

strServiceName = ""

)

ServiceEvent beliefstate::defaultServiceEvent

(

string

strServiceName

)

Definition at line 169 of file GlobalFunctions.cpp.

void beliefstate::deleteDirectory	(	string	strPath,
		bool	bEvenIfNonEmpty = true
	)

Definition at line 95 of file GlobalFunctions.cpp.

void beliefstate::destroyInstance

(

plugins::PLUGIN_CLASS *

icDestroy

)

Definition at line 286 of file PluginConsole.cpp.

Event beliefstate::eventInResponseTo	(	Event	evRequest,
		std::string	strEventName = ""
	)

Definition at line 209 of file GlobalFunctions.cpp.

ServiceEvent beliefstate::eventInResponseTo	(	ServiceEvent	seRequest,
		std::string	strServiceName = ""
	)

Definition at line 221 of file GlobalFunctions.cpp.

void beliefstate::freeContextID

(

int

nID

)

Definition at line 127 of file GlobalFunctions.cpp.

void beliefstate::freePluginID

(

int

nID

)

Definition at line 155 of file GlobalFunctions.cpp.

CDesignator * beliefstate::getPluginConfig

(

string

strPluginName

)

Definition at line 259 of file GlobalFunctions.cpp.

void beliefstate::issueGlobalToken

(

std::string

strToken

)

Definition at line 85 of file GlobalFunctions.cpp.

int beliefstate::nextSequenceNumber

(

)

Definition at line 181 of file GlobalFunctions.cpp.

string beliefstate::normalColorSpecifier

(

)

Definition at line 241 of file GlobalFunctions.cpp.

bool beliefstate::pluginIDTaken

(

int

nID

)

Definition at line 143 of file GlobalFunctions.cpp.

list< StatusMessage > beliefstate::queuedMessages

(

)

Definition at line 291 of file GlobalFunctions.cpp.

void beliefstate::queueMessage

(

StatusMessage

msgQueue

)

Definition at line 273 of file GlobalFunctions.cpp.

StatusMessage beliefstate::queueMessage	(	string	strColorCode,
		bool	bBold,
		string	strPrefix,
		string	strMessage
	)

Definition at line 279 of file GlobalFunctions.cpp.

void beliefstate::resetSequenceNumbers

(

)

Definition at line 190 of file GlobalFunctions.cpp.

void beliefstate::revokeGlobalToken

(

std::string

strToken

)

Definition at line 57 of file GlobalFunctions.cpp.

int beliefstate::rmfile	(	const char *	path,
		const struct stat *	sb,
		int	flag,
		struct FTW *	ftwbuf
	)

Definition at line 91 of file GlobalFunctions.cpp.

void beliefstate::setConfigSettings

(

ConfigSettings

cfgsetSettings

)

Definition at line 253 of file GlobalFunctions.cpp.

bool beliefstate::waitForGlobalToken	(	std::string	strToken,
		float	fTimeout = 2.0
	)

Definition at line 73 of file GlobalFunctions.cpp.

bool beliefstate::wasGlobalTokenIssued

(

std::string

strToken

)

Definition at line 63 of file GlobalFunctions.cpp.

---

Variable Documentation

ConfigSettings beliefstate::g_cfgsetSettings [static]

Definition at line 46 of file GlobalFunctions.cpp.

std::list<int> beliefstate::g_lstContextIDs [static]

Definition at line 44 of file GlobalFunctions.cpp.

std::list<int> beliefstate::g_lstPluginIDs [static]

Definition at line 45 of file GlobalFunctions.cpp.

std::list<StatusMessage> beliefstate::g_lstStatusMessages [static]

Definition at line 50 of file GlobalFunctions.cpp.

std::map<std::string, int> beliefstate::g_mapIssuedGlobalTokens [static]

Definition at line 53 of file GlobalFunctions.cpp.

std::map<std::string, CDesignator*> beliefstate::g_mapPluginSettings [static]

Definition at line 48 of file GlobalFunctions.cpp.

std::mutex beliefstate::g_mtxGlobalSettings [static]

Definition at line 47 of file GlobalFunctions.cpp.

std::mutex beliefstate::g_mtxGlobalTokensLock [static]

Definition at line 54 of file GlobalFunctions.cpp.

std::mutex beliefstate::g_mtxStatusMessages [static]

Definition at line 49 of file GlobalFunctions.cpp.

int beliefstate::g_nHighestSequenceNumber = 0 [static]

Definition at line 51 of file GlobalFunctions.cpp.

std::mutex beliefstate::m_mtxSequenceNumberLock [static]

Definition at line 52 of file GlobalFunctions.cpp.