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

Provides container to hold pointers to Protocol/Portal objects. More...

Public Member Functions

 DtBrokerObject (bool isPortal, const DtString &translatorName)
 CTOR. More...
 
virtual ~DtBrokerObject ()
 Virtual DTOR. More...
 
virtual bool isPortalObject () const
 
virtual void * publisherPtr () const
 
virtual void setPublisherPtr (void *ptr)
 
virtual const void * reflectedObjPtr () const
 
virtual void setReflectedObjPtr (const void *ptr)
 
virtual DtTime lastUpdate () const
 
virtual void setLastUpdate (const DtTime &tm)
 
virtual DtTime firstUpdate () const
 
virtual void setFirstUpdate (const DtTime &tm)
 
virtual bool isPublishable () const
 
virtual void setIsPublishable (bool val)
 
virtual bool isDiscovered () const
 
virtual void setIsDiscovered (bool val)
 
virtual bool isDropped () const
 
virtual void setIsDropped (bool val)
 
virtual const DtStringdropReason () const
 
virtual void setDropReason (const DtString &reason)
 
virtual bool isFiltered () const
 
virtual void setIsFiltered (bool val)
 
virtual const DtStringtranslatorName () const
 
virtual void setTranslatorName (const DtString &name)
 
virtual const DtStringobjectName () const
 
virtual void setObjectName (const DtString &name)
 
virtual const DtStringobjectId () const
 
virtual void setObjectId (const DtString &id)
 
virtual const DtStringmarkingText () const
 
virtual void setMarkingText (const DtString &name)
 
virtual const DtEntityType & entityType () const
 
virtual void setEntityType (const DtEntityType &type)
 
virtual void setBrokerData (int key, const DtString &data)
 
virtual DtString brokerData (int key) const
 
virtual void setBrokerDataPtr (int key, void *data)
 
virtual void * brokerDataPtr (int key) const
 

Protected Types

typedef std::map< int, void * > BrokerDataPtrMap
 
typedef std::map< int, DtStringBrokerDataMap
 

Protected Attributes

BrokerDataPtrMap myBrokerDataPtrMap
 
BrokerDataMap myBrokerDataMap
 
void * myPublisherPtr
 
const void * myReflectedObjPtr
 
DtTime myLastUpdate
 
DtTime myFirstUpdate
 
bool myPublishableFlag
 myPublishableFlag is set to false until its its found to be publishable More...
 
bool myDiscoveredFlag
 MyDiscovered flag is always true but will be toggled to false IF a discovery criteria method rejects it. More...
 
bool myDroppedFlag
 Set when this object has been dropped by the broker for some reason. More...
 
bool myFilteredFlag
 Set when this object has been filtered by the broker for some reason. More...
 
bool myIsPortalObjectFlag
 Indicates whether this object is from the portal or not. More...
 
DtString myTranslatorName
 
DtString myStatus
 
DtString myDropReason
 
DtString myObjectName
 
DtString myObjectId
 
DtString myMarkingText
 
DtEntityType myEntityType
 

Private Member Functions

 DtBrokerObject (const DtBrokerObject &other)
 Copy Constructor Not implemented. More...
 
DtBrokerObjectoperator= (const DtBrokerObject &other)
 Assignment Operator Not implemented. More...
 

Detailed Description

Provides container to hold pointers to Protocol/Portal objects.

An instance of a broker object is created for every simulated object.

Member Typedef Documentation

typedef std::map<int,DtString> MAKVrExchange::DtBrokerObject::BrokerDataMap
protected
typedef std::map<int,void*> MAKVrExchange::DtBrokerObject::BrokerDataPtrMap
protected

Constructor & Destructor Documentation

MAKVrExchange::DtBrokerObject::DtBrokerObject ( bool  isPortal,
const DtString translatorName 
)

CTOR.

virtual MAKVrExchange::DtBrokerObject::~DtBrokerObject ( )
virtual

Virtual DTOR.

MAKVrExchange::DtBrokerObject::DtBrokerObject ( const DtBrokerObject other)
private

Copy Constructor Not implemented.

Member Function Documentation

virtual DtString MAKVrExchange::DtBrokerObject::brokerData ( int  key) const
virtual
virtual void* MAKVrExchange::DtBrokerObject::brokerDataPtr ( int  key) const
virtual
virtual const DtString& MAKVrExchange::DtBrokerObject::dropReason ( ) const
virtual
virtual const DtEntityType& MAKVrExchange::DtBrokerObject::entityType ( ) const
virtual
virtual DtTime MAKVrExchange::DtBrokerObject::firstUpdate ( ) const
virtual
virtual bool MAKVrExchange::DtBrokerObject::isDiscovered ( ) const
virtual
virtual bool MAKVrExchange::DtBrokerObject::isDropped ( ) const
virtual
virtual bool MAKVrExchange::DtBrokerObject::isFiltered ( ) const
virtual
virtual bool MAKVrExchange::DtBrokerObject::isPortalObject ( ) const
virtual
virtual bool MAKVrExchange::DtBrokerObject::isPublishable ( ) const
virtual
virtual DtTime MAKVrExchange::DtBrokerObject::lastUpdate ( ) const
virtual
virtual const DtString& MAKVrExchange::DtBrokerObject::markingText ( ) const
virtual
virtual const DtString& MAKVrExchange::DtBrokerObject::objectId ( ) const
virtual
virtual const DtString& MAKVrExchange::DtBrokerObject::objectName ( ) const
virtual
DtBrokerObject& MAKVrExchange::DtBrokerObject::operator= ( const DtBrokerObject other)
private

Assignment Operator Not implemented.

virtual void* MAKVrExchange::DtBrokerObject::publisherPtr ( ) const
virtual
virtual const void* MAKVrExchange::DtBrokerObject::reflectedObjPtr ( ) const
virtual
virtual void MAKVrExchange::DtBrokerObject::setBrokerData ( int  key,
const DtString data 
)
virtual
virtual void MAKVrExchange::DtBrokerObject::setBrokerDataPtr ( int  key,
void *  data 
)
virtual
virtual void MAKVrExchange::DtBrokerObject::setDropReason ( const DtString reason)
virtual
virtual void MAKVrExchange::DtBrokerObject::setEntityType ( const DtEntityType &  type)
virtual
virtual void MAKVrExchange::DtBrokerObject::setFirstUpdate ( const DtTime &  tm)
virtual
virtual void MAKVrExchange::DtBrokerObject::setIsDiscovered ( bool  val)
virtual
virtual void MAKVrExchange::DtBrokerObject::setIsDropped ( bool  val)
virtual
virtual void MAKVrExchange::DtBrokerObject::setIsFiltered ( bool  val)
virtual
virtual void MAKVrExchange::DtBrokerObject::setIsPublishable ( bool  val)
virtual
virtual void MAKVrExchange::DtBrokerObject::setLastUpdate ( const DtTime &  tm)
virtual
virtual void MAKVrExchange::DtBrokerObject::setMarkingText ( const DtString name)
virtual
virtual void MAKVrExchange::DtBrokerObject::setObjectId ( const DtString id)
virtual
virtual void MAKVrExchange::DtBrokerObject::setObjectName ( const DtString name)
virtual
virtual void MAKVrExchange::DtBrokerObject::setPublisherPtr ( void *  ptr)
virtual
virtual void MAKVrExchange::DtBrokerObject::setReflectedObjPtr ( const void *  ptr)
virtual
virtual void MAKVrExchange::DtBrokerObject::setTranslatorName ( const DtString name)
virtual
virtual const DtString& MAKVrExchange::DtBrokerObject::translatorName ( ) const
virtual

Member Data Documentation

BrokerDataMap MAKVrExchange::DtBrokerObject::myBrokerDataMap
protected
BrokerDataPtrMap MAKVrExchange::DtBrokerObject::myBrokerDataPtrMap
protected
bool MAKVrExchange::DtBrokerObject::myDiscoveredFlag
protected

MyDiscovered flag is always true but will be toggled to false IF a discovery criteria method rejects it.

bool MAKVrExchange::DtBrokerObject::myDroppedFlag
protected

Set when this object has been dropped by the broker for some reason.

DtString MAKVrExchange::DtBrokerObject::myDropReason
protected
DtEntityType MAKVrExchange::DtBrokerObject::myEntityType
protected
bool MAKVrExchange::DtBrokerObject::myFilteredFlag
protected

Set when this object has been filtered by the broker for some reason.

DtTime MAKVrExchange::DtBrokerObject::myFirstUpdate
protected
bool MAKVrExchange::DtBrokerObject::myIsPortalObjectFlag
protected

Indicates whether this object is from the portal or not.

DtTime MAKVrExchange::DtBrokerObject::myLastUpdate
protected
DtString MAKVrExchange::DtBrokerObject::myMarkingText
protected
DtString MAKVrExchange::DtBrokerObject::myObjectId
protected
DtString MAKVrExchange::DtBrokerObject::myObjectName
protected
bool MAKVrExchange::DtBrokerObject::myPublishableFlag
protected

myPublishableFlag is set to false until its its found to be publishable

void* MAKVrExchange::DtBrokerObject::myPublisherPtr
protected
const void* MAKVrExchange::DtBrokerObject::myReflectedObjPtr
protected
DtString MAKVrExchange::DtBrokerObject::myStatus
protected
DtString MAKVrExchange::DtBrokerObject::myTranslatorName
protected

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

Document ID: Generated on Tue Aug 16 16:15:26 EDT 2022 from SVN revision 245901
Copyright © 2005-2022 MAK Technologies. All Rights Reserved (www.mak.com)