beliefstate::Event Struct Reference

Central Event structure, allowing information flow between components. More...

#include <Types.h>

List of all members.

Public Attributes
bool	bPreempt
bool	bRequest
CDesignator *	cdDesignator
	An optional designator to accompany the event.
std::list< std::pair < std::string, std::string > >	lstDesignatorIDs
std::list< std::pair < std::string, std::string > >	lstEquations
std::list< std::pair < std::string, std::string > >	lstEquationTimes
std::list< Node * >	lstNodes
	Node references accompanying this event.
std::list< Node * >	lstRootNodes
StatusMessage	msgStatusMessage
int	nContextID
int	nOpenRequestID
int	nOriginID
	Internal ID of origin plugin for reference.
int	nSequenceNumber
std::string	strAnnotation
	Optional extra annotation for this event.
std::string	strEventName
	The event's identifier.
std::string	strSupplementary

---

Detailed Description

Central Event structure, allowing information flow between components.

Definition at line 120 of file Types.h.

---

Member Data Documentation

bool beliefstate::Event::bPreempt

Definition at line 142 of file Types.h.

bool beliefstate::Event::bRequest

Definition at line 141 of file Types.h.

CDesignator* beliefstate::Event::cdDesignator

An optional designator to accompany the event.

Designators can hold arbitrary information for an event and helps receiving components to process them.

Definition at line 134 of file Types.h.

std::list< std::pair<std::string, std::string> > beliefstate::Event::lstDesignatorIDs

Definition at line 147 of file Types.h.

std::list< std::pair<std::string, std::string> > beliefstate::Event::lstEquations

Definition at line 148 of file Types.h.

std::list< std::pair<std::string, std::string> > beliefstate::Event::lstEquationTimes

Definition at line 149 of file Types.h.

std::list<Node*> beliefstate::Event::lstNodes

Node references accompanying this event.

Definition at line 145 of file Types.h.

std::list<Node*> beliefstate::Event::lstRootNodes

Definition at line 146 of file Types.h.

StatusMessage beliefstate::Event::msgStatusMessage

Definition at line 143 of file Types.h.

int beliefstate::Event::nContextID

Definition at line 129 of file Types.h.

int beliefstate::Event::nOpenRequestID

Definition at line 140 of file Types.h.

int beliefstate::Event::nOriginID

Internal ID of origin plugin for reference.

Definition at line 139 of file Types.h.

int beliefstate::Event::nSequenceNumber

Definition at line 150 of file Types.h.

std::string beliefstate::Event::strAnnotation

Optional extra annotation for this event.

Definition at line 137 of file Types.h.

std::string beliefstate::Event::strEventName

The event's identifier.

Every event needs to have an identifier, allowing components such as the main system and receiving plugins to distinguish on how to handle the event. Plugins can also subscribe to specific types of events, only receiving the types they actually subscribed to.

Definition at line 128 of file Types.h.

std::string beliefstate::Event::strSupplementary

Definition at line 135 of file Types.h.

---

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

• Types.h