VR-Exchange 2.2 API Documentation
List of all members | Public Member Functions | Private Member Functions
ModEntityTranslator Class Reference

DtModEntityTranslator subclasses DtEntityTranslator to change translation. More...

Inheritance diagram for ModEntityTranslator:
Inheritance graph
[legend]

Public Member Functions

 ModEntityTranslator (MAKVrExchange::DtDisBroker::DtDisBroker *broker)
 CTOR.
virtual ~ModEntityTranslator ()
 Virtual DTOR.
virtual DtEntityStateRepository * translate (DtEntityStateRepository *dest, const MAKVrExchange::DtPortalEntity &src)
 Translates a Portal entity to a DIS entity.
virtual
MAKVrExchange::DtPortalEntity
translate (MAKVrExchange::DtPortalEntity *destination, const DtEntityStateRepository &source)
 Translates a DIS entity to a Portal entity.
- Public Member Functions inherited from MAKVrExchange::DtDisBroker::DtEntityTranslator
 Dt_DEF_TRANSLATOR_NAME ("Entity State")
 DtEntityTranslator (DtDisBroker *broker)
 CTOR.
virtual ~DtEntityTranslator ()
 DTOR.
virtual void tick ()
 Ticks all Portal and DIS publishers.
virtual void enableTranslator (bool enabled)
 enables or disables this translator.
- Public Member Functions inherited from MAKVrExchange::DtDisBroker::DtObjectTranslator
 DtObjectTranslator (DtDisBroker *broker, const DtString &name, DtPortalMessageKind kind)
 The Default CTOR.
virtual ~DtObjectTranslator ()
 Virtual DTOR.
virtual DtBrokerObjectreleaseBrokerObject (const DtReflectedObject *reflectedObj)
 returns the BrokerObject associated with the reflectedObj.
virtual DtBrokerObjectreleaseBrokerObject (const DtPortalReflectedObject *reflectedObj)
virtual DtBrokerObjectfindBrokerObject (const DtReflectedObject *reflectedObj)
 Find the BrokerObjectStateRepository for this reflectedObject.
virtual DtBrokerObjectfindBrokerObject (const DtPortalReflectedObject *reflectedObj)
virtual DtBrokerObjectcreateBrokerObject (const DtReflectedObject *reflectedObj)
 Creates a brokerObject to represent a reflectedObject reported by VR-Link.
virtual DtBrokerObjectcreateBrokerObject (const DtPortalReflectedObject *reflectedObj)
virtual bool isDisDiscoverable (const DtReflectedObject *reflectedObj)
 Checks if this DIS object is discoverable.
virtual bool isPortalDiscoverable (const DtPortalReflectedObject *reflectedObj)
 Checks if this portalObject is discoverable.
virtual void removeDisObject (const DtReflectedObject *reflectedObj)
 Called when an DIS object is removed from a reflected list.
virtual void printIncomingOutgoingStateReps (const DtPortalObject &incoming, const DtStateRepository &outgoing)
virtual void printIncomingOutgoingStateReps (const DtStateRepository &incoming, const DtPortalObject &outgoing)
virtual void performPortalDebugging (const DtPortalObject &incoming, const DtStateRepository &outgoing)
virtual void performPortalDebugging (const DtStateRepository &incoming, const DtPortalObject &outgoing)
virtual void addObjectDiscoveredCallback (BrokerObjectCbPtr funcPtr, void *userData)
virtual void addObjectUpdatedCallback (BrokerObjectCbPtr funcPtr, void *userData)
virtual void addObjectRemovedCallback (BrokerObjectCbPtr funcPtr, void *userData)
virtual void logObjectActionUpdate (const DtBrokerObject *go, UpdateType ut)
virtual unsigned int numObjects () const
 Returns the current number of objects.
- 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.
DtBrokerbroker () const
 Broker Accessor.

Private Member Functions

 ModEntityTranslator (const ModEntityTranslator &other)
ModEntityTranslatoroperator= (const ModEntityTranslator &other)

Additional Inherited Members

- Public Types inherited from MAKVrExchange::DtDisBroker::DtObjectTranslator
enum  UpdateType { none = 0, discover = 1, update = 2, remove = 3 }
 Enums used with the ObjectAction callback. More...
typedef void(* BrokerObjectCbPtr )(const DtBrokerObject *brokerObjectPointer, void *userData)
- Protected Types inherited from MAKVrExchange::DtDisBroker::DtObjectTranslator
typedef std::list< CallbackPairCallbackPairList
typedef std::map< const
DtReflectedObject
*, DtBrokerObject * > 
DisToPortalReflectedMap
typedef std::map< const
DtPortalReflectedObject
*, DtBrokerObject * > 
PortalToDisReflectedMap
typedef std::set< DtStringTransDebugObjectNamesSet
- Protected Member Functions inherited from MAKVrExchange::DtDisBroker::DtEntityTranslator
virtual void discoverDisObject (DtReflectedEntity *obj)
 Creates and initializes a broker object and portal publisher.
virtual void discoverPortalObject (const DtPortalReflectedEntity &obj)
 Creates and initializes a broker object and DIS publisher.
virtual void receiveDisUpdate (DtReflectedEntity *obj)
 Updates the entity's portal publisher with the new state.
virtual void receivePortalUpdate (const DtPortalReflectedObject &obj)
 Updates the entity's DIS publisher with the new state.
virtual void createDisPublisher (DtBrokerObject *brokerObject)
 Creates a new DtEntityPublisher and stores it in the broker object.
virtual void createPortalPublisher (DtBrokerObject *brokerObject)
 Creates a new DtPortalEntityPublisher and stores it in the broker object.
virtual void deleteDisPublisher (DtBrokerObject *brokerObject)
 Destroys the broker object's DtEntityPublisher.
virtual void deletePortalPublisher (DtBrokerObject *brokerObject)
 Destroys the broker object's DtPortalEntityPublisher.
virtual bool isDisPublishable (const DtBrokerObject *brokerObject) const
 Is the broker object publishable as a DIS entity.
virtual bool isPortalPublishable (const DtBrokerObject *brokerObject) const
 Is the broker object publishable as a portal entity.
virtual void syncDisDeadReckonedValues (DtBrokerObject *brokerObject)
 Syncs the DIS object's dead-reckoned values with the portal object's.
virtual void syncPortalDeadReckonedValues (DtBrokerObject *brokerObject)
 Syncs the portal object's dead-reckoned values with the DIS object's.
- Static Protected Member Functions inherited from MAKVrExchange::DtDisBroker::DtEntityTranslator
static bool disDiscoveryCriteria (DtReflectedObject *obj, void *usr)
 Static callback for testing whether the DIS object should be discovered.
static bool portalDiscoveryCriteria (const DtPortalReflectedObject *obj, void *usr)
 Static callback for testing whether the portal object should be discovered.
static void disObjectAddedCb (DtReflectedEntity *obj, void *usr)
 Static callback for processing newly discovered DIS objects.
static void disObjectUpdatedCb (DtReflectedEntity *obj, void *usr)
 Static callback for processing DIS object updates.
static void disObjectDeletedCb (DtReflectedEntity *obj, void *usr)
 Static callback for processing DIS object destruction.
static void portalObjectAddedCb (const DtPortalReflectedEntity &obj, void *usr)
 Static callback for processing newly discovered portal objects.
static void portalObjectUpdatedCb (const DtPortalReflectedEntity &obj, void *usr)
 Static callback for processing portal object updates.
static void portalObjectDeletedCb (const DtPortalReflectedEntity &obj, void *usr)
 Static callback for processing portal object destruction.
- Protected Attributes inherited from MAKVrExchange::DtDisBroker::DtEntityTranslator
DtReflectedEntityList * myDisReflectedList
DtPortalReflectedEntityManagermyPortalReflectedManager

Detailed Description

DtModEntityTranslator subclasses DtEntityTranslator to change translation.

Constructor & Destructor Documentation

ModEntityTranslator::ModEntityTranslator ( MAKVrExchange::DtDisBroker::DtDisBroker broker)

CTOR.

virtual ModEntityTranslator::~ModEntityTranslator ( )
virtual

Virtual DTOR.

ModEntityTranslator::ModEntityTranslator ( const ModEntityTranslator other)
private

Member Function Documentation

virtual DtEntityStateRepository* ModEntityTranslator::translate ( DtEntityStateRepository *  dest,
const MAKVrExchange::DtPortalEntity src 
)
virtual

Translates a Portal entity to a DIS entity.

Reimplemented from MAKVrExchange::DtDisBroker::DtEntityTranslator.

virtual MAKVrExchange::DtPortalEntity* ModEntityTranslator::translate ( MAKVrExchange::DtPortalEntity destination,
const DtEntityStateRepository &  source 
)
virtual

Translates a DIS entity to a Portal entity.

Reimplemented from MAKVrExchange::DtDisBroker::DtEntityTranslator.

ModEntityTranslator& ModEntityTranslator::operator= ( const ModEntityTranslator other)
private

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

Document ID: Generated on Mon Apr 15 17:15:50 EDT 2013 from SVN revision 126154
Copyright © 2005-2012 VT MÄK. All Rights Reserved (www.mak.com)