VR-Exchange 2.8 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
disBrokerInitializer.h
Go to the documentation of this file.
1 /****************************************************************************
2  * Copyright (c) 2015 VT MAK
3  * All rights reserved.
4  ****************************************************************************/
5 
9 
10 #pragma once
11 
14 #include <mtl/multiConfigVariable.h>
15 #include <vlutil/vlTime.h>
16 
17 namespace MAKVrExchange
18 {
19 
20  namespace DtDisBroker
21  {
22 
27  {
28  public:
29 
31  DtDisBrokerInitializer( int argc = 0, char** argv = 0,
32  const char* versionString = "1.0" );
33 
36 
38  virtual ~DtDisBrokerInitializer();
39 
41  DtDisBrokerInitializer& operator = ( const DtDisBrokerInitializer& other );
42 
45  virtual DtDisBrokerInitializer* clone() const;
46 
47  virtual DtDisDiscoverableCriteria* discoveryCriteria();
48 
51 
55  virtual int disPort() const;
56  virtual void setDisPort( int );
57 
59  virtual int exerciseId() const;
60  virtual void setExerciseId( int );
61 
63  virtual DtString destinationAddress() const;
64  virtual void setDestinationAddress( const DtString& );
65 
67  virtual DtString deviceAddress() const;
68  virtual void setDeviceAddress( const DtString& );
69 
74  virtual DtString subnetMask() const;
75  virtual void setSubnetMask( const DtString& );
76 
79  const std::vector<DtString>& mcastSubscriptionSet() const;
80  virtual void setMcastSubscriptionSet( const std::vector<DtString>& );
81  virtual void addMcastSubscriptionAddr( const DtString& addr );
82 
85  virtual int socketSendBufferSize() const;
86  virtual void setSocketSendBufferSize( int );
87 
90  virtual int socketReceiveBufferSize() const;
91  virtual void setSocketReceiveBufferSize( int );
92 
94  virtual int multicastTimeToLive() const;
95  virtual void setMulticastTimeToLive( int );
96 
98 
101 
105  virtual bool parseUnknownIds() const;
106  virtual void setParseUnknownIds( bool );
107 
114  virtual bool remapDisIds() const;
115  virtual void setRemapDisIds( bool );
116 
120  virtual bool usePersistentEntityIds() const;
121  virtual void setUsePersistentEntityIds( bool );
122 
124  virtual DtTime interactionWaitListTimeout() const;
125  virtual void setInteractionWaitListTimeout( DtTime );
126 
128  virtual bool sendExpiredWaitListInteractions() const;
129  virtual void setSendExpiredWaitListInteractions( bool );
130 
133  virtual int applicationNumber() const;
134  virtual void setApplicationNumber( int );
135 
137  virtual int siteId() const;
138  virtual void setSiteId( int );
139 
142  virtual bool useAbsoluteTimeStamping() const;
143  virtual void setUseAbsoluteTimeStamping( bool );
144 
146  virtual double locationThreshold() const;
147  virtual void setLocationThreshold( double );
148 
150  virtual double rotationThreshold() const;
151  virtual void setRotationThreshold( double );
152 
154  virtual int protocolVersionToSend() const;
155  virtual void setProtocolVersionToSend( int );
156 
159  virtual int protocolVersionToRecvMin() const;
160  virtual void setProtocolVersionToRecvMin( int );
161 
164  virtual int protocolVersionToRecvMax() const;
165  virtual void setProtocolVersionToRecvMax( int );
166 
168  virtual bool disableArticulatedParts() const;
169  virtual void setDisableArticulatedParts( bool );
170 
172  virtual bool splitUnderwaterAcousticPdus() const;
173  virtual void setSplitUnderwaterAcousticPdus( bool );
174 
176  virtual bool sendDiGuyPdus() const;
177  virtual void setSendDiGuyPdus( bool );
178 
180  virtual bool sendSeesPdus() const;
181  virtual void setSendSeesPdus( bool );
182 
184  virtual bool sendRelativeLocationPdus() const;
185  virtual void setSendRelativeLocationPdus( bool );
186 
188 
191 
194  virtual bool debugGlobalIdMapping() const;
195  virtual void setDebugGlobalIdMapping( bool );
196 
199  virtual bool debugEntityIdMapping() const;
200  virtual void setDebugEntityIdMapping( bool );
201 
204  virtual bool debugEventIdMapping() const;
205  virtual void setDebugEventIdMapping( bool );
206 
207  virtual bool dumpGuiToText() const;
208  virtual void setDumpGuiToText( bool );
209 
211 
214 
219  virtual DtTime heartbeatInterval() const;
220  virtual void setHeartbeatInterval( DtTime );
221 
226  virtual DtTime timeoutInterval() const;
227  virtual void setTimeoutInterval( DtTime );
228 
233  virtual DtTime drainTimeout() const;
234  virtual void setDrainTimeout( DtTime );
235 
237  virtual int numPdusReadPerTimeCheck() const;
238  virtual void setNumPdusReadPerTimeCheck( int );
239 
241 
242  protected:
243 
246 
250  DtConfigVariable<int> myDisPort;
251 
255  DtConfigVariable<int> myExerciseId;
256 
262  DtConfigVariable<DtString> myDestinationAddress;
263 
269  DtConfigVariable<DtString> myDeviceAddress;
270 
275  DtConfigVariable<DtString> mySubnetMask;
276 
280  DtMultiConfigVariable<DtString> myMcastSubscriptionSet;
281 
286  DtConfigVariable<int> mySocketSendBufferSize;
287 
293  DtConfigVariable<int> mySocketReceiveBufferSize;
294 
298  DtConfigVariable<int> myMulticastTimeToLive;
299 
301 
304 
309  DtConfigVariable<int> myParseUnknownIdsFlag;
310 
315  DtConfigVariable<int> myRemapDisIds;
316 
322  DtConfigVariable<int> myUsePersistentEntityIds;
323 
327  DtConfigVariable<DtTime> myInteractionWaitListTimeout;
328 
332  DtConfigVariable<bool> mySendExpiredWaitListInteractions;
333 
337  DtConfigVariable<int> myApplicationNumber;
338 
342  DtConfigVariable<int> mySiteId;
343 
348  DtConfigVariable<int> myUseAbsoluteTimeStamping;
349 
352  DtConfigVariable<double> myLocationThreshold;
353 
356  DtConfigVariable<double> myRotationThreshold;
357 
361  DtConfigVariable<int> myProtocolVersionToSend;
362 
366  DtConfigVariable<int> myProtocolVersionToRecvMin;
367 
371  DtConfigVariable<int> myProtocolVersionToRecvMax;
372 
374  DtConfigVariable<bool> myDisableArticulatedParts;
375 
380  DtConfigVariable<bool> mySplitUnderwaterAcousticPdus;
381 
384  DtConfigVariable<bool> mySendDiGuyPdus;
385 
388  DtConfigVariable<bool> mySendSeesPdus;
389 
392  DtConfigVariable<bool> mySendRelativeLocationPdus;
393 
395 
398 
403  DtConfigVariable<int> myDebugGlobalIdMapping;
404 
409  DtConfigVariable<int> myDebugEntityIdMapping;
410 
415  DtConfigVariable<int> myDebugEventIdMapping;
416 
421  DtConfigVariable<int> myDumpGuiToText;
422 
424 
427 
431  DtConfigVariable<DtTime> myHeartbeatInterval;
432 
436  DtConfigVariable<DtTime> myTimeoutInterval;
437 
441  DtConfigVariable<DtTime> myDrainTimeout;
442 
446  DtConfigVariable<int> myNumPdusReadPerTimeCheck;
447 
449 
455 
458 
459  };
460 
461  }
462 }
DtConfigVariable< DtTime > myInteractionWaitListTimeout
The amount of time to wait for valid ID mappings for interactions.
Definition: disBrokerInitializer.h:327
A class to initialize DtBroker instances.
Definition: brokerInitializer.h:35
DtConfigVariable< int > myNumPdusReadPerTimeCheck
The max number of PDU&#39;s to read per drain.
Definition: disBrokerInitializer.h:446
DtVariableGroup myDiscoverableCriteriaGroup
Discoverable Criteria As defined by disDiscoverableCriteria.h, this contains the requirements for spe...
Definition: disBrokerInitializer.h:454
DtConfigVariable< bool > mySendDiGuyPdus
If enabled, outgoing DI-Guy entities will publish DI-Guy PDUs containing additional DI-Guy informatio...
Definition: disBrokerInitializer.h:384
DtConfigVariable< int > myProtocolVersionToRecvMax
The maximum DIS protocol version to receive and process.
Definition: disBrokerInitializer.h:371
DtConfigVariable< bool > mySendRelativeLocationPdus
If enabled, outgoing entities and aggregates will publish relative location PDUs if they have a host ...
Definition: disBrokerInitializer.h:392
DtConfigVariable< int > myProtocolVersionToRecvMin
The minimum DIS protocol version to receive and process.
Definition: disBrokerInitializer.h:366
DtConfigVariable< int > mySocketReceiveBufferSize
The size of the receive socket buffer Specified by &quot;socketReceiveBufferSize&quot; in the MTL file...
Definition: disBrokerInitializer.h:293
DtConfigVariable< int > myMulticastTimeToLive
The time to live if using multicast.
Definition: disBrokerInitializer.h:298
DtConfigVariable< DtString > myDeviceAddress
The device address that the broker should use to send PDU&#39;s.
Definition: disBrokerInitializer.h:269
DtConfigVariable< int > myExerciseId
The exercise ID used by the broker.
Definition: disBrokerInitializer.h:255
DtConfigVariable< int > myDumpGuiToText
If enabled will print a line to the log file for every object update, creation and destruction...
Definition: disBrokerInitializer.h:421
DtConfigVariable< double > myLocationThreshold
The location threshold for determining when updates should be sent.
Definition: disBrokerInitializer.h:352
Provides discoverable criteria initialization parameters to the DIS Broker.
Definition: disDiscoverableCriteria.h:25
DtConfigVariable< DtTime > myHeartbeatInterval
The interval at which DIS objects are &quot;heartbeated&quot;.
Definition: disBrokerInitializer.h:431
DtMultiConfigVariable< DtString > myMcastSubscriptionSet
The multicast addresses to subscribe to.
Definition: disBrokerInitializer.h:280
Contains the DtBrokerInitializer class declaration.
DtConfigVariable< bool > myDisableArticulatedParts
Disable Articulated Parts translating flag.
Definition: disBrokerInitializer.h:374
DtConfigVariable< bool > mySendExpiredWaitListInteractions
Whether or not to send interactions from the wait list.
Definition: disBrokerInitializer.h:332
Contains the DtDisDiscoverableCriteria class declaration.
DtConfigVariable< int > myApplicationNumber
The application number used by the broker.
Definition: disBrokerInitializer.h:337
DtConfigVariable< int > mySocketSendBufferSize
Specified by &quot;socketSendBufferSize&quot; in the MTL file.
Definition: disBrokerInitializer.h:286
DtConfigVariable< int > myUseAbsoluteTimeStamping
Specifies whether the broker should use absolute time-stamping Specified by &quot;timeStampAbsolute&quot; in th...
Definition: disBrokerInitializer.h:348
DtConfigVariable< DtTime > myTimeoutInterval
The time it takes to timeout a remote DIS object.
Definition: disBrokerInitializer.h:436
DtConfigVariable< int > myDebugEntityIdMapping
Specifies whether the DtEntityIdMapper should print out debug statements.
Definition: disBrokerInitializer.h:409
DtConfigVariable< bool > mySplitUnderwaterAcousticPdus
If enabled, underwater acoustic objects will always be published in separate PDUs.
Definition: disBrokerInitializer.h:380
DtConfigVariable< int > myParseUnknownIdsFlag
Specifies whether the broker should parse unknown IDs.
Definition: disBrokerInitializer.h:309
DtConfigVariable< int > myDebugEventIdMapping
Specifies whether the DtEventIdMapper should print out debug statements.
Definition: disBrokerInitializer.h:415
DtConfigVariable< int > myUsePersistentEntityIds
Specifies whether the broker should keep remap DIS ID&#39;s from session to session.
Definition: disBrokerInitializer.h:322
DtConfigVariable< double > myRotationThreshold
The rotation threshold for determining when updates should be sent.
Definition: disBrokerInitializer.h:356
DtConfigVariable< DtTime > myDrainTimeout
Specifies the amount time to read from the network Specified by &quot;drainTimeout&quot; in the MTL file...
Definition: disBrokerInitializer.h:441
DtConfigVariable< int > myRemapDisIds
Specifies whether the broker should remap DIS ID&#39;s.
Definition: disBrokerInitializer.h:315
DtConfigVariable< DtString > mySubnetMask
The network mask or prefix length to use.
Definition: disBrokerInitializer.h:275
#define DT_DLL_DISBROKER
Definition: brokers/disBroker/disBroker/dllExport.h:20
DtConfigVariable< int > myDisPort
The port number used to receive DIS PDU&#39;s.
Definition: disBrokerInitializer.h:250
DtConfigVariable< DtString > myDestinationAddress
The network address to send DIS PDU&#39;s to.
Definition: disBrokerInitializer.h:262
DtConfigVariable< bool > mySendSeesPdus
If enabled, outgoing entities will publish SEES PDUs containing additional emissions information...
Definition: disBrokerInitializer.h:388
DtConfigVariable< int > mySiteId
The site ID used by the broker.
Definition: disBrokerInitializer.h:342
DtConfigVariable< int > myDebugGlobalIdMapping
Specifies whether the DtGlobalIdMapper should print out debug statements.
Definition: disBrokerInitializer.h:403
DtDisDiscoverableCriteria * myDiscoverableCriteria
Helper class that manages discoverable criteria.
Definition: disBrokerInitializer.h:457
DtConfigVariable< int > myProtocolVersionToSend
The DIS protocol version to send PDU&#39;s as.
Definition: disBrokerInitializer.h:361
Provides initialization parameters to the DIS Broker.
Definition: disBrokerInitializer.h:26

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)