MAKVrExchange::DtObjectTranslator Class Reference

DtObjectTranslators provide common logic for translating objects. More...

Inheritance diagram for MAKVrExchange::DtObjectTranslator:

Classes
struct	CallbackPair

Public Types
typedef void(*	BrokerObjectCbPtr )(const DtBrokerObject *brokerObj, void *usr)

Public Member Functions
	DtObjectTranslator (DtBroker *broker, const DtString &name, DtPortalMessageKind kind)
	CTOR.
virtual	~DtObjectTranslator ()
	Virtual DTOR.
virtual void	shutdown ()=0
	Performs any virtual shutdown logic prior to deletion.
virtual void	forceUpdateAll ()
	Forces an update for all objects on the next tick.
virtual unsigned int	numObjects () const =0
	Returns the current number of objects.
Abstract Portal Callback Initialization
virtual void	initializePortalCallbacks ()=0
virtual void	removePortalCallbacks ()=0
Add Object Callback Methods.
virtual void	addObjectDiscoveredCallback (BrokerObjectCbPtr funcPtr, void *usr)
virtual void	addObjectUpdatedCallback (BrokerObjectCbPtr funcPtr, void *usr)
virtual void	addObjectRemovedCallback (BrokerObjectCbPtr funcPtr, void *usr)
Call Object Callback Methods.
virtual void	callObjectDiscoverCallbacks (const DtBrokerObject *obj)
virtual void	callObjectUpdateCallbacks (const DtBrokerObject *obj)
virtual void	callObjectRemoveCallbacks (const DtBrokerObject *obj)
Portal Publishable/Discoverable Checks.
virtual bool	isPortalDiscoverable (const DtPortalReflectedObject *obj)
	Tests whether the Portal object is discoverable.
virtual bool	isPortalPublishable (const DtBrokerObject *obj)
	Tests whether the Portal object is publishable.
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.
DtBroker *	broker () const
	Broker Accessor.

Protected Types
typedef std::list< CallbackPair >	CallbackPairList

Protected Attributes
CallbackPairList	myDiscoverCallbacks
CallbackPairList	myUpdateCallbacks
CallbackPairList	myRemoveCallbacks
Protected Attributes inherited from MAKVrExchange::DtTranslator
DtString	myTranslatorName
DtPortalMessageKind	myPortalMessageKind
DtBroker *	myBroker
bool	myReflectEnabled
bool	myPublishEnabled

Detailed Description

DtObjectTranslators provide common logic for translating objects.

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

Member Typedef Documentation

typedef void(* MAKVrExchange::DtObjectTranslator::BrokerObjectCbPtr)(const DtBrokerObject *brokerObj, void *usr)

typedef std::list<CallbackPair> MAKVrExchange::DtObjectTranslator::CallbackPairList

protected

Constructor & Destructor Documentation

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

CTOR.

virtual MAKVrExchange::DtObjectTranslator::~DtObjectTranslator ( )

virtual

Virtual DTOR.

Member Function Documentation

virtual void MAKVrExchange::DtObjectTranslator::addObjectDiscoveredCallback ( BrokerObjectCbPtr  funcPtr, void *  usr  )

virtual

virtual void MAKVrExchange::DtObjectTranslator::addObjectRemovedCallback ( BrokerObjectCbPtr  funcPtr, void *  usr  )

virtual

virtual void MAKVrExchange::DtObjectTranslator::addObjectUpdatedCallback ( BrokerObjectCbPtr  funcPtr, void *  usr  )

virtual

virtual void MAKVrExchange::DtObjectTranslator::callObjectDiscoverCallbacks ( const DtBrokerObject *  obj )

virtual

Reimplemented in MAKVrExchange::DtTenaBroker::DtTenaObjectTranslator, MAKVrExchange::DtDisBroker::DtDisObjectTranslator, and MAKVrExchange::DtDdsBroker::DtDdsObjectTranslator.

virtual void MAKVrExchange::DtObjectTranslator::callObjectRemoveCallbacks ( const DtBrokerObject *  obj )

virtual

Reimplemented in MAKVrExchange::DtTenaBroker::DtTenaObjectTranslator, MAKVrExchange::DtDisBroker::DtDisObjectTranslator, and MAKVrExchange::DtDdsBroker::DtDdsObjectTranslator.

virtual void MAKVrExchange::DtObjectTranslator::callObjectUpdateCallbacks ( const DtBrokerObject *  obj )

virtual

Reimplemented in MAKVrExchange::DtTenaBroker::DtTenaObjectTranslator, MAKVrExchange::DtDisBroker::DtDisObjectTranslator, and MAKVrExchange::DtDdsBroker::DtDdsObjectTranslator.

virtual void MAKVrExchange::DtObjectTranslator::forceUpdateAll ( )

inlinevirtual

Forces an update for all objects on the next tick.

brokers that would like to implement heart beating, should overwrite this function.

Reimplemented in MAKVrExchange::DtRprBroker::DtRprObjectTranslator, MAKVrExchange::DtTenaBroker::DtTenaObjectTranslator, MAKVrExchange::DtDisBroker::DtDisObjectTranslator, and MAKVrExchange::DtDdsBroker::DtDdsObjectTranslator.

virtual void MAKVrExchange::DtObjectTranslator::initializePortalCallbacks ( )

pure virtual

Implements MAKVrExchange::DtTranslator.

Implemented in MAKVrExchange::DtBaseObjectTranslator< T_PortalObject, T_PortalReflectedObject >, and MAKVrExchange::DtBaseObjectTranslator< DtPortalTimeMgmtObject, DtPortalReflectedTimeMgmtObject >.

virtual bool MAKVrExchange::DtObjectTranslator::isPortalDiscoverable ( const DtPortalReflectedObject *  obj )

virtual

Tests whether the Portal object is discoverable.

Default implementation always returns true.

Reimplemented in MAKVrExchange::DtTenaBroker::DtTenaObjectTranslator, MAKVrExchange::DtRprBroker::DtRprObjectTranslator, MAKVrExchange::DtDisBroker::DtDisObjectTranslator, and MAKVrExchange::DtDdsBroker::DtDdsObjectTranslator.

virtual bool MAKVrExchange::DtObjectTranslator::isPortalPublishable ( const DtBrokerObject *  obj )

virtual

Tests whether the Portal object is publishable.

Default implementation always returns true.

virtual unsigned int MAKVrExchange::DtObjectTranslator::numObjects ( ) const

pure virtual

Returns the current number of objects.

Implemented in MAKVrExchange::DtTenaBroker::DtTenaObjectTranslator, MAKVrExchange::DtDisBroker::DtDisObjectTranslator, MAKVrExchange::DtDdsBroker::DtDdsObjectTranslator, MAKVrExchange::DtRprBroker::DtRprObjectTranslator, and DtTimeManagementTranslator.

virtual void MAKVrExchange::DtObjectTranslator::removePortalCallbacks ( )

pure virtual

Implements MAKVrExchange::DtTranslator.

Implemented in MAKVrExchange::DtBaseObjectTranslator< T_PortalObject, T_PortalReflectedObject >, and MAKVrExchange::DtBaseObjectTranslator< DtPortalTimeMgmtObject, DtPortalReflectedTimeMgmtObject >.

virtual void MAKVrExchange::DtObjectTranslator::shutdown ( )

pure virtual

Performs any virtual shutdown logic prior to deletion.

Implements MAKVrExchange::DtTranslator.

Implemented in MAKVrExchange::DtDisBroker::DtDisObjectTranslator, MAKVrExchange::DtBaseObjectTranslator< T_PortalObject, T_PortalReflectedObject >, MAKVrExchange::DtBaseObjectTranslator< DtPortalTimeMgmtObject, DtPortalReflectedTimeMgmtObject >, MAKVrExchange::DtTenaBroker::DtTenaObjectTranslator, MAKVrExchange::DtRprBroker::DtRprObjectTranslator, and MAKVrExchange::DtDdsBroker::DtDdsObjectTranslator.

Member Data Documentation

CallbackPairList MAKVrExchange::DtObjectTranslator::myDiscoverCallbacks

protected

CallbackPairList MAKVrExchange::DtObjectTranslator::myRemoveCallbacks

protected

CallbackPairList MAKVrExchange::DtObjectTranslator::myUpdateCallbacks

protected

---

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

• baseObjectTranslator.h