VR-Exchange 2.4 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
MAKVrExchange::DtInteractionTranslator Class Reference

DtInteractionTranslators provide common logic for translating interactions. More...

Inheritance diagram for MAKVrExchange::DtInteractionTranslator:
Inheritance graph
[legend]

Public Member Functions

 DtInteractionTranslator (DtBroker *broker, const DtString &name, DtPortalMessageKind kind)
 CTOR.
virtual ~DtInteractionTranslator ()
 Virtual DTOR.
virtual unsigned int numInteractions () const
 Returns the number of interactions received.
virtual void setNumInteractions (unsigned int num)
 Sets the interaction count - mainly used for zeroing it.
virtual void shutdown ()=0
 Performs any virtual shutdown logic prior to deletion.
Abstract Portal Callback Initialization
virtual void initializePortalCallbacks ()=0
virtual void removePortalCallbacks ()=0
- Public Member Functions inherited from MAKVrExchange::DtTranslator
 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 enableReflectTranslator (bool enabled)
 enables or disables this translator.
virtual void enablePublishTranslator (bool enabled)
virtual bool isReflectEnabled () const
virtual bool isPublishEnabled () const
virtual void tick ()
 Needs to be implemented for every translator, this is called every frame to allow the translator to do any needed processing.
DtBrokerbroker () const
 Broker Accessor.

Protected Attributes

unsigned int myNumInteractions
- Protected Attributes inherited from MAKVrExchange::DtTranslator
DtString myTranslatorName
DtPortalMessageKind myPortalMessageKind
DtBrokermyBroker
bool myReflectEnabled
bool myPublishEnabled

Detailed Description

DtInteractionTranslators provide common logic for translating interactions.

This class is handles basic enabling and disabling logic, and is the highest level class that can be used to identify an object translator.

Constructor & Destructor Documentation

MAKVrExchange::DtInteractionTranslator::DtInteractionTranslator ( DtBroker broker,
const DtString name,
DtPortalMessageKind  kind 
)

CTOR.

virtual MAKVrExchange::DtInteractionTranslator::~DtInteractionTranslator ( )
virtual

Virtual DTOR.

Member Function Documentation

virtual void MAKVrExchange::DtInteractionTranslator::initializePortalCallbacks ( )
pure virtual

Implements MAKVrExchange::DtTranslator.

Implemented in MAKVrExchange::DtDisBroker::DtLoggerControlInteractionTranslator, MAKVrExchange::DtRprBroker::DtLoggerControlInteractionTranslator, MAKVrExchange::DtBaseInteractionTranslator< DtPortalEventReportInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalRepairResponseInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalRepairCompleteInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalResupplyOfferInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalFireInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalResupplyReceivedInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalCommentInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalActionResponseInteraction >, MAKVrExchange::DtBaseInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalResupplyCancelInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalAcknowledgeInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalRemoveEntityInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalCreateEntityInteraction >, MAKVrExchange::DtBaseInteractionTranslator< T_PortalInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalSetDataInteraction >, MAKVrExchange::DtBaseInteractionTranslator< GENERICIN_TEMPLATE_ARGS >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalRadioSignalInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalDataInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalDetonationInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalDataQueryInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalStopInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalServiceRequestInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalCollisionInteraction >, MAKVrExchange::DtBaseInteractionTranslator< PortalInterType >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalActionRequestInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalStartInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalTransferControlInteraction >, and ModSetDataInteractionTranslator.

virtual unsigned int MAKVrExchange::DtInteractionTranslator::numInteractions ( ) const
virtual

Returns the number of interactions received.

virtual void MAKVrExchange::DtInteractionTranslator::removePortalCallbacks ( )
pure virtual

Implements MAKVrExchange::DtTranslator.

Implemented in MAKVrExchange::DtDisBroker::DtLoggerControlInteractionTranslator, MAKVrExchange::DtRprBroker::DtLoggerControlInteractionTranslator, MAKVrExchange::DtBaseInteractionTranslator< DtPortalEventReportInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalRepairResponseInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalRepairCompleteInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalResupplyOfferInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalFireInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalResupplyReceivedInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalCommentInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalActionResponseInteraction >, MAKVrExchange::DtBaseInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalResupplyCancelInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalAcknowledgeInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalRemoveEntityInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalCreateEntityInteraction >, MAKVrExchange::DtBaseInteractionTranslator< T_PortalInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalSetDataInteraction >, MAKVrExchange::DtBaseInteractionTranslator< GENERICIN_TEMPLATE_ARGS >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalRadioSignalInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalDataInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalDetonationInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalDataQueryInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalStopInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalServiceRequestInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalCollisionInteraction >, MAKVrExchange::DtBaseInteractionTranslator< PortalInterType >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalActionRequestInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalStartInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalTransferControlInteraction >, and ModSetDataInteractionTranslator.

virtual void MAKVrExchange::DtInteractionTranslator::setNumInteractions ( unsigned int  num)
virtual

Sets the interaction count - mainly used for zeroing it.

virtual void MAKVrExchange::DtInteractionTranslator::shutdown ( )
pure virtual

Performs any virtual shutdown logic prior to deletion.

Implements MAKVrExchange::DtTranslator.

Implemented in MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< PortalInterType, DisInterType >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalTransferControlInteraction, DtTransferControlInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalFireInteraction, DtFireInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalServiceRequestInteraction, DtServiceRequestInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalRadioSignalInteraction, DtSignalInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalCreateEntityInteraction, DtCreateEntityInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalEventReportInteraction, DtEventReportInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalActionResponseInteraction, DtActionResponseInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction, DtSetDataInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalDataQueryInteraction, DtDataQueryInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalDataInteraction, DtDataInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalRemoveEntityInteraction, DtRemoveEntityInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalResupplyCancelInteraction, DtResupplyCancelInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalCommentInteraction, DtCommentInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalStartInteraction, DtStartResumePdu >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalStopInteraction, DtStopFreezeInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalRepairCompleteInteraction, DtRepairCompleteInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalDetonationInteraction, DtDetonationInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalSetDataInteraction, DtSetDataInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalResupplyOfferInteraction, DtResupplyOfferInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalRepairResponseInteraction, DtRepairResponseInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalActionRequestInteraction, DtActionRequestInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalResupplyReceivedInteraction, DtResupplyRecInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalAcknowledgeInteraction, DtAcknowledgeInteraction >, MAKVrExchange::DtDisBroker::DtDisInteractionTranslator< DtPortalCollisionInteraction, DtCollisionInteraction >, MAKVrExchange::DtTenaBroker::DtTenaInteractionTranslator< PortalInterType, TenaInterType >, MAKVrExchange::DtTenaBroker::DtTenaInteractionTranslator< DtPortalFireInteraction, DtFireInteraction >, MAKVrExchange::DtTenaBroker::DtTenaInteractionTranslator< DtPortalStartInteraction, DtStartResumeInteraction >, MAKVrExchange::DtTenaBroker::DtTenaInteractionTranslator< DtPortalRadioSignalInteraction, DtSignalInteraction >, MAKVrExchange::DtTenaBroker::DtTenaInteractionTranslator< DtPortalDataInteraction, DtDataInteraction >, MAKVrExchange::DtTenaBroker::DtTenaInteractionTranslator< DtPortalStopInteraction, DtStopFreezeInteraction >, MAKVrExchange::DtTenaBroker::DtTenaInteractionTranslator< DtPortalCommentInteraction, DtCommentInteraction >, MAKVrExchange::DtTenaBroker::DtTenaInteractionTranslator< DtPortalDetonationInteraction, DtDetonationInteraction >, MAKVrExchange::DtTenaBroker::DtTenaInteractionTranslator< DtPortalSetDataInteraction, DtSetDataInteraction >, MAKVrExchange::DtTenaBroker::DtTenaInteractionTranslator< DtPortalAcknowledgeInteraction, DtAcknowledgeInteraction >, MAKVrExchange::DtTenaBroker::DtTenaInteractionTranslator< DtPortalCollisionInteraction, DtCollisionInteraction >, MAKVrExchange::DtRprBroker::DtRprInteractionTranslator< PortalInterType, RprInterType >, 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::DtDdsBroker::DtDdsInteractionTranslator< T_PortalInteraction, T_DDSInteraction >, MAKVrExchange::DtDdsBroker::DtDdsInteractionTranslator< DtPortalFireInteraction, simpleOM::simpleFireInteraction >, MAKVrExchange::DtDdsBroker::DtDdsInteractionTranslator< DtPortalDetonationInteraction, simpleOM::simpleDetonationInteraction >, MAKVrExchange::DtDisBroker::DtLoggerControlInteractionTranslator, MAKVrExchange::DtBaseInteractionTranslator< DtPortalEventReportInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalRepairResponseInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalRepairCompleteInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalResupplyOfferInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalFireInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalResupplyReceivedInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalCommentInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalActionResponseInteraction >, MAKVrExchange::DtBaseInteractionTranslator< MAKVrExchange::DtPortalSetDataInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalResupplyCancelInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalAcknowledgeInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalRemoveEntityInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalCreateEntityInteraction >, MAKVrExchange::DtBaseInteractionTranslator< T_PortalInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalSetDataInteraction >, MAKVrExchange::DtBaseInteractionTranslator< GENERICIN_TEMPLATE_ARGS >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalRadioSignalInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalDataInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalDetonationInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalDataQueryInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalStopInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalServiceRequestInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalCollisionInteraction >, MAKVrExchange::DtBaseInteractionTranslator< PortalInterType >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalActionRequestInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalStartInteraction >, MAKVrExchange::DtBaseInteractionTranslator< DtPortalTransferControlInteraction >, and MAKVrExchange::DtRprBroker::DtLoggerControlInteractionTranslator.

Member Data Documentation

unsigned int MAKVrExchange::DtInteractionTranslator::myNumInteractions
protected

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

Document ID: Generated on Thu Jul 23 10:25:22 EDT 2015 from SVN revision 155065
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)