WebLVC 1.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 MAK Technologies, Inc.
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 
147  virtual bool usePerfCounter() const;
148  virtual void setUsePerfCounter(bool);
149 
152  virtual int attributePduStrategy() const;
153  virtual void setAttributePduStrategy( int );
154 
156  virtual double locationThreshold() const;
157  virtual void setLocationThreshold( double );
158 
160  virtual double rotationThreshold() const;
161  virtual void setRotationThreshold( double );
162 
164  virtual int protocolVersionToSend() const;
165  virtual void setProtocolVersionToSend( int );
166 
169  virtual int protocolVersionToRecvMin() const;
170  virtual void setProtocolVersionToRecvMin( int );
171 
174  virtual int protocolVersionToRecvMax() const;
175  virtual void setProtocolVersionToRecvMax( int );
176 
178  virtual bool disableArticulatedParts() const;
179  virtual void setDisableArticulatedParts( bool );
180 
182  virtual bool splitUnderwaterAcousticPdus() const;
183  virtual void setSplitUnderwaterAcousticPdus( bool );
184 
185  // Returns whether or not to send DI-Guy information
186  virtual bool sendDiGuyInformation() const;
187  virtual void setSendDiGuyInformation( bool );
188 
190  virtual bool sendSeesPdus() const;
191  virtual void setSendSeesPdus( bool );
192 
194  virtual bool sendRelativeLocationPdus() const;
195  virtual void setSendRelativeLocationPdus( bool );
196 
198 
201 
204  virtual bool debugGlobalIdMapping() const;
205  virtual void setDebugGlobalIdMapping( bool );
206 
209  virtual bool debugEntityIdMapping() const;
210  virtual void setDebugEntityIdMapping( bool );
211 
214  virtual bool debugEventIdMapping() const;
215  virtual void setDebugEventIdMapping( bool );
216 
217  virtual bool dumpGuiToText() const;
218  virtual void setDumpGuiToText( bool );
219 
221 
224 
229  virtual DtTime heartbeatInterval() const;
230  virtual void setHeartbeatInterval( DtTime );
231 
236  virtual DtTime timeoutInterval() const;
237  virtual void setTimeoutInterval( DtTime );
238 
243  virtual DtTime drainTimeout() const;
244  virtual void setDrainTimeout( DtTime );
245 
247  virtual int numPdusReadPerTimeCheck() const;
248  virtual void setNumPdusReadPerTimeCheck( int );
249 
251 
252  protected:
253 
256 
260  DtConfigVariable<int> myDisPort;
261 
265  DtConfigVariable<int> myExerciseId;
266 
272  DtConfigVariable<DtString> myDestinationAddress;
273 
279  DtConfigVariable<DtString> myDeviceAddress;
280 
285  DtConfigVariable<DtString> mySubnetMask;
286 
290  DtMultiConfigVariable<DtString> myMcastSubscriptionSet;
291 
296  DtConfigVariable<int> mySocketSendBufferSize;
297 
303  DtConfigVariable<int> mySocketReceiveBufferSize;
304 
308  DtConfigVariable<int> myMulticastTimeToLive;
309 
311 
314 
319  DtConfigVariable<int> myParseUnknownIdsFlag;
320 
325  DtConfigVariable<int> myRemapDisIds;
326 
332  DtConfigVariable<int> myUsePersistentEntityIds;
333 
337  DtConfigVariable<DtTime> myInteractionWaitListTimeout;
338 
342  DtConfigVariable<bool> mySendExpiredWaitListInteractions;
343 
347  DtConfigVariable<int> myApplicationNumber;
348 
352  DtConfigVariable<int> mySiteId;
353 
358  DtConfigVariable<int> myUseAbsoluteTimeStamping;
359 
364  DtConfigVariable<bool> myUsePerfCounter;
365 
371  DtConfigVariable<int> myAttributePduStrategy;
372 
375  DtConfigVariable<double> myLocationThreshold;
376 
379  DtConfigVariable<double> myRotationThreshold;
380 
384  DtConfigVariable<int> myProtocolVersionToSend;
385 
389  DtConfigVariable<int> myProtocolVersionToRecvMin;
390 
394  DtConfigVariable<int> myProtocolVersionToRecvMax;
395 
397  DtConfigVariable<bool> myDisableArticulatedParts;
398 
403  DtConfigVariable<bool> mySplitUnderwaterAcousticPdus;
404 
407  DtConfigVariable<bool> mySendDiGuyInformation;
408 
411  DtConfigVariable<bool> mySendSeesPdus;
412 
415  DtConfigVariable<bool> mySendRelativeLocationPdus;
416 
418 
421 
426  DtConfigVariable<int> myDebugGlobalIdMapping;
427 
432  DtConfigVariable<int> myDebugEntityIdMapping;
433 
438  DtConfigVariable<int> myDebugEventIdMapping;
439 
444  DtConfigVariable<int> myDumpGuiToText;
445 
447 
450 
454  DtConfigVariable<DtTime> myHeartbeatInterval;
455 
459  DtConfigVariable<DtTime> myTimeoutInterval;
460 
464  DtConfigVariable<DtTime> myDrainTimeout;
465 
469  DtConfigVariable<int> myNumPdusReadPerTimeCheck;
470 
472 
478 
481 
482  };
483 
484  }
485 }
DtConfigVariable< DtTime > myInteractionWaitListTimeout
The amount of time to wait for valid ID mappings for interactions.
Definition: disBrokerInitializer.h:337
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:469
DtVariableGroup myDiscoverableCriteriaGroup
Discoverable Criteria As defined by disDiscoverableCriteria.h, this contains the requirements for spe...
Definition: disBrokerInitializer.h:477
DtConfigVariable< int > myProtocolVersionToRecvMax
The maximum DIS protocol version to receive and process.
Definition: disBrokerInitializer.h:394
DtConfigVariable< bool > mySendRelativeLocationPdus
If enabled, outgoing entities and aggregates will publish relative location PDUs if they have a host ...
Definition: disBrokerInitializer.h:415
DtConfigVariable< int > myProtocolVersionToRecvMin
The minimum DIS protocol version to receive and process.
Definition: disBrokerInitializer.h:389
DtConfigVariable< int > mySocketReceiveBufferSize
The size of the receive socket buffer Specified by &quot;socketReceiveBufferSize&quot; in the MTL file...
Definition: disBrokerInitializer.h:303
DtConfigVariable< int > myMulticastTimeToLive
The time to live if using multicast.
Definition: disBrokerInitializer.h:308
DtConfigVariable< DtString > myDeviceAddress
The device address that the broker should use to send PDU&#39;s.
Definition: disBrokerInitializer.h:279
DtConfigVariable< int > myExerciseId
The exercise ID used by the broker.
Definition: disBrokerInitializer.h:265
DtConfigVariable< int > myDumpGuiToText
If enabled will print a line to the log file for every object update, creation and destruction...
Definition: disBrokerInitializer.h:444
DtConfigVariable< double > myLocationThreshold
The location threshold for determining when updates should be sent.
Definition: disBrokerInitializer.h:375
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:454
DtMultiConfigVariable< DtString > myMcastSubscriptionSet
The multicast addresses to subscribe to.
Definition: disBrokerInitializer.h:290
Contains the DtBrokerInitializer class declaration.
DtConfigVariable< bool > myDisableArticulatedParts
Disable Articulated Parts translating flag.
Definition: disBrokerInitializer.h:397
DtConfigVariable< bool > mySendExpiredWaitListInteractions
Whether or not to send interactions from the wait list.
Definition: disBrokerInitializer.h:342
Contains the DtDisDiscoverableCriteria class declaration.
DtConfigVariable< int > myApplicationNumber
The application number used by the broker.
Definition: disBrokerInitializer.h:347
DtConfigVariable< int > mySocketSendBufferSize
Specified by &quot;socketSendBufferSize&quot; in the MTL file.
Definition: disBrokerInitializer.h:296
DtConfigVariable< int > myUseAbsoluteTimeStamping
Specifies whether the broker should use absolute time-stamping Specified by &quot;timeStampAbsolute&quot; in th...
Definition: disBrokerInitializer.h:358
DtConfigVariable< int > myAttributePduStrategy
Specifies whether the broker should drop (1), couple (2 [default]), de-couple (3) or de-couple + send...
Definition: disBrokerInitializer.h:371
DtConfigVariable< DtTime > myTimeoutInterval
The time it takes to timeout a remote DIS object.
Definition: disBrokerInitializer.h:459
DtConfigVariable< int > myDebugEntityIdMapping
Specifies whether the DtEntityIdMapper should print out debug statements.
Definition: disBrokerInitializer.h:432
DtConfigVariable< bool > mySplitUnderwaterAcousticPdus
If enabled, underwater acoustic objects will always be published in separate PDUs.
Definition: disBrokerInitializer.h:403
DtConfigVariable< int > myParseUnknownIdsFlag
Specifies whether the broker should parse unknown IDs.
Definition: disBrokerInitializer.h:319
DtConfigVariable< int > myDebugEventIdMapping
Specifies whether the DtEventIdMapper should print out debug statements.
Definition: disBrokerInitializer.h:438
DtConfigVariable< int > myUsePersistentEntityIds
Specifies whether the broker should keep remap DIS ID&#39;s from session to session.
Definition: disBrokerInitializer.h:332
DtConfigVariable< double > myRotationThreshold
The rotation threshold for determining when updates should be sent.
Definition: disBrokerInitializer.h:379
DtConfigVariable< DtTime > myDrainTimeout
Specifies the amount time to read from the network Specified by &quot;drainTimeout&quot; in the MTL file...
Definition: disBrokerInitializer.h:464
DtConfigVariable< int > myRemapDisIds
Specifies whether the broker should remap DIS ID&#39;s.
Definition: disBrokerInitializer.h:325
DtConfigVariable< DtString > mySubnetMask
The network mask or prefix length to use.
Definition: disBrokerInitializer.h:285
DtConfigVariable< bool > mySendDiGuyInformation
If enabled, outgoing DI-Guy entities will publish DI-Guy PDUs containing additional DI-Guy informatio...
Definition: disBrokerInitializer.h:407
#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:260
DtConfigVariable< DtString > myDestinationAddress
The network address to send DIS PDU&#39;s to.
Definition: disBrokerInitializer.h:272
DtConfigVariable< bool > mySendSeesPdus
If enabled, outgoing entities will publish SEES PDUs containing additional emissions information...
Definition: disBrokerInitializer.h:411
DtConfigVariable< bool > myUsePerfCounter
Specifies whether the broker should use the performance counter Specified by &quot;perfCounter&quot; in the MTL...
Definition: disBrokerInitializer.h:364
DtConfigVariable< int > mySiteId
The site ID used by the broker.
Definition: disBrokerInitializer.h:352
DtConfigVariable< int > myDebugGlobalIdMapping
Specifies whether the DtGlobalIdMapper should print out debug statements.
Definition: disBrokerInitializer.h:426
DtDisDiscoverableCriteria * myDiscoverableCriteria
Helper class that manages discoverable criteria.
Definition: disBrokerInitializer.h:480
DtConfigVariable< int > myProtocolVersionToSend
The DIS protocol version to send PDU&#39;s as.
Definition: disBrokerInitializer.h:384
Provides initialization parameters to the DIS Broker.
Definition: disBrokerInitializer.h:26

Document ID: Generated on Wed Mar 12 15:05:17 EDT 2025 from SVN revision 274272
Copyright © 2005-2025 MAK Technologies. All Rights Reserved (www.mak.com)