VR-Exchange 2.2 API Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
MAKVrExchange::DtObjectTranslator Class Reference

DtBaseObjectTranslators are responsible for translating messages for things that have state. More...

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

Public Member Functions

 DtObjectTranslator (DtBroker *broker, const DtString &name, DtPortalMessageKind kind)
 The Default CTOR.
virtual ~DtObjectTranslator ()
 The Default DTOR.
virtual void initializePortalCallbacks ()
virtual void removePortalCallbacks ()
virtual void discoverPortalObject (const DtPortalReflectedObjectTemplate< T_DtPortalObject > &obj)=0
virtual void receivePortalUpdate (const DtPortalReflectedObjectTemplate< T_DtPortalObject > &obj)=0
virtual void removePortalObject (const DtPortalReflectedObjectTemplate< T_DtPortalObject > &obj)=0
virtual void callObjectDiscoverCallbacks (const T_DtBrokerObject *brokerObject)
 called when a Portal or HLA Object is Created
virtual void callObjectUpdateCallbacks (const T_DtBrokerObject *brokerObject)
 Called when a Portal or HLA Object is updated.
virtual void callObjectRemoveCallbacks (const T_DtBrokerObject *brokerObject)
 Called when a Portal or HLA Object is Deleted.
virtual bool isPortalPublishable (const T_DtBrokerObject *brokerObject) const
 Check if an object can be published on the other side.
virtual bool isPortalDiscoverable (const DtPortalReflectedObject *brokerObject) const
 Checks if this portalObject is discoverable.

Static Public Member Functions

static void portalObjectAddedCb (const DtPortalReflectedObjectTemplate< T_DtPortalObject > &obj, void *ud)
 Static callback for processing newly discovered portal objects.
static void portalObjectUpdatedCb (const DtPortalReflectedObjectTemplate< T_DtPortalObject > &obj, void *ud)
 Static callback for processing portal object updates.
static void portalObjectDeletedCb (const DtPortalReflectedObjectTemplate< T_DtPortalObject > &obj, void *ud)
 Static callback for processing portal object destruction.
static bool portalDiscoveryCriteria (const DtPortalReflectedObject *obj, void *usr)
 Static callback for testing whether the portal object should be discovered.

Protected Attributes

DtPortalReflectedObjectManager
< DtPortalReflectedObjectTemplate
< T_DtPortalObject > > * 
myPortalReflectedManager

Detailed Description

DtBaseObjectTranslators are responsible for translating messages for things that have state.

To this end the DtBrokerObject class is used to represent these objects with state. Often you wnat T_ParentClass to be DtBaseObjectTranslator unless you want to add functions that are generic to all translators in your broker.

Constructor & Destructor Documentation

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

The Default CTOR.

virtual MAKVrExchange::DtObjectTranslator::~DtObjectTranslator ( )
virtual

The Default DTOR.

Member Function Documentation

virtual void MAKVrExchange::DtObjectTranslator::initializePortalCallbacks ( )
virtual
virtual void MAKVrExchange::DtObjectTranslator::removePortalCallbacks ( )
virtual
virtual void MAKVrExchange::DtObjectTranslator::discoverPortalObject ( const DtPortalReflectedObjectTemplate< T_DtPortalObject > &  obj)
pure virtual
virtual void MAKVrExchange::DtObjectTranslator::receivePortalUpdate ( const DtPortalReflectedObjectTemplate< T_DtPortalObject > &  obj)
pure virtual
virtual void MAKVrExchange::DtObjectTranslator::removePortalObject ( const DtPortalReflectedObjectTemplate< T_DtPortalObject > &  obj)
pure virtual
virtual void MAKVrExchange::DtObjectTranslator::callObjectDiscoverCallbacks ( const T_DtBrokerObject *  brokerObject)
virtual

called when a Portal or HLA Object is Created

virtual void MAKVrExchange::DtObjectTranslator::callObjectUpdateCallbacks ( const T_DtBrokerObject *  brokerObject)
virtual

Called when a Portal or HLA Object is updated.

virtual void MAKVrExchange::DtObjectTranslator::callObjectRemoveCallbacks ( const T_DtBrokerObject *  brokerObject)
virtual

Called when a Portal or HLA Object is Deleted.

virtual bool MAKVrExchange::DtObjectTranslator::isPortalPublishable ( const T_DtBrokerObject *  brokerObject) const
virtual

Check if an object can be published on the other side.

By default always true.

virtual bool MAKVrExchange::DtObjectTranslator::isPortalDiscoverable ( const DtPortalReflectedObject brokerObject) const
virtual

Checks if this portalObject is discoverable.

Which should be true only if an object would be publishable on the other side By default always true.

static void MAKVrExchange::DtObjectTranslator::portalObjectAddedCb ( const DtPortalReflectedObjectTemplate< T_DtPortalObject > &  obj,
void *  ud 
)
static

Static callback for processing newly discovered portal objects.

Calls: discoverPortalObject

static void MAKVrExchange::DtObjectTranslator::portalObjectUpdatedCb ( const DtPortalReflectedObjectTemplate< T_DtPortalObject > &  obj,
void *  ud 
)
static

Static callback for processing portal object updates.

Calls: receivePortalUpdate

static void MAKVrExchange::DtObjectTranslator::portalObjectDeletedCb ( const DtPortalReflectedObjectTemplate< T_DtPortalObject > &  obj,
void *  ud 
)
static

Static callback for processing portal object destruction.

Calls: removePortalObject

static bool MAKVrExchange::DtObjectTranslator::portalDiscoveryCriteria ( const DtPortalReflectedObject obj,
void *  usr 
)
static

Static callback for testing whether the portal object should be discovered.

Calls: isPortalDiscoverable

Member Data Documentation

DtPortalReflectedObjectManager< DtPortalReflectedObjectTemplate< T_DtPortalObject > >* MAKVrExchange::DtObjectTranslator::myPortalReflectedManager
protected

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)