makVrf::DtNetworkMessageCallbackManager Class Reference

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::DtNetworkMessageCallbackManager:

List of all members.

Public Types
typedef std::map< int, SimMessageSignal * >	DtVrfMessageCallbackMap
typedef std::map< int, ObjectMessageCallbackSignal * >	DtVrfObjectMessageCallbackMap
typedef std::map< std::string, NetworkInterfaceCallbackSignal * >	DtNetworkCallbackMap
Public Member Functions
	DtNetworkMessageCallbackManager (makVrv::DtDe &)
virtual	~DtNetworkMessageCallbackManager ()
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 (int 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 (int 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.
Static Public Member Functions
static DtNetworkMessageCallbackManager &	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	registerRadioMessageCallbackFor (int type)
virtual void	unregisterRadioMessageCallbackFor (int type)
virtual void	registerObjectMessageCallbackFor (int type)
virtual void	unregisterObjectMessageCallbackFor (int type)
Protected Attributes
DtVrfMessageCallbackMap	myCallbacks
DtVrfObjectMessageCallbackMap	myVrfObjectMessageCallbacks
DtNetworkCallbackMap	myNetworkCallbackMap

---

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::DtNetworkMessageCallbackManager::DtVrfMessageCallbackMap

typedef std::map<int, ObjectMessageCallbackSignal*> makVrf::DtNetworkMessageCallbackManager::DtVrfObjectMessageCallbackMap

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

---

Constructor & Destructor Documentation

makVrf::DtNetworkMessageCallbackManager::DtNetworkMessageCallbackManager

(

makVrv::DtDe &

)

virtual makVrf::DtNetworkMessageCallbackManager::~DtNetworkMessageCallbackManager

(

)

[virtual]

---

Member Function Documentation

static DtNetworkMessageCallbackManager& makVrf::DtNetworkMessageCallbackManager::instance

(

makVrv::DtDe &

de

)

[static]

Returns:

Application wide instance of this class.

virtual SimMessageSignal& makVrf::DtNetworkMessageCallbackManager::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::DtNetworkMessageCallbackManager::objectMessageSignal

(

int

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::DtNetworkMessageCallbackManager::radioMessageSignal

(

int

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::DtNetworkMessageCallbackManager::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::DtNetworkMessageCallbackManager::messageReceived

(

DtNetworkMessageInterface *

)

[virtual]

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

virtual void makVrf::DtNetworkMessageCallbackManager::registerSimMessageCallbackWithDriver

(

int

t

)

[protected, virtual]

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

virtual void makVrf::DtNetworkMessageCallbackManager::unregisterSimMessageCallbackWithDriver

(

int

t

)

[protected, virtual]

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

virtual void makVrf::DtNetworkMessageCallbackManager::processSimMessageCallback

(

DtNetworkMessageInterface *

)

[protected, virtual]

virtual void makVrf::DtNetworkMessageCallbackManager::vrfObjectMessageCallback

(

DtSimMessage *

msg

)

[protected, virtual]

virtual void makVrf::DtNetworkMessageCallbackManager::processVrfObjectMessageInterfaceCallback

(

DtNetworkMessageInterface *

msg

)

[protected, virtual]

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

virtual void makVrf::DtNetworkMessageCallbackManager::processVrfObjectMessageCallback	(	DtVrfObjectMessage *	msg,
		bool	forFrontEndOnly = true
	)		[protected, virtual]

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

virtual void makVrf::DtNetworkMessageCallbackManager::registerForCommentInteraction

(

)

[protected, virtual]

Registers for comment interaction callback. Should not call directly.

virtual void makVrf::DtNetworkMessageCallbackManager::unregisterForCommentInteraction

(

)

[protected, virtual]

Unregisters for comment interaction. Should not call directly.

virtual void makVrf::DtNetworkMessageCallbackManager::registerRadioMessageCallbackFor

(

int

type

)

[protected, virtual]

virtual void makVrf::DtNetworkMessageCallbackManager::unregisterRadioMessageCallbackFor

(

int

type

)

[protected, virtual]

virtual void makVrf::DtNetworkMessageCallbackManager::registerObjectMessageCallbackFor

(

int

type

)

[protected, virtual]

virtual void makVrf::DtNetworkMessageCallbackManager::unregisterObjectMessageCallbackFor

(

int

type

)

[protected, virtual]

---

Member Data Documentation

DtVrfMessageCallbackMap makVrf::DtNetworkMessageCallbackManager::myCallbacks [protected]

DtVrfObjectMessageCallbackMap makVrf::DtNetworkMessageCallbackManager::myVrfObjectMessageCallbacks [protected]

DtNetworkCallbackMap makVrf::DtNetworkMessageCallbackManager::myNetworkCallbackMap [protected]

---

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

• include/vrfGuiCore/DtNetworkMessageCallbackManager.h