This class receives messages from the VR-Forces Simulation Engine (and other DIS/HLA messages) and invokes registered callbacks to process them. More...

Inheritance diagram for makVrf::DtGuiThreadNetworkCallbackManager:

[legend]

Public Types
typedef std::map< int, SimMessageSignal * >	DtVrfMessageCallbackMap
typedef std::map < DtAdminContentMessageType, ObjectMessageCallbackSignal * >	DtAdminContentMessageCallbackMap
typedef std::map < DtSimReportMessageType, ObjectMessageCallbackSignal * >	DtSimReportMessageCallbackMap
typedef std::map < DtSimTaskMessageType, ObjectMessageCallbackSignal * >	DtSimTaskMessageCallbackMap
typedef std::map < DtSetMessageType, ObjectMessageCallbackSignal * >	DtSetMessageCallbackMap
typedef std::map< std::string, NetworkInterfaceCallbackSignal * >	DtNetworkCallbackMap

Public Member Functions
	DtGuiThreadNetworkCallbackManager (makVrv::DtDe &)
virtual	~DtGuiThreadNetworkCallbackManager ()
virtual void	messageReceived (DtNetworkMessageInterface *)
	Called when a message is received. Will invoke all callbacks registered for that message name.

virtual SimMessageSignal &	simMessageSignal (int type)
	Returns a signal for a particular message type that you will use to connect/disconnect with in order to be notified of that message being received.

virtual ObjectMessageCallbackSignal &	objectMessageSignal (const DtAdminContentMessageType &type)
	Returns a signal for a particular object message type that you will use to connect/disconnect with in order to be notified of that object message being received.

virtual ObjectMessageCallbackSignal &	radioMessageSignal (const DtSimReportMessageType &type)
	Returns a signal for a particular radio message type that you will use to connect/disconnect with in order to be notified of that radio message being received.
virtual ObjectMessageCallbackSignal &	radioMessageSignal (const DtSimTaskMessageType &type)
	Returns a signal for a particular radio message type that you will use to connect/disconnect with in order to be notified of that radio message being received.
virtual ObjectMessageCallbackSignal &	radioMessageSignal (const DtSetMessageType &type)
	Returns a signal for a particular radio message type that you will use to connect/disconnect with in order to be notified of that radio message being received.

virtual NetworkInterfaceCallbackSignal &	networkInterfaceMessageSignal (std::string messageName)
	Register/Unregister for a DIS/HLA network message.
Public Member Functions inherited from makVrf::DtQueuedManager
	DtQueuedManager (makVrv::DtDe &)
virtual	~DtQueuedManager ()
virtual void	tick ()
virtual void	setActivated (bool)
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtGuiThreadNetworkCallbackManager &	instance (makVrv::DtDe &de)

Protected Member Functions
virtual void	registerSimMessageCallbackWithDriver (int t)
	Registers callback directly with the driver. Do not call directly.
virtual void	unregisterSimMessageCallbackWithDriver (int t)
	Unregisters callback directly with the driver. Do not call directly.
virtual void	processSimMessageCallback (DtNetworkMessageInterface *)
virtual void	vrfObjectMessageCallback (DtSimMessage *msg)
virtual void	processVrfObjectMessageInterfaceCallback (DtNetworkMessageInterface *msg)
	Called in response to a vrf object message being received, callsdown to processVrfObjectMessageCallback with forFrontEndOnly as false.
virtual void	processVrfObjectMessageCallback (DtVrfObjectMessage *msg, bool forFrontEndOnly=true)
	If forFrontEndOnly is true, only accept messages where the receiver is the front-end.
virtual void	registerForCommentInteraction ()
	Registers for comment interaction callback. Should not call directly.
virtual void	unregisterForCommentInteraction ()
	Unregisters for comment interaction. Should not call directly.
virtual void	registerAdminMessageCallbackFor (const DtAdminContentMessageType &type)
virtual void	unregisterAdminMessageCallbackFor (const DtAdminContentMessageType &type)
virtual void	registerReportMessageCallbackFor (const DtSimReportMessageType &type)
virtual void	unregisterReportMessageCallbackFor (const DtSimReportMessageType &type)
virtual void	registerTaskMessageCallbackFor (const DtSimTaskMessageType &type)
virtual void	unregisterTaskMessageCallbackFor (const DtSimTaskMessageType &type)
virtual void	registerSetMessageCallbackFor (const DtSetMessageType &type)
virtual void	unregisterSetMessageCallbackFor (const DtSetMessageType &type)
Protected Member Functions inherited from makVrf::DtQueuedManager
virtual void	queueSimulationFunction (const boost::function< void()> &function)
	Put a function in the sim function queue, for threadsafe calling.
virtual void	runFunctionQueue (DtVrfBackendManagerCallQueue &queue)
	Execute a function queue.

Additional Inherited Members
Protected Types inherited from makVrf::DtQueuedManager
typedef makVrv::DtLockedBufferedQueue < boost::function< void()> >	DtVrfBackendManagerCallQueue
typedef std::vector < boost::function< void()> >	DtVrfBackendManagerCallList

Detailed Description

This class receives messages from the VR-Forces Simulation Engine (and other DIS/HLA messages) and invokes registered callbacks to process them.

This class is available in the GUI thread, and the callbacks registered here are invoked in the GUI thread. For more information about the VRF GUI threading structure, see the threading section of the Developer's Guide.

Member Typedef Documentation

typedef std::map<int, SimMessageSignal*> makVrf::DtGuiThreadNetworkCallbackManager::DtVrfMessageCallbackMap

typedef std::map<DtAdminContentMessageType, ObjectMessageCallbackSignal*> makVrf::DtGuiThreadNetworkCallbackManager::DtAdminContentMessageCallbackMap

typedef std::map<DtSimReportMessageType, ObjectMessageCallbackSignal*> makVrf::DtGuiThreadNetworkCallbackManager::DtSimReportMessageCallbackMap

typedef std::map<DtSimTaskMessageType, ObjectMessageCallbackSignal*> makVrf::DtGuiThreadNetworkCallbackManager::DtSimTaskMessageCallbackMap

typedef std::map<DtSetMessageType, ObjectMessageCallbackSignal*> makVrf::DtGuiThreadNetworkCallbackManager::DtSetMessageCallbackMap

typedef std::map<std::string, NetworkInterfaceCallbackSignal*> makVrf::DtGuiThreadNetworkCallbackManager::DtNetworkCallbackMap

Constructor & Destructor Documentation

makVrf::DtGuiThreadNetworkCallbackManager::DtGuiThreadNetworkCallbackManager ( makVrv::DtDe & )

virtual makVrf::DtGuiThreadNetworkCallbackManager::~DtGuiThreadNetworkCallbackManager ( )

virtual

Member Function Documentation

static DtGuiThreadNetworkCallbackManager& makVrf::DtGuiThreadNetworkCallbackManager::instance ( makVrv::DtDe & de )

static

Returns: Application wide instance of this class.

virtual SimMessageSignal& makVrf::DtGuiThreadNetworkCallbackManager::simMessageSignal ( int type )

virtual

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

Parameters

type	is an interface content message type from the list in msgTypes.h.

virtual ObjectMessageCallbackSignal& makVrf::DtGuiThreadNetworkCallbackManager::objectMessageSignal ( const DtAdminContentMessageType & type )

virtual

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

Parameters

type	is an DtVrfObjectMessage message type from the list in radioMsgTypes.h.

virtual ObjectMessageCallbackSignal& makVrf::DtGuiThreadNetworkCallbackManager::radioMessageSignal ( const DtSimReportMessageType & type )

virtual

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

Parameters

type	is an DtVrfObjectMessage message type from the list in radioMsgTypes.h.

virtual ObjectMessageCallbackSignal& makVrf::DtGuiThreadNetworkCallbackManager::radioMessageSignal ( const DtSimTaskMessageType & type )

virtual

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

Parameters

type	is an DtVrfObjectMessage message type from the list in radioMsgTypes.h.

virtual ObjectMessageCallbackSignal& makVrf::DtGuiThreadNetworkCallbackManager::radioMessageSignal ( const DtSetMessageType & type )

virtual

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

Parameters

type	is an DtVrfObjectMessage message type from the list in radioMsgTypes.h.

virtual NetworkInterfaceCallbackSignal& makVrf::DtGuiThreadNetworkCallbackManager::networkInterfaceMessageSignal ( std::string messageName )

virtual

Register/Unregister for a DIS/HLA network message.

These methods are called by the above methods to call internal methods and should only be called if there is custom content you want to be notified of receiving

virtual void makVrf::DtGuiThreadNetworkCallbackManager::messageReceived ( DtNetworkMessageInterface * )

virtual

Called when a message is received. Will invoke all callbacks registered for that message name.

virtual void makVrf::DtGuiThreadNetworkCallbackManager::registerSimMessageCallbackWithDriver ( int t )

protectedvirtual

Registers callback directly with the driver. Do not call directly.

virtual void makVrf::DtGuiThreadNetworkCallbackManager::unregisterSimMessageCallbackWithDriver ( int t )

protectedvirtual

Unregisters callback directly with the driver. Do not call directly.

virtual void makVrf::DtGuiThreadNetworkCallbackManager::processSimMessageCallback ( DtNetworkMessageInterface * )

protectedvirtual

virtual void makVrf::DtGuiThreadNetworkCallbackManager::vrfObjectMessageCallback ( DtSimMessage * msg )

protectedvirtual

virtual void makVrf::DtGuiThreadNetworkCallbackManager::processVrfObjectMessageInterfaceCallback ( DtNetworkMessageInterface * msg )

protectedvirtual

Called in response to a vrf object message being received, callsdown to processVrfObjectMessageCallback with forFrontEndOnly as false.

virtual void makVrf::DtGuiThreadNetworkCallbackManager::processVrfObjectMessageCallback	(	DtVrfObjectMessage *	msg,
		bool	forFrontEndOnly = `true`
	)

protectedvirtual

If forFrontEndOnly is true, only accept messages where the receiver is the front-end.

virtual void makVrf::DtGuiThreadNetworkCallbackManager::registerForCommentInteraction ( )

protectedvirtual

Registers for comment interaction callback. Should not call directly.

virtual void makVrf::DtGuiThreadNetworkCallbackManager::unregisterForCommentInteraction ( )

protectedvirtual

Unregisters for comment interaction. Should not call directly.

virtual void makVrf::DtGuiThreadNetworkCallbackManager::registerAdminMessageCallbackFor ( const DtAdminContentMessageType & type )

protectedvirtual

virtual void makVrf::DtGuiThreadNetworkCallbackManager::unregisterAdminMessageCallbackFor ( const DtAdminContentMessageType & type )

protectedvirtual

virtual void makVrf::DtGuiThreadNetworkCallbackManager::registerReportMessageCallbackFor ( const DtSimReportMessageType & type )

protectedvirtual

virtual void makVrf::DtGuiThreadNetworkCallbackManager::unregisterReportMessageCallbackFor ( const DtSimReportMessageType & type )

protectedvirtual

virtual void makVrf::DtGuiThreadNetworkCallbackManager::registerTaskMessageCallbackFor ( const DtSimTaskMessageType & type )

protectedvirtual

virtual void makVrf::DtGuiThreadNetworkCallbackManager::unregisterTaskMessageCallbackFor ( const DtSimTaskMessageType & type )

protectedvirtual

virtual void makVrf::DtGuiThreadNetworkCallbackManager::registerSetMessageCallbackFor ( const DtSetMessageType & type )

protectedvirtual

virtual void makVrf::DtGuiThreadNetworkCallbackManager::unregisterSetMessageCallbackFor ( const DtSetMessageType & type )

protectedvirtual

Member Data Documentation

DtVrfMessageCallbackMap makVrf::DtGuiThreadNetworkCallbackManager::myCallbacks

protected

DtAdminContentMessageCallbackMap makVrf::DtGuiThreadNetworkCallbackManager::myAdminMessageCallbacks

protected

DtSimReportMessageCallbackMap makVrf::DtGuiThreadNetworkCallbackManager::myReportMessageCallbacks

protected

DtSimTaskMessageCallbackMap makVrf::DtGuiThreadNetworkCallbackManager::myTaskMessageCallbacks

protected

DtSetMessageCallbackMap makVrf::DtGuiThreadNetworkCallbackManager::mySetMessageCallbacks

protected

DtNetworkCallbackMap makVrf::DtGuiThreadNetworkCallbackManager::myNetworkCallbackMap

protected

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

include/vrfGuiCore/DtGuiThreadNetworkCallbackManager.h

Protected Attributes
DtVrfMessageCallbackMap	myCallbacks
DtAdminContentMessageCallbackMap	myAdminMessageCallbacks
DtSimReportMessageCallbackMap	myReportMessageCallbacks
DtSimTaskMessageCallbackMap	myTaskMessageCallbacks
DtSetMessageCallbackMap	mySetMessageCallbacks
DtNetworkCallbackMap	myNetworkCallbackMap
Protected Attributes inherited from makVrf::DtQueuedManager
makVrv::DtDe &	myDe
DtVrfBackendManagerCallQueue	myFunctionCallQueue
bool	myActivated

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation