The DtVrfTDLMessageInterface is a transporter for sending TDL messages as data interactions using a VR-Link exercise connection. More...

Inheritance diagram for DtVrfTDLMessageInterface:

[legend]

Public Member Functions
	DtVrfTDLMessageInterface (DtEventManager *eventManager, bool useDefaultInterfaceFactory=true)

virtual	~DtVrfTDLMessageInterface ()
	destructor More...

virtual bool	init ()
	Creates all the other pieces. More...

virtual bool	createAndDeliverMessage (const DtSimulationAddress &recipient, const DtVrfTDLMessage &content, bool overrideTimestampOrder=true)
	If there is a recipient in the message it is supplanted by the recipient in the createAndDeliverMessage call. More...

virtual const DtSimulationAddress &	messageAddress () const
	Get the address that should be used as the sender for all messages originating from the backend. More...

virtual bool	sendMessage (DtVrfTDLMessage &message)
	Send a sim interface message. More...

DtEventManager *	eventManager () const
	Return the event manager. More...

virtual void	clearEventManager ()
	Sets the event manager to NULL. More...

virtual void	setSequence (DtU32 num)
	Get/Set the sequence number. More...

virtual DtU32	sequence () const

virtual void	addVrfTDLMessageCallback (DtVrfTDLMessageCallbackFcn fcn, void *usr)
	Adds/removes callbacks to be notified when a VRF TDL message is received. Does not matter the type – it will be triggered for all messages. More...

virtual void	removeVrfTDLMessageCallback (DtVrfTDLMessageCallbackFcn fcn, void *usr)

virtual void	setEventManager (DtEventManager *)

virtual bool	receiveMessage (DtVrfTDLMessage *content)
	Call this to receive a TDL message internally – this will not go out over the network. More...

virtual DtVrfTDLMessageFactory *	factory () const
	Get/Set the factory used for creating interface content msgs. More...

virtual void	setFactory (DtVrfTDLMessageFactory *fact)

Protected Types
typedef std::vector< std::pair < DtVrfTDLMessageCallbackFcn, void * > >	CallbackData

Protected Member Functions
virtual void	removeConnections ()

virtual void	initializeConnections ()

virtual bool	setContentForNet (DtDataInteraction *dataInter, DtVrfTDLMessage &content) const

virtual void	netMessageCallback (const DtEvent &)

virtual void	receiveMessage (DtDataInteraction *dataInter)
	Process a received data interaction from the network. More...

virtual bool	matchPattern (const DtSimulationAddress &address, const DtSimulationAddress &pattern) const

virtual bool	getContentFromNet (DtDataInteraction dataInter, DtVrfTDLMessage &content) const
	Create/set objects based on DtDataInteraction information. More...

virtual bool	getContentFromNet (unsigned nBufferSize, const char pContentBuffer, DtVrfTDLMessage &content) const

virtual void	invokeCallbacks (DtVrfTDLMessage *)
	Invokes callbacks for a particular VRF TDL message. More...

Protected Attributes
DtU32	mySequenceNumber

bool	myAllowReliableDataInteractions

bool	myUseReliableTransport

DtVrfTDLMessageFactory *	myFactory

bool	myCreatedInterfaceFactory

CallbackData	myCallbacks

DtVrfTDLMessage *	myVrfTDLMessageTranslator

std::set< int >	myContentTypesToSendReliable
	Set of content types to be sent via reliable transport. More...

DtEventManager *	myEventManager

bool	myOwnsEventManager

Private Member Functions
	DtVrfTDLMessageInterface (const DtVrfTDLMessageInterface &orig)

DtVrfTDLMessageInterface &	operator= (const DtVrfTDLMessageInterface &orig)

	DtVrfTDLMessageInterface ()

Detailed Description

The DtVrfTDLMessageInterface is a transporter for sending TDL messages as data interactions using a VR-Link exercise connection.

Member Typedef Documentation

typedef std::vector<std::pair<DtVrfTDLMessageCallbackFcn, void*> > DtVrfTDLMessageInterface::CallbackData

protected

Constructor & Destructor Documentation

DtVrfTDLMessageInterface::DtVrfTDLMessageInterface	(	DtEventManager *	eventManager,
		bool	useDefaultInterfaceFactory = `true`
	)

virtual DtVrfTDLMessageInterface::~DtVrfTDLMessageInterface ( )

virtual

destructor

DtVrfTDLMessageInterface::DtVrfTDLMessageInterface ( const DtVrfTDLMessageInterface & orig )

private

DtVrfTDLMessageInterface::DtVrfTDLMessageInterface ( )

private

Member Function Documentation

virtual bool DtVrfTDLMessageInterface::init ( )

virtual

Creates all the other pieces.

virtual bool DtVrfTDLMessageInterface::createAndDeliverMessage	(	const DtSimulationAddress &	recipient,
		const DtVrfTDLMessage &	content,
		bool	overrideTimestampOrder = `true`
	)

virtual

If there is a recipient in the message it is supplanted by the recipient in the createAndDeliverMessage call.

virtual const DtSimulationAddress& DtVrfTDLMessageInterface::messageAddress ( ) const

virtual

Get the address that should be used as the sender for all messages originating from the backend.

virtual bool DtVrfTDLMessageInterface::sendMessage ( DtVrfTDLMessage & message )

virtual

Send a sim interface message.

DtEventManager * DtVrfTDLMessageInterface::eventManager ( ) const

inline

Return the event manager.

References myEventManager.

void DtVrfTDLMessageInterface::clearEventManager ( )

inlinevirtual

Sets the event manager to NULL.

References myEventManager, and myOwnsEventManager.

virtual void DtVrfTDLMessageInterface::setSequence ( DtU32 num )

virtual

Get/Set the sequence number.

DtU32 DtVrfTDLMessageInterface::sequence ( ) const

inlinevirtual

References mySequenceNumber.

virtual void DtVrfTDLMessageInterface::addVrfTDLMessageCallback	(	DtVrfTDLMessageCallbackFcn	fcn,
		void *	usr
	)

virtual

Adds/removes callbacks to be notified when a VRF TDL message is received. Does not matter the type – it will be triggered for all messages.

virtual void DtVrfTDLMessageInterface::removeVrfTDLMessageCallback	(	DtVrfTDLMessageCallbackFcn	fcn,
		void *	usr
	)

virtual

virtual void DtVrfTDLMessageInterface::setEventManager ( DtEventManager * )

virtual

virtual bool DtVrfTDLMessageInterface::receiveMessage ( DtVrfTDLMessage * content )

virtual

Call this to receive a TDL message internally – this will not go out over the network.

The sender and recipient will be the address of this exercise connection

Reimplemented in DtVrfTDLMsgPrinter.

virtual DtVrfTDLMessageFactory* DtVrfTDLMessageInterface::factory ( ) const

virtual

Get/Set the factory used for creating interface content msgs.

virtual void DtVrfTDLMessageInterface::setFactory ( DtVrfTDLMessageFactory * fact )

virtual

virtual void DtVrfTDLMessageInterface::removeConnections ( )

protectedvirtual

virtual void DtVrfTDLMessageInterface::initializeConnections ( )

protectedvirtual

virtual bool DtVrfTDLMessageInterface::setContentForNet	(	DtDataInteraction *	dataInter,
		DtVrfTDLMessage &	content
	)		const

protectedvirtual

virtual void DtVrfTDLMessageInterface::netMessageCallback ( const DtEvent & )

protectedvirtual

virtual void DtVrfTDLMessageInterface::receiveMessage ( DtDataInteraction * dataInter )

protectedvirtual

Process a received data interaction from the network.

virtual bool DtVrfTDLMessageInterface::matchPattern	(	const DtSimulationAddress &	address,
		const DtSimulationAddress &	pattern
	)		const

protectedvirtual

virtual bool DtVrfTDLMessageInterface::getContentFromNet	(	DtDataInteraction *	dataInter,
		DtVrfTDLMessage *&	content
	)		const

protectedvirtual

Create/set objects based on DtDataInteraction information.

Reimplemented in DtVrfTDLMsgPrinter.

virtual bool DtVrfTDLMessageInterface::getContentFromNet	(	unsigned	nBufferSize,
		const char *	pContentBuffer,
		DtVrfTDLMessage *&	content
	)		const

protectedvirtual

virtual void DtVrfTDLMessageInterface::invokeCallbacks ( DtVrfTDLMessage * )

protectedvirtual

Invokes callbacks for a particular VRF TDL message.

DtVrfTDLMessageInterface& DtVrfTDLMessageInterface::operator= ( const DtVrfTDLMessageInterface & orig )

private

Member Data Documentation

DtU32 DtVrfTDLMessageInterface::mySequenceNumber

protected

Referenced by sequence().

bool DtVrfTDLMessageInterface::myAllowReliableDataInteractions

protected

bool DtVrfTDLMessageInterface::myUseReliableTransport

protected

DtVrfTDLMessageFactory* DtVrfTDLMessageInterface::myFactory

protected

bool DtVrfTDLMessageInterface::myCreatedInterfaceFactory

protected

CallbackData DtVrfTDLMessageInterface::myCallbacks

protected

DtVrfTDLMessage* DtVrfTDLMessageInterface::myVrfTDLMessageTranslator

protected

std::set<int> DtVrfTDLMessageInterface::myContentTypesToSendReliable

protected

Set of content types to be sent via reliable transport.

DtEventManager* DtVrfTDLMessageInterface::myEventManager

protected

Referenced by clearEventManager(), and eventManager().

bool DtVrfTDLMessageInterface::myOwnsEventManager

protected

Referenced by clearEventManager().

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

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation