A class that translates between the Portal SetData Interaction and the DIS Set Data PDU. More...

Inheritance diagram for ModSetDataInteractionTranslator:

Public Member Functions
	Dt_DEF_TRANSLATOR_NAME ("SetData")

	ModSetDataInteractionTranslator (MAKVrExchange::DtBroker *broker)
	Registers the function callback receiveDisInteraction() with VR-Link; and receivePortalInteraction() with the Portal. More...

virtual	~ModSetDataInteractionTranslator ()
	Removes the function callbacks receiveDisInteraction() and receivePortalInteraction() from VR-Link and the Portal respectively. More...

virtual void	initializeDisCallbacks ()

virtual void	initializePortalCallbacks ()

virtual void	removeDisCallbacks ()

virtual void	removePortalCallbacks ()

virtual MAKVrExchange::DtPortalSetDataInteraction *	translate (MAKVrExchange::DtPortalSetDataInteraction *destination, const DtSetDataInteraction &source)
	Translates a DIS VR-Link Set Data interaction into a VR-Exchange Portal Set Data interaction. More...

virtual DtSetDataInteraction *	translate (DtSetDataInteraction *destination, const MAKVrExchange::DtPortalSetDataInteraction &source)
	Translates a VR-Exchange Portal Set Data interaction into a DIS VR-Link Set Data interaction. More...

Public Member Functions inherited from MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction, DtSetDataInteraction >
	DtDisInteractionTranslator (DtBroker *broker, const DtString &name, DtPortalMessageKind kind)
	CTOR. More...

virtual	~DtDisInteractionTranslator ()
	Virtual DTOR. More...

virtual void	enableReflectTranslator (bool enabled)
	Enables or disables the translator reflecting from DIS. More...

virtual DtDisBroker *	disBroker ()

virtual const DtDisBroker *	disBroker () const

virtual void	tick ()
	Checks the waitlist for postponed interaction discoveries. More...

Public Member Functions inherited from MAKVrExchange::DtBaseInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction >
	DtBaseInteractionTranslator (DtBroker *broker, const DtString &name, DtPortalMessageKind kind)
	CTOR. More...

virtual	~DtBaseInteractionTranslator ()
	Virtual DTOR. More...

virtual void	enablePublishTranslator (bool enabled)
	Enables or disables the translator from the protocol side. More...

Public Member Functions inherited from MAKVrExchange::DtInteractionTranslator
	DtInteractionTranslator (DtBroker *broker, const DtString &name, DtPortalMessageKind kind)
	CTOR. More...

virtual	~DtInteractionTranslator ()
	Virtual DTOR. More...

virtual unsigned int	numInteractions () const
	Returns the number of interactions received. More...

virtual void	setNumInteractions (unsigned int num)
	Sets the interaction count - mainly used for zeroing it. More...

Public Member Functions inherited from MAKVrExchange::DtTranslator
	DtTranslator (DtBroker *broker, const DtString &name, DtPortalMessageKind kind)
	CTOR. More...

virtual	~DtTranslator ()
	Virtual DTOR. More...

virtual DtString	name () const
	Accessor for the translator's name. More...

virtual bool	isReflectEnabled () const

virtual bool	isPublishEnabled () const

DtBroker *	broker () const
	Broker Accessor. More...

Protected Member Functions
virtual void	createInteraction (const MAKVrExchange::DtPortalSetDataInteraction &incoming)
	Sends a DIS interaction. More...

virtual void	createPortalInteraction (const DtSetDataInteraction &incoming)
	Sends a Portal interaction. More...

Protected Member Functions inherited from MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction, DtSetDataInteraction >
virtual void	receivePortalInteraction (const MAKVrExchange::DtPortalSetDataInteraction &inter)
	Portal interaction processing callback. More...

virtual void	printIncomingOutgoingInteractions (const DtPortalInteraction &incoming, const DtInteraction &outgoing) const
	Prints incoming and outgoing interactions (before and after translation) to DtInfo. More...

virtual void	printIncomingOutgoingInteractions (const DtInteraction &incoming, const DtPortalInteraction &outgoing) const
	Prints incoming and outgoing interactions (before and after translation) to DtInfo. More...

virtual bool	testGlobalIdMapping (const DtString &idName, const DtString &id)
	Checks whether a valid global id mapping exists for the given ID. More...

virtual void	shutdown ()
	Performs any virtual shutdown logic prior to deletion. More...

virtual void	receiveDisInteraction (const DtSetDataInteraction &inter)

Protected Member Functions inherited from MAKVrExchange::DtBaseInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction >
virtual bool	isPortalDiscoverable (const MAKVrExchange::DtPortalSetDataInteraction &inter)
	Checks whether the interaction is discoverable and returns the verdict. More...

Static Protected Member Functions
static void	receiveDisInteraction (DtSetDataInteraction interaction, void userData)
	The callback function registered by the constructor and used by VR-Link. More...

static void	receivePortalInteraction (const MAKVrExchange::DtPortalSetDataInteraction &interaction, void *userData)
	The callback function registered by the constructor and used by the Portal. More...

Static Protected Member Functions inherited from MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction, DtSetDataInteraction >
static void	receiveDisInteraction (DtSetDataInteraction inter, void usr)

Static Protected Member Functions inherited from MAKVrExchange::DtBaseInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction >
static void	receivePortalInteraction (const MAKVrExchange::DtPortalSetDataInteraction &inter, void *usr)
	This callback is called when a portal interaction is received. More...

Private Member Functions
	ModSetDataInteractionTranslator (const ModSetDataInteractionTranslator &)
	private copy constructor prevents pass-by-value, More...

ModSetDataInteractionTranslator &	operator= (const ModSetDataInteractionTranslator &)
	private assignment operator prevents assignment. More...

int	operator== (const ModSetDataInteractionTranslator &)
	private compare operators prevents comparisons. More...

int	operator!= (const ModSetDataInteractionTranslator &)
	private compare operators prevents comparisons. More...

Additional Inherited Members
Public Types inherited from MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction, DtSetDataInteraction >
typedef DtDisInteractionTranslator < MAKVrExchange::DtPortalSetDataInteraction, DtSetDataInteraction >	ParentClass
	Typedef for the templated class type. More...

Public Types inherited from MAKVrExchange::DtBaseInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction >
typedef DtBaseInteractionTranslator < MAKVrExchange::DtPortalSetDataInteraction, DtInteractionTranslator >	ParentClass

Protected Types inherited from MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction, DtSetDataInteraction >
typedef std::vector < MAKVrExchange::DtPortalSetDataInteraction >	InteractionWaitList

Protected Attributes inherited from MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction, DtSetDataInteraction >
InteractionWaitList	myInteractionWaitList

Protected Attributes inherited from MAKVrExchange::DtInteractionTranslator
unsigned int	myNumInteractions

Protected Attributes inherited from MAKVrExchange::DtTranslator
DtString	myTranslatorName

DtPortalMessageKind	myPortalMessageKind

DtBroker *	myBroker

bool	myReflectEnabled

bool	myPublishEnabled

Detailed Description

A class that translates between the Portal SetData Interaction and the DIS Set Data PDU.

Because this is written to VR-Link's protocol independent API much of this example will apply to DIS, HLA and TENA.

This example is almost exactly the same as the code found in the DIS Broker. However, any bug fixes we find with the "real" translator may not be fixed here, so users should beware.

Constructor & Destructor Documentation

ModSetDataInteractionTranslator::ModSetDataInteractionTranslator ( MAKVrExchange::DtBroker * broker )

Registers the function callback receiveDisInteraction() with VR-Link; and receivePortalInteraction() with the Portal.

virtual ModSetDataInteractionTranslator::~ModSetDataInteractionTranslator ( )

virtual

Removes the function callbacks receiveDisInteraction() and receivePortalInteraction() from VR-Link and the Portal respectively.

ModSetDataInteractionTranslator::ModSetDataInteractionTranslator ( const ModSetDataInteractionTranslator & )

private

private copy constructor prevents pass-by-value,

Member Function Documentation

virtual void ModSetDataInteractionTranslator::createInteraction ( const MAKVrExchange::DtPortalSetDataInteraction & incoming )

protectedvirtual

Sends a DIS interaction.

Takes incoming as a Portal Interaction, translates it to a DIS Interaction, then sends this DIS Interaction through myBroker.

Parameters

[in] incoming Received Portal Interaction

Precondition: incoming is a valid DtPortalSetDataInteraction object.

Reimplemented from MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction, DtSetDataInteraction >.

virtual void ModSetDataInteractionTranslator::createPortalInteraction ( const DtSetDataInteraction & incoming )

protectedvirtual

Sends a Portal interaction.

Takes incoming as a DIS Interaction, translates it to a Portal Interaction, then sends this Portal Interaction though myBroker.

Parameters

[in] incoming Received DIS VR-Link Interaction.

Precondition: incoming is a valid object.

Reimplemented from MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction, DtSetDataInteraction >.

ModSetDataInteractionTranslator::Dt_DEF_TRANSLATOR_NAME ( "SetData" )

virtual void ModSetDataInteractionTranslator::initializeDisCallbacks ( )

virtual

Reimplemented from MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction, DtSetDataInteraction >.

virtual void ModSetDataInteractionTranslator::initializePortalCallbacks ( )

virtual

Reimplemented from MAKVrExchange::DtBaseInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction >.

int ModSetDataInteractionTranslator::operator!= ( const ModSetDataInteractionTranslator & )

private

private compare operators prevents comparisons.

ModSetDataInteractionTranslator& ModSetDataInteractionTranslator::operator= ( const ModSetDataInteractionTranslator & )

private

private assignment operator prevents assignment.

int ModSetDataInteractionTranslator::operator== ( const ModSetDataInteractionTranslator & )

private

private compare operators prevents comparisons.

static void ModSetDataInteractionTranslator::receiveDisInteraction	(	DtSetDataInteraction *	interaction,
		void *	userData
	)

staticprotected

The callback function registered by the constructor and used by VR-Link.

This function is called when a DIS VR-Link Data interaction occurs. Calls createPortalInteraction() to send the DIS interaction to the Portal.

Parameters

[in]	interaction	DIS Interaction to be sent.
[in]	userData	ModSetDataInteractionTranslator object.

Precondition: interaction is a valid object. userData must either be a valid ModSetDataInteractionTranslator object, or NULL.

static void ModSetDataInteractionTranslator::receivePortalInteraction	(	const MAKVrExchange::DtPortalSetDataInteraction &	interaction,
		void *	userData
	)

staticprotected

The callback function registered by the constructor and used by the Portal.

This function is called when a Portal Data interaction occurs. Calls createDisInteration() to send the Portal interaction to DIS VR-Link.

Parameters

[in]	interaction	Portal Data Interaction to be sent.
[in]	userData	ModSetDataInteractionTranslator object.

Precondition: interaction is a valid object. userData must either be a valid ModSetDataInteractionTranslator object, or NULL.

virtual void ModSetDataInteractionTranslator::removeDisCallbacks ( )

virtual

Reimplemented from MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction, DtSetDataInteraction >.

virtual void ModSetDataInteractionTranslator::removePortalCallbacks ( )

virtual

Reimplemented from MAKVrExchange::DtBaseInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction >.

virtual MAKVrExchange::DtPortalSetDataInteraction* ModSetDataInteractionTranslator::translate	(	MAKVrExchange::DtPortalSetDataInteraction *	destination,
		const DtSetDataInteraction &	source
	)

virtual

Translates a DIS VR-Link Set Data interaction into a VR-Exchange Portal Set Data interaction.

Takes the information found in source and produces a comparable DtPortalSetDataInteraction message found in destination. This function is overloaded to provide translation in the opposite direction.

Parameters

[out]	destination	A VR-Exchange Portal Set Data interaction.
[in]	source	A DIS VR-Link Set Data interaction.

Returns: Address of destination.

Precondition: destination and source are both valid.

Implements MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction, DtSetDataInteraction >.

virtual DtSetDataInteraction* ModSetDataInteractionTranslator::translate	(	DtSetDataInteraction *	destination,
		const MAKVrExchange::DtPortalSetDataInteraction &	source
	)

virtual

Translates a VR-Exchange Portal Set Data interaction into a DIS VR-Link Set Data interaction.

Takes the information found in source and produces a comparable DIS VR-Link interaction. This function is overloaded to provide translation in the opposite direction.

Returns: Address of destination

Parameters

[out]	destination	A DIS VR-Link Set Data interaction.
[in]	source	A VR-Exchange Portal Set Data interaction.

Returns: Address of destination

Precondition: destination and source are both valid.

Implements MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction, DtSetDataInteraction >.

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

setDataInTrans.h

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation