VR-Exchange 2.10 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
brokerInitializer.h
Go to the documentation of this file.
1 /****************************************************************************
2  * Copyright (c) 2016 MAK Technologies, Inc.
3  * All rights reserved.
4  ****************************************************************************/
5 
9 
10 #pragma once
11 
12 #include <broker/dllExport.h>
13 #include <broker/objectFilter.h>
15 #include <mtl/applicationSettings.h>
16 #include <mtl/multiConfigVariable.h>
17 #include <mtl/mtlEnvironment.h>
18 #include <mtl/configVariable.h>
19 
20 namespace MAKVrExchange
21 {
22 
36  {
37  public:
38 
41  DtBrokerInitializer( int argc, char** argv, const char* version );
42 
45 
47  virtual ~DtBrokerInitializer();
48 
50  DtBrokerInitializer& operator = ( const DtBrokerInitializer& other );
51 
54  virtual DtBrokerInitializer* clone() const;
55 
56  public:
57 
59  //
65  virtual void parseCmdLine();
66 
68  virtual void loadFile();
69  virtual void loadFile( const DtString& fileName );
70 
72  virtual bool saveFile();
73  virtual bool saveFile( const DtString& fileName );
74 
76  virtual DtString brokerName() const;
77 
79  virtual DtString programName() const;
80 
82  virtual int notifyLevel() const;
83  virtual void setNotifyLevel( int nl );
84 
87  virtual DtString logFileName() const;
88  virtual void setLogFileName( const DtString& lfn );
89 
91  virtual bool isLogTimestampingEnabled() const;
92  virtual void setLogTimestampingEnabled( bool timestamp );
93 
96  virtual int logRollingInterval() const;
97  virtual void setLogRollingInterval( int intervalInSeconds );
98 
100  virtual DtTime lockFailureTimeout() const;
101  virtual void setLockFailureTimeout( DtTime timeInSeconds );
102 
104  virtual DtString pluginDirectory() const;
105  virtual void setPluginDirectory( const DtString& lfn );
106 
108  virtual bool loadVrfPlugins() const;
109  virtual void setloadVrfPlugins(bool val);
110 
112  virtual DtString vrfVersion() const;
113  virtual void setVrfVersion( const DtString& version );
114 
116  virtual int maxControlMessages() const;
117  virtual void setMaxControlMessages( int mcm );
118 
120  virtual int maxInteractionMessages() const;
121  virtual void setMaxInteractionMessages( int mim );
122 
124  virtual int maxObjectMessages() const;
125  virtual void setMaxObjectMessages( int mom );
126 
129  virtual int pollingInterval() const;
130  virtual void setPollingInterval( int pi );
131 
133  virtual DtTime locationFilteringInterval() const;
134  virtual void setLocationFilteringInterval( DtTime t );
135 
137  virtual DtTime statisticsReportingInterval() const;
138  virtual void setStatisticsReportingInterval( DtTime si );
139 
141  virtual bool printStatistics() const;
142  virtual void setPrintStatistics( bool val );
143 
147  virtual int tcpPort() const;
148  virtual void setTcpPort( int port );
149 
152  virtual bool dumpEnvironment() const;
153  virtual void setDumpEnvironment( bool shouldDumpEnv );
154 
157  virtual DtString controlQueueName() const;
158  virtual DtString interactionQueueName() const;
159  virtual DtString objectQueueName() const;
160 
162  virtual bool oneToOneMapping() const;
163  virtual void setOneToOneMapping( bool val );
164 
171  virtual const std::vector<DtString>& debuggedTranslators() const;
172  virtual void addDebuggedTranslator( const DtString& );
173  virtual void removeDebuggedTranslator( const DtString& );
174  virtual void setDebuggedTranslators( const std::set<DtString>& debuggedSet );
175 
176 
183  virtual const std::vector<DtString>& disablePublishTranslatorSet() const;
184  virtual void addDisablePublishTranslator( const DtString& );
185  virtual void removeDisablePublishTranslator( const DtString& );
186  virtual void setDisablePublishTranslators( const std::set<DtString>& disabledSet );
187 
194  virtual const std::vector<DtString>& disableReflectTranslatorSet() const;
195  virtual void addDisableReflectTranslator( const DtString& );
196  virtual void removeDisableReflectTranslator( const DtString& );
197  virtual void setDisableReflectTranslators( const std::set<DtString>& disableSet );
198 
201  bool useGui() const;
202 
205  bool showConnectionInfoDialog() const;
206 
208  int& argc();
209 
211  char** argv();
212 
213  virtual void addObjectFilter( const DtObjectFilter& filter );
214  virtual void removeObjectFilter( const DtObjectFilter& filter );
215 
216  virtual void setNameFilters( const std::vector<DtString>& filters );
217  virtual const std::vector<DtString>& nameFilters() const;
218 
219  virtual void setTypeFilters( const std::vector<DtString>& filters );
220  virtual const std::vector<DtString>& typeFilters() const;
221 
222  virtual void setMarkingFilters( const std::vector<DtString>& filters );
223  virtual const std::vector<DtString>& markingFilters() const;
224 
225  virtual void setGeoLocationFilters( const std::vector<DtGeoLocationFilter>& filters );
226  virtual const std::vector<DtGeoLocationFilter>& geoLocationFilters() const;
227 
228  virtual void setDarkModeEnabled( int val );
229  virtual int darkModeEnabled();
230 
232  virtual DtString fileName() const;
233 
235  virtual DtString qtTranslatorLocale();
236 
237  protected:
238 
239  int myArgc;
240  char** myArgv;
243 
244  DtApplicationSettings mySettings;
245 
246  DtConfigVariable<bool> myShowInfoDialogFlag;
247 
248  DtConfigVariable<DtString> myMtlFileName;
249  DtConfigVariable<DtString> myCmdLineBrokerName;
250  DtConfigVariable<int> myCmdLineTcpPort;
251  DtConfigVariable<int> myCmdLineNotifyLevel;
252  DtConfigVariable<bool> myCmdLineDumpEnvFlag;
253 
254  DtConfigVariable<bool> myUseGuiFlag;
255  DtConfigVariable<DtString> myLogFileName;
256  DtConfigVariable<bool> myLogTimestampingEnabled;
257  DtConfigVariable<int> myLogRollingInterval;
258  DtConfigVariable<DtTime> myLockFailureTimeout;
259  DtConfigVariable<DtString> myPluginDirectory;
260  DtConfigVariable<bool> myloadVrfPluginsFlag; //OTF 4967
261  DtConfigVariable<DtString> myVrfVersion;
262  DtConfigVariable<DtString> myControlQueueName;
263  DtConfigVariable<DtString> myInteractionQueueName;
264  DtConfigVariable<DtString> myObjectQueueName;
265  DtConfigVariable<bool> myOneToOneTranslation;
266  DtConfigVariable<int> myMaxControlMessages;
267  DtConfigVariable<int> myMaxInterMessages;
268  DtConfigVariable<int> myMaxObjectMessages;
269  DtConfigVariable<int> myPollingInterval;
270  DtConfigVariable<DtTime> myLocationFilteringInterval;
271  DtConfigVariable<DtTime> myStatisticsReportingInterval;
272  DtConfigVariable<bool> myPrintStatisticsFlag;
273  DtMultiConfigVariable<DtString> myDebuggedTranslators;
274  DtMultiConfigVariable<DtString> myDisablePublishTranslators;
275  DtMultiConfigVariable<DtString> myDisableReflectTranslators;
276  DtConfigVariable<DtString> myQtTranslatorLocale;
277 
278  //Int value for dark mode.
279  DtConfigVariable<int> myDarkModeEnabled;
280 
281  DtVariableGroup myObjectFiltersGroup;
282  DtMultiConfigVariable<DtString> myObjectNameFilters;
283  DtMultiConfigVariable<DtString> myObjectTypeFilters;
284  DtMultiConfigVariable<DtString> myObjectMarkingFilters;
285  DtMultiConfigVariable<DtGeoLocationFilter> myObjectGeoLocationFilters;
286 // DtMultiConfigVariable<DtGeoRegionFilter> myObjectGeoRegionFilters;
287 // DtMultiConfigVariable<DtGeoEntityFilter> myObjectGeoEntityFilters;
288 
289  };
290 
291 
292  inline const std::vector<DtString>& DtBrokerInitializer::nameFilters() const
293  {
294  return myObjectNameFilters.values();
295  }
296 
297  inline const std::vector<DtString>& DtBrokerInitializer::typeFilters() const
298  {
299  return myObjectTypeFilters.values();
300  }
301 
302  inline const std::vector<DtString>& DtBrokerInitializer::markingFilters() const
303  {
304  return myObjectMarkingFilters.values();
305  }
306 
307  inline const std::vector<DtGeoLocationFilter>& DtBrokerInitializer::geoLocationFilters() const
308  {
309  return myObjectGeoLocationFilters.values();
310  }
311 
313  {
314  return myMtlFileName.value();
315  }
316 
317 }
DtConfigVariable< DtTime > myLockFailureTimeout
Definition: brokerInitializer.h:258
DtString myVersionString
Definition: brokerInitializer.h:242
DtConfigVariable< int > myPollingInterval
Definition: brokerInitializer.h:269
DtConfigVariable< DtTime > myStatisticsReportingInterval
Definition: brokerInitializer.h:271
DtConfigVariable< int > myMaxControlMessages
Definition: brokerInitializer.h:266
A class to initialize DtBroker instances.
Definition: brokerInitializer.h:35
DtConfigVariable< DtString > myVrfVersion
Definition: brokerInitializer.h:261
DtConfigVariable< int > myLogRollingInterval
Definition: brokerInitializer.h:257
Contains the DtObjectFilter class declaration.
DtConfigVariable< int > myDarkModeEnabled
Definition: brokerInitializer.h:279
DtConfigVariable< bool > myLogTimestampingEnabled
Definition: brokerInitializer.h:256
DtConfigVariable< DtString > myQtTranslatorLocale
Definition: brokerInitializer.h:276
DtApplicationSettings mySettings
Definition: brokerInitializer.h:244
DtConfigVariable< bool > myPrintStatisticsFlag
Definition: brokerInitializer.h:272
DtConfigVariable< int > myMaxObjectMessages
Definition: brokerInitializer.h:268
int myArgc
Definition: brokerInitializer.h:239
DtConfigVariable< int > myCmdLineTcpPort
Definition: brokerInitializer.h:250
DtMultiConfigVariable< DtString > myObjectMarkingFilters
Definition: brokerInitializer.h:284
Stores the type and filter string for an individual filter.
Definition: objectFilter.h:20
DtConfigVariable< bool > myShowInfoDialogFlag
Definition: brokerInitializer.h:246
virtual const std::vector< DtString > & markingFilters() const
Definition: brokerInitializer.h:302
DtConfigVariable< DtString > myMtlFileName
Definition: brokerInitializer.h:248
DtMultiConfigVariable< DtString > myDebuggedTranslators
Definition: brokerInitializer.h:273
DtConfigVariable< DtString > myControlQueueName
Definition: brokerInitializer.h:262
DtConfigVariable< DtString > myPluginDirectory
Definition: brokerInitializer.h:259
virtual DtString fileName() const
Returns the name of the file that this initializer refers to.
Definition: brokerInitializer.h:312
virtual const std::vector< DtString > & typeFilters() const
Definition: brokerInitializer.h:297
#define DT_DLL_BROKER
Definition: include/broker/dllExport.h:20
DtMultiConfigVariable< DtString > myDisableReflectTranslators
Definition: brokerInitializer.h:275
virtual const std::vector< DtGeoLocationFilter > & geoLocationFilters() const
Definition: brokerInitializer.h:307
DtMultiConfigVariable< DtGeoLocationFilter > myObjectGeoLocationFilters
Definition: brokerInitializer.h:285
DtConfigVariable< bool > myCmdLineDumpEnvFlag
Definition: brokerInitializer.h:252
DtConfigVariable< bool > myOneToOneTranslation
Definition: brokerInitializer.h:265
DtConfigVariable< bool > myloadVrfPluginsFlag
Definition: brokerInitializer.h:260
DtString myProgramName
Definition: brokerInitializer.h:241
DtConfigVariable< bool > myUseGuiFlag
Definition: brokerInitializer.h:254
DtMultiConfigVariable< DtString > myObjectNameFilters
Definition: brokerInitializer.h:282
char ** myArgv
Definition: brokerInitializer.h:240
DtMultiConfigVariable< DtString > myDisablePublishTranslators
Definition: brokerInitializer.h:274
DtMultiConfigVariable< DtString > myObjectTypeFilters
Definition: brokerInitializer.h:283
DtConfigVariable< int > myCmdLineNotifyLevel
Definition: brokerInitializer.h:251
Contains the DtGeoLocationFilter class declaration.
DtConfigVariable< int > myMaxInterMessages
Definition: brokerInitializer.h:267
virtual const std::vector< DtString > & nameFilters() const
Definition: brokerInitializer.h:292
DtConfigVariable< DtString > myInteractionQueueName
Definition: brokerInitializer.h:263
DtConfigVariable< DtString > myObjectQueueName
Definition: brokerInitializer.h:264
DtConfigVariable< DtString > myLogFileName
Definition: brokerInitializer.h:255
DtVariableGroup myObjectFiltersGroup
Definition: brokerInitializer.h:281
DtConfigVariable< DtString > myCmdLineBrokerName
Definition: brokerInitializer.h:249
DtConfigVariable< DtTime > myLocationFilteringInterval
Definition: brokerInitializer.h:270

Document ID: Generated on Mon May 25 18:45:12 EDT 2026 from SVN revision 289111
Copyright © 2005-2026 MAK Technologies. All Rights Reserved (www.mak.com)