MAKVrExchange::DtTranslator Class Reference

Responsible for converting a specific message type between two protocols. More...

Inheritance diagram for MAKVrExchange::DtTranslator:

Public Member Functions
	DtTranslator (DtBroker *broker, const DtString &name, DtPortalMessageKind kind)
	CTOR.
virtual	~DtTranslator ()
	Virtual DTOR.
virtual DtString	name () const
	Accessor for the translator's name.
virtual void	enableTranslator (bool enabled)
	enables or disables this translator.
virtual void	tick ()
	Needs to be implemented for every translator, this is called every frame to allow the translator to do any needed processing.
DtBroker *	broker () const
	Broker Accessor.

Protected Attributes
DtString	myTranslatorName
DtPortalMessageKind	myPortalMessageKind
DtBroker *	myBroker
bool	myEnabled

Private Member Functions
	DtTranslator (const DtTranslator &other)
	Private Copy CTOR not implemented - do not copy.
DtTranslator &	operator= (const DtTranslator &other)
	Private Assignment operator not implemented - do not copy.

Detailed Description

Responsible for converting a specific message type between two protocols.

This analogy works best with DIS->HLA where a translator is used to convert DIS objects. This isn't always the best way to describe translators however, sometimes two messages on one side need to be bundled into one message on another, a translator would be used for that too.

Constructor & Destructor Documentation

MAKVrExchange::DtTranslator::DtTranslator	(	DtBroker *	broker,
		const DtString &	name,
		DtPortalMessageKind	kind
	)

CTOR.

Broker must be valid (ie. must not be null, must have a non-null connection, and must have a non-null portal connection).

Exceptions

DtInvalidInput

if broker is invalid.

virtual MAKVrExchange::DtTranslator::~DtTranslator ( )

virtual

Virtual DTOR.

MAKVrExchange::DtTranslator::DtTranslator ( const DtTranslator &  other )

private

Private Copy CTOR not implemented - do not copy.

Member Function Documentation

virtual DtString MAKVrExchange::DtTranslator::name ( ) const

virtual

Accessor for the translator's name.

virtual void MAKVrExchange::DtTranslator::enableTranslator ( bool  enabled )

virtual

enables or disables this translator.

Reimplemented in MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< PortalInterType, HlaInterType >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalStartInteraction, DtStartResumeInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalTransferControlInteraction, DtTransferControlInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalFireInteraction, DtFireInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalRadioSignalInteraction, DtSignalInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalServiceRequestInteraction, DtServiceRequestInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalEventReportInteraction, DtEventReportInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalCreateEntityInteraction, DtCreateEntityInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalActionResponseInteraction, DtActionResponseInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalDataQueryInteraction, DtDataQueryInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalDataInteraction, DtDataInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalRemoveEntityInteraction, DtRemoveEntityInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalResupplyCancelInteraction, DtResupplyCancelInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalCommentInteraction, DtCommentInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalStopInteraction, DtStopFreezeInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalRepairCompleteInteraction, DtRepairCompleteInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalDetonationInteraction, DtDetonationInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalSetDataInteraction, DtSetDataInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalResupplyOfferInteraction, DtResupplyOfferInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalRepairResponseInteraction, DtRepairResponseInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalActionRequestInteraction, DtActionRequestInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< GENERICIN_TEMPLATE_ARGS >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalAcknowledgeInteraction, DtAcknowledgeInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalResupplyReceivedInteraction, DtResupplyRecInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< DtPortalCollisionInteraction, DtCollisionInteraction >, MAKVrExchange::DtRprBroker::DtRprObjectTranslator, MAKVrExchange::DtDisBroker::DtAggregateTranslator, MAKVrExchange::DtDisBroker::DtEnvironmentProcessObjectTranslator, MAKVrExchange::DtDisBroker::DtEmitterSystemObjectTranslator, MAKVrExchange::DtDisBroker::DtRadioTransmitterTranslator, MAKVrExchange::DtDisBroker::DtDesignatorObjectTranslator, MAKVrExchange::DtDisBroker::DtLoggerControlInteractionTranslator, MAKVrExchange::DtRprBroker::DtLoggerControlInteractionTranslator, MAKVrExchange::DtTenaBroker::DtEmitterSystemObjectTranslator, DtTimeManagementTranslator, MAKVrExchange::DtRprBroker::DtGenericInteractionTranslator, MAKVrExchange::DtTenaBroker::DtDesignatorObjectTranslator, MAKVrExchange::DtTenaBroker::DtEnvironmentProcessObjectTranslator, MAKVrExchange::DtTenaBroker::DtRadioTransmitterObjectTranslator, MAKVrExchange::DtDisBroker::DtRadioReceiverObjectTranslator, MAKVrExchange::DtTenaBroker::DtAggregateTranslator, MAKVrExchange::DtTenaBroker::DtEntityTranslator, MAKVrExchange::DtTenaBroker::DtFireInteractionTranslator, MAKVrExchange::DtDisBroker::DtEntityTranslator, MAKVrExchange::DtDisBroker::DtDataQueryInteractionTranslator, MAKVrExchange::DtTenaBroker::DtRadioSignalInteractionTranslator, MAKVrExchange::DtDisBroker::DtRepairResponseInteractionTranslator, MAKVrExchange::DtTenaBroker::DtAcknowledgeInteractionTranslator, MAKVrExchange::DtTenaBroker::DtCollisionInteractionTranslator, MAKVrExchange::DtTenaBroker::DtCommentInteractionTranslator, MAKVrExchange::DtTenaBroker::DtDataInteractionTranslator, MAKVrExchange::DtTenaBroker::DtStartInteractionTranslator, MAKVrExchange::DtTenaBroker::DtStopInteractionTranslator, MAKVrExchange::DtDisBroker::DtActionRequestInteractionTranslator, MAKVrExchange::DtDisBroker::DtActionResponseInteractionTranslator, MAKVrExchange::DtDisBroker::DtCommentInteractionTranslator, MAKVrExchange::DtDisBroker::DtDataInteractionTranslator, MAKVrExchange::DtDisBroker::DtRepairCompleteInteractionTranslator, MAKVrExchange::DtDisBroker::DtRadioSignalInteractionTranslator, MAKVrExchange::DtDisBroker::DtStopInteractionTranslator, MAKVrExchange::DtTenaBroker::DtRadioReceiverObjectTranslator, MAKVrExchange::DtTenaBroker::DtSetDataInteractionTranslator, MAKVrExchange::DtDisBroker::DtCreateEntityInteractionTranslator, MAKVrExchange::DtDisBroker::DtEventReportInteractionTranslator, MAKVrExchange::DtDisBroker::DtResupplyOfferInteractionTranslator, MAKVrExchange::DtDisBroker::DtResupplyReceivedInteractionTranslator, MAKVrExchange::DtDisBroker::DtSetDataInteractionTranslator, ModSetDataInteractionTranslator, MAKVrExchange::DtDisBroker::DtResupplyCancelInteractionTranslator, MAKVrExchange::DtDisBroker::DtServiceRequestInteractionTranslator, MAKVrExchange::DtDisBroker::DtStartInteractionTranslator, MAKVrExchange::DtDisBroker::DtTransferControlInteractionTranslator, MAKVrExchange::DtTenaBroker::DtIffObjectTranslator, MAKVrExchange::DtDisBroker::DtCollisionInteractionTranslator, MAKVrExchange::DtDisBroker::DtGriddedDataObjectTranslator, MAKVrExchange::DtDisBroker::DtRemoveEntityInteractionTranslator, MAKVrExchange::DtDisBroker::DtAcknowledgeInteractionTranslator, MAKVrExchange::DtDisBroker::DtFireInteractionTranslator, MAKVrExchange::DtDisBroker::DtIffObjectTranslator, MAKVrExchange::DtTenaBroker::DtDetonationInteractionTranslator, MAKVrExchange::DtDisBroker::DtDetonationInteractionTranslator, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< PortalInterType, HlaInterType >, MAKVrExchange::DtBaseObjectTranslator, and MAKVrExchange::DtBaseInteractionTranslator.

virtual void MAKVrExchange::DtTranslator::tick ( )

inlinevirtual

Needs to be implemented for every translator, this is called every frame to allow the translator to do any needed processing.

Reimplemented in MAKVrExchange::DtTenaBroker::DtObjectTranslator, MAKVrExchange::DtDisBroker::DtObjectTranslator, MAKVrExchange::DtRprBroker::DtObjectTranslator, MAKVrExchange::DtRprBroker::DtRprObjectTranslator, MAKVrExchange::DtDisBroker::DtEnvironmentProcessObjectTranslator, MAKVrExchange::DtDisBroker::DtAggregateTranslator, MAKVrExchange::DtDisBroker::DtEmitterSystemObjectTranslator, MAKVrExchange::DtDisBroker::DtRadioTransmitterTranslator, MAKVrExchange::DtDisBroker::DtDesignatorObjectTranslator, MAKVrExchange::DtTenaBroker::DtEmitterSystemObjectTranslator, MAKVrExchange::DtTenaBroker::DtDesignatorObjectTranslator, MAKVrExchange::DtTenaBroker::DtEnvironmentProcessObjectTranslator, MAKVrExchange::DtTenaBroker::DtRadioTransmitterObjectTranslator, DtTimeManagementTranslator, MAKVrExchange::DtDisBroker::DtRadioReceiverObjectTranslator, MAKVrExchange::DtTenaBroker::DtAggregateTranslator, MAKVrExchange::DtTenaBroker::DtEntityTranslator, MAKVrExchange::DtDisBroker::DtEntityTranslator, MAKVrExchange::DtTenaBroker::DtRadioReceiverObjectTranslator, MAKVrExchange::DtTenaBroker::DtIffObjectTranslator, MAKVrExchange::DtDisBroker::DtGriddedDataObjectTranslator, and MAKVrExchange::DtDisBroker::DtIffObjectTranslator.

DtBroker* MAKVrExchange::DtTranslator::broker ( ) const

inline

Broker Accessor.

Non-virtual (Called from CTOR/DTOR).

Returns

a pointer to the broker translator's broker.

DtTranslator& MAKVrExchange::DtTranslator::operator= ( const DtTranslator &  other )

private

Private Assignment operator not implemented - do not copy.

Member Data Documentation

DtString MAKVrExchange::DtTranslator::myTranslatorName

protected

DtPortalMessageKind MAKVrExchange::DtTranslator::myPortalMessageKind

protected

DtBroker* MAKVrExchange::DtTranslator::myBroker

protected

bool MAKVrExchange::DtTranslator::myEnabled

protected

---

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

• translator.h