DtEventManager Class Reference

Inheritance diagram for DtEventManager:

Public Types
typedef boost::signals2::signal< void(const DtEvent &)>	EventSignal

Public Member Functions
	DtEventManager ()
virtual	~DtEventManager ()
virtual void	tick ()
virtual void	addEvent (const DtEvent &)
	Connect to the individual event signal to only get notified for a particular event. More...
virtual void	setProcessEventsImmediately (bool b)
	Whether or not to put the messages onto a tickable queue (false) or process them immediately (true). More...
bool	processEventsImmediately () const
virtual void	selfReflect (unsigned int i)
	Whether or not to self reflect the given VRF data interaction messages (default is to self reflect all messages) More...
virtual void	doNotSelfReflect (unsigned int i)
virtual bool	selfReflecting () const
	Wether or not an event added will be processed locally. Default is true. More...
EventSignal &	signalForFireEvent ()
	Convenience functions. More...
EventSignal &	signalForDetonationEvent ()
EventSignal &	signalForSimInterfaceContentMessage ()
EventSignal &	signalForDataInteraction ()
EventSignal &	signalForSignalInteraction ()
EventSignal &	signalForCommentInteraction ()
EventSignal &	signalForSensorFieldOfViewControlEvent ()
EventSignal &	signalForStartResumeInteraction ()
EventSignal &	signalForStopFreezeInteraction ()
EventSignal &	signalDiGuyActionEvent ()
EventSignal &	signalForInfluenceInteraction ()
EventSignal &	signalDiGuyEndActionEvent ()
virtual void	addEvent (const DtDetonationInteraction &)
	Convenience functions. More...
virtual void	addEvent (const DtFireInteraction &)
virtual void	addEvent (const DtAcknowledgeInteraction &)
virtual void	addEvent (const DtStopFreezeInteraction &)
virtual void	addEvent (const DtStartResumeInteraction &)
virtual void	addEvent (const DtDataInteraction &)
virtual void	addEvent (const DtSignalInteraction &)
virtual void	addEvent (const DtCommentInteraction &)
virtual void	addEvent (const DtSensorFieldOfViewControlInter &)
virtual void	addevent (const DtSimInterfaceContent &)
virtual void	addEvent (const DtDataInteractionWithTransportType &)
virtual void	addEvent (const DtInfluenceInteraction &)
virtual void	addEvent (const DtEndGestureInter &)
virtual void	addEvent (const DtExecuteGestureInter &)
virtual EventSignal &	signalForEvent (DtEvent::EventType type)
	Returns a signal for a particular event type that you will use to connect/disconnect with in order to be notified of that event being received. More...

Static Public Member Functions
static void	setEventManagerCreatorFcn (DtEventManagerCreatorFcn fcn)
static DtEventManager *	createEventManager ()

Protected Types
typedef std::map < DtEvent::EventType, EventSignal * >	EventCallbackMap

Protected Member Functions
virtual void	postEvent (const DtEvent &)
	Puts the event into the queue. More...
virtual void	processEvent (const DtEvent &)
virtual bool	wantsToProcessEvent (const DtEvent &) const
	Return true to self reflect this VRF message (if it is one) More...

Protected Attributes
tbb::spin_mutex	myMutex
std::vector< DtEvent * >	myEvents
tbb::spin_mutex	myCallbackMutex
EventCallbackMap	myEventCallbackMap
bool	myProcessEventsImmediately
std::set< unsigned int >	myDoNotSelfReflect

Static Protected Attributes
static DtEventManagerCreatorFcn	theEventManagerCreatorFcn

Private Member Functions
	DtEventManager (const DtEventManager &)
	Not implemented. More...
DtEventManager &	operator= (const DtEventManager &)
	Not implemented. More...

Member Typedef Documentation

typedef boost::signals2::signal<void (const DtEvent&)> DtEventManager::EventSignal

typedef std::map<DtEvent::EventType, EventSignal*> DtEventManager::EventCallbackMap

protected

Constructor & Destructor Documentation

DtEventManager::DtEventManager ( const DtEventManager &  )

private

Not implemented.

DtEventManager::DtEventManager

(

)

virtual DtEventManager::~DtEventManager ( )

virtual

Member Function Documentation

DtEventManager& DtEventManager::operator= ( const DtEventManager &  )

private

Not implemented.

virtual void DtEventManager::tick ( )

virtual

Reimplemented in DtClientEventManagerTCP, and DtServerEventManagerTCP.

virtual void DtEventManager::addEvent ( const DtEvent &  )

virtual

Connect to the individual event signal to only get notified for a particular event.

Reimplemented in DtNetworkEventManager.

static void DtEventManager::setEventManagerCreatorFcn ( DtEventManagerCreatorFcn  fcn )

static

Factory method for creating this class. If no factory method defined the default DtEventManager is created

static DtEventManager* DtEventManager::createEventManager ( )

static

virtual void DtEventManager::setProcessEventsImmediately ( bool  b )

virtual

Whether or not to put the messages onto a tickable queue (false) or process them immediately (true).

The process immediately may not be thread safe, so, use the flag appropriately. The default is false

bool DtEventManager::processEventsImmediately ( ) const

inline

virtual void DtEventManager::selfReflect ( unsigned int  i )

virtual

Whether or not to self reflect the given VRF data interaction messages (default is to self reflect all messages)

virtual void DtEventManager::doNotSelfReflect ( unsigned int  i )

virtual

virtual bool DtEventManager::selfReflecting ( ) const

virtual

Wether or not an event added will be processed locally. Default is true.

Reimplemented in DtNetworkEventManager.

virtual EventSignal& DtEventManager::signalForEvent ( DtEvent::EventType  type )

virtual

Returns a signal for a particular event type that you will use to connect/disconnect with in order to be notified of that event being received.

EventSignal& DtEventManager::signalForFireEvent

(

)

Convenience functions.

EventSignal& DtEventManager::signalForDetonationEvent

(

)

EventSignal& DtEventManager::signalForSimInterfaceContentMessage

(

)

EventSignal& DtEventManager::signalForDataInteraction

(

)

EventSignal& DtEventManager::signalForSignalInteraction

(

)

EventSignal& DtEventManager::signalForCommentInteraction

(

)

EventSignal& DtEventManager::signalForSensorFieldOfViewControlEvent

(

)

EventSignal& DtEventManager::signalForStartResumeInteraction

(

)

EventSignal& DtEventManager::signalForStopFreezeInteraction

(

)

EventSignal& DtEventManager::signalDiGuyActionEvent

(

)

EventSignal& DtEventManager::signalForInfluenceInteraction

(

)

EventSignal& DtEventManager::signalDiGuyEndActionEvent

(

)

virtual void DtEventManager::addEvent ( const DtDetonationInteraction &  )

virtual

Convenience functions.

virtual void DtEventManager::addEvent ( const DtFireInteraction &  )

virtual

virtual void DtEventManager::addEvent ( const DtAcknowledgeInteraction &  )

virtual

virtual void DtEventManager::addEvent ( const DtStopFreezeInteraction &  )

virtual

virtual void DtEventManager::addEvent ( const DtStartResumeInteraction &  )

virtual

virtual void DtEventManager::addEvent ( const DtDataInteraction &  )

virtual

virtual void DtEventManager::addEvent ( const DtSignalInteraction &  )

virtual

virtual void DtEventManager::addEvent ( const DtCommentInteraction &  )

virtual

virtual void DtEventManager::addEvent ( const DtSensorFieldOfViewControlInter &  )

virtual

virtual void DtEventManager::addevent ( const DtSimInterfaceContent &  )

virtual

virtual void DtEventManager::addEvent ( const DtDataInteractionWithTransportType &  )

virtual

virtual void DtEventManager::addEvent ( const DtInfluenceInteraction &  )

virtual

virtual void DtEventManager::addEvent ( const DtEndGestureInter &  )

virtual

virtual void DtEventManager::addEvent ( const DtExecuteGestureInter &  )

virtual

virtual void DtEventManager::postEvent ( const DtEvent &  )

protectedvirtual

Puts the event into the queue.

virtual void DtEventManager::processEvent ( const DtEvent &  )

protectedvirtual

virtual bool DtEventManager::wantsToProcessEvent ( const DtEvent &  ) const

protectedvirtual

Return true to self reflect this VRF message (if it is one)

Member Data Documentation

tbb::spin_mutex DtEventManager::myMutex

protected

std::vector<DtEvent*> DtEventManager::myEvents

protected

tbb::spin_mutex DtEventManager::myCallbackMutex

protected

EventCallbackMap DtEventManager::myEventCallbackMap

protected

DtEventManagerCreatorFcn DtEventManager::theEventManagerCreatorFcn

staticprotected

bool DtEventManager::myProcessEventsImmediately

protected

std::set<unsigned int> DtEventManager::myDoNotSelfReflect

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfMsgTransport/eventManager.h