VR-Exchange 2.9 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
brokerObject.h
Go to the documentation of this file.
1 /****************************************************************************
2  * Copyright (c) 2015 MAK Technologies, Inc.
3  * All rights reserved.
4  ****************************************************************************/
5 
9 
10 #pragma once
11 
12 #include <broker/dllExport.h>
13 #include <vlpi/entityType.h>
14 #include <vlutil/vlString.h>
15 #include <vlutil/vlTime.h>
16 #include <map>
17 
18 namespace MAKVrExchange
19 {
20 
25  {
26  public:
27 
29  DtBrokerObject( bool isPortal, const DtString& translatorName );
30 
32  virtual ~DtBrokerObject();
33 
34  virtual bool isPortalObject() const;
35 
36  virtual void* publisherPtr() const;
37  virtual void setPublisherPtr( void* ptr );
38 
39  virtual const void* reflectedObjPtr() const;
40  virtual void setReflectedObjPtr( const void* ptr );
41 
42  virtual DtTime lastUpdate() const;
43  virtual void setLastUpdate( const DtTime& tm );
44 
45  virtual DtTime firstUpdate() const;
46  virtual void setFirstUpdate( const DtTime& tm );
47 
48  virtual bool isPublishable() const;
49  virtual void setIsPublishable( bool val );
50 
51  virtual bool isDiscovered() const;
52  virtual void setIsDiscovered( bool val );
53 
54  virtual bool isDropped() const;
55  virtual void setIsDropped( bool val );
56 
57  virtual const DtString& dropReason() const;
58  virtual void setDropReason( const DtString& reason );
59 
60  virtual bool isFiltered() const;
61  virtual void setIsFiltered( bool val );
62 
63  virtual const DtString& translatorName() const;
64  virtual void setTranslatorName( const DtString& name );
65 
66  virtual const DtString& objectName() const;
67  virtual void setObjectName( const DtString& name );
68 
69  virtual const DtString& objectId() const;
70  virtual void setObjectId( const DtString& id );
71 
72  virtual const DtString& markingText() const;
73  virtual void setMarkingText( const DtString& name );
74 
75  virtual const DtEntityType& entityType() const;
76  virtual void setEntityType( const DtEntityType& type );
77 
78  virtual void setBrokerData( int key, const DtString& data );
79  virtual DtString brokerData( int key ) const;
80 
81  virtual void setBrokerDataPtr( int key, void* data );
82  virtual void* brokerDataPtr( int key ) const;
83 
84  private:
85 
87  DtBrokerObject( const DtBrokerObject& other );
88 
90  DtBrokerObject& operator = ( const DtBrokerObject& other );
91 
92  protected:
93 
94  typedef std::map<int,void*> BrokerDataPtrMap;
96 
97  typedef std::map<int,DtString> BrokerDataMap;
99 
101  const void* myReflectedObjPtr;
102 
103  DtTime myLastUpdate;
105 
108 
112 
115 
118 
121 
128  DtEntityType myEntityType;
129 
130  };
131 
132 }
DtTime myLastUpdate
Definition: brokerObject.h:103
void * myPublisherPtr
Definition: brokerObject.h:100
DtString myStatus
Definition: brokerObject.h:123
bool myDroppedFlag
Set when this object has been dropped by the broker for some reason.
Definition: brokerObject.h:114
Provides container to hold pointers to Protocol/Portal objects.
Definition: brokerObject.h:24
DtString myDropReason
Definition: brokerObject.h:124
std::map< int, DtString > BrokerDataMap
Definition: brokerObject.h:97
std::map< int, void * > BrokerDataPtrMap
Definition: brokerObject.h:94
#define DT_DLL_BROKER
Definition: include/broker/dllExport.h:20
BrokerDataMap myBrokerDataMap
Definition: brokerObject.h:98
const void * myReflectedObjPtr
Definition: brokerObject.h:101
bool myIsPortalObjectFlag
Indicates whether this object is from the portal or not.
Definition: brokerObject.h:120
DtTime myFirstUpdate
Definition: brokerObject.h:104
DtString myTranslatorName
Definition: brokerObject.h:122
DtString myMarkingText
Definition: brokerObject.h:127
bool myDiscoveredFlag
MyDiscovered flag is always true but will be toggled to false IF a discovery criteria method rejects ...
Definition: brokerObject.h:111
DtString myObjectId
Definition: brokerObject.h:126
DtString myObjectName
Definition: brokerObject.h:125
bool myPublishableFlag
myPublishableFlag is set to false until its its found to be publishable
Definition: brokerObject.h:107
BrokerDataPtrMap myBrokerDataPtrMap
Definition: brokerObject.h:95
bool myFilteredFlag
Set when this object has been filtered by the broker for some reason.
Definition: brokerObject.h:117
DtEntityType myEntityType
Definition: brokerObject.h:128

Document ID: Generated on Tue Jun 25 16:45:35 EDT 2024 from SVN revision 267383
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)