VR-Exchange 2.8 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 VT MAK
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 int notifyLevel() const;
80  virtual void setNotifyLevel( int nl );
81 
84  virtual DtString logFileName() const;
85  virtual void setLogFileName( const DtString& lfn );
86 
88  virtual bool isLogTimestampingEnabled() const;
89  virtual void setLogTimestampingEnabled( bool timestamp );
90 
93  virtual int logRollingInterval() const;
94  virtual void setLogRollingInterval( int intervalInSeconds );
95 
97  virtual DtTime lockFailureTimeout() const;
98  virtual void setLockFailureTimeout( DtTime timeInSeconds );
99 
101  virtual DtString pluginDirectory() const;
102  virtual void setPluginDirectory( const DtString& lfn );
103 
105  virtual bool loadVrfPlugins() const;
106  virtual void setloadVrfPlugins(bool val);
107 
109  virtual DtString vrfVersion() const;
110  virtual void setVrfVersion( const DtString& version );
111 
113  virtual int maxControlMessages() const;
114  virtual void setMaxControlMessages( int mcm );
115 
117  virtual int maxInteractionMessages() const;
118  virtual void setMaxInteractionMessages( int mim );
119 
121  virtual int maxObjectMessages() const;
122  virtual void setMaxObjectMessages( int mom );
123 
126  virtual int pollingInterval() const;
127  virtual void setPollingInterval( int pi );
128 
130  virtual DtTime locationFilteringInterval() const;
131  virtual void setLocationFilteringInterval( DtTime t );
132 
134  virtual DtTime statisticsReportingInterval() const;
135  virtual void setStatisticsReportingInterval( DtTime si );
136 
138  virtual bool printStatistics() const;
139  virtual void setPrintStatistics( bool val );
140 
144  virtual int tcpPort() const;
145  virtual void setTcpPort( int port );
146 
149  virtual bool dumpEnvironment() const;
150  virtual void setDumpEnvironment( bool shouldDumpEnv );
151 
154  virtual DtString controlQueueName() const;
155  virtual DtString interactionQueueName() const;
156  virtual DtString objectQueueName() const;
157 
159  virtual bool oneToOneMapping() const;
160  virtual void setOneToOneMapping( bool val );
161 
168  virtual const std::vector<DtString>& debuggedTranslators() const;
169  virtual void addDebuggedTranslator( const DtString& );
170  virtual void removeDebuggedTranslator( const DtString& );
171  virtual void setDebuggedTranslators( const std::set<DtString>& debuggedSet );
172 
173 
180  virtual const std::vector<DtString>& disablePublishTranslatorSet() const;
181  virtual void addDisablePublishTranslator( const DtString& );
182  virtual void removeDisablePublishTranslator( const DtString& );
183  virtual void setDisablePublishTranslators( const std::set<DtString>& disabledSet );
184 
191  virtual const std::vector<DtString>& disableReflectTranslatorSet() const;
192  virtual void addDisableReflectTranslator( const DtString& );
193  virtual void removeDisableReflectTranslator( const DtString& );
194  virtual void setDisableReflectTranslators( const std::set<DtString>& disableSet );
195 
198  bool useGui() const;
199 
202  bool showConnectionInfoDialog() const;
203 
205  int& argc();
206 
208  char** argv();
209 
210  virtual void addObjectFilter( const DtObjectFilter& filter );
211  virtual void removeObjectFilter( const DtObjectFilter& filter );
212 
213  virtual void setNameFilters( const std::vector<DtString>& filters );
214  virtual const std::vector<DtString>& nameFilters() const;
215 
216  virtual void setTypeFilters( const std::vector<DtString>& filters );
217  virtual const std::vector<DtString>& typeFilters() const;
218 
219  virtual void setMarkingFilters( const std::vector<DtString>& filters );
220  virtual const std::vector<DtString>& markingFilters() const;
221 
222  virtual void setGeoLocationFilters( const std::vector<DtGeoLocationFilter>& filters );
223  virtual const std::vector<DtGeoLocationFilter>& geoLocationFilters() const;
224 
225  virtual void setDarkModeEnabled( int val );
226  virtual int darkModeEnabled();
227 
229  virtual DtString fileName() const;
230 
232  virtual DtString qtTranslatorLocale();
233 
234  protected:
235 
236  int myArgc;
237  char** myArgv;
240 
241  DtApplicationSettings mySettings;
242 
243  DtConfigVariable<bool> myShowInfoDialogFlag;
244 
245  DtConfigVariable<DtString> myMtlFileName;
246  DtConfigVariable<DtString> myCmdLineBrokerName;
247  DtConfigVariable<int> myCmdLineTcpPort;
248  DtConfigVariable<int> myCmdLineNotifyLevel;
249  DtConfigVariable<bool> myCmdLineDumpEnvFlag;
250 
251  DtConfigVariable<bool> myUseGuiFlag;
252  DtConfigVariable<DtString> myLogFileName;
253  DtConfigVariable<bool> myLogTimestampingEnabled;
254  DtConfigVariable<int> myLogRollingInterval;
255  DtConfigVariable<DtTime> myLockFailureTimeout;
256  DtConfigVariable<DtString> myPluginDirectory;
257  DtConfigVariable<bool> myloadVrfPluginsFlag; //OTF 4967
258  DtConfigVariable<DtString> myVrfVersion;
259  DtConfigVariable<DtString> myControlQueueName;
260  DtConfigVariable<DtString> myInteractionQueueName;
261  DtConfigVariable<DtString> myObjectQueueName;
262  DtConfigVariable<bool> myOneToOneTranslation;
263  DtConfigVariable<int> myMaxControlMessages;
264  DtConfigVariable<int> myMaxInterMessages;
265  DtConfigVariable<int> myMaxObjectMessages;
266  DtConfigVariable<int> myPollingInterval;
267  DtConfigVariable<DtTime> myLocationFilteringInterval;
268  DtConfigVariable<DtTime> myStatisticsReportingInterval;
269  DtConfigVariable<bool> myPrintStatisticsFlag;
270  DtMultiConfigVariable<DtString> myDebuggedTranslators;
271  DtMultiConfigVariable<DtString> myDisablePublishTranslators;
272  DtMultiConfigVariable<DtString> myDisableReflectTranslators;
273  DtConfigVariable<DtString> myQtTranslatorLocale;
274 
275  //Int value for dark mode.
276  DtConfigVariable<int> myDarkModeEnabled;
277 
278  DtVariableGroup myObjectFiltersGroup;
279  DtMultiConfigVariable<DtString> myObjectNameFilters;
280  DtMultiConfigVariable<DtString> myObjectTypeFilters;
281  DtMultiConfigVariable<DtString> myObjectMarkingFilters;
282  DtMultiConfigVariable<DtGeoLocationFilter> myObjectGeoLocationFilters;
283 // DtMultiConfigVariable<DtGeoRegionFilter> myObjectGeoRegionFilters;
284 // DtMultiConfigVariable<DtGeoEntityFilter> myObjectGeoEntityFilters;
285 
286  };
287 
288 
289  inline const std::vector<DtString>& DtBrokerInitializer::nameFilters() const
290  {
291  return myObjectNameFilters.values();
292  }
293 
294  inline const std::vector<DtString>& DtBrokerInitializer::typeFilters() const
295  {
296  return myObjectTypeFilters.values();
297  }
298 
299  inline const std::vector<DtString>& DtBrokerInitializer::markingFilters() const
300  {
301  return myObjectMarkingFilters.values();
302  }
303 
304  inline const std::vector<DtGeoLocationFilter>& DtBrokerInitializer::geoLocationFilters() const
305  {
306  return myObjectGeoLocationFilters.values();
307  }
308 
310  {
311  return myMtlFileName.value();
312  }
313 
314 }
DtConfigVariable< DtTime > myLockFailureTimeout
Definition: brokerInitializer.h:255
DtString myVersionString
Definition: brokerInitializer.h:239
DtConfigVariable< int > myPollingInterval
Definition: brokerInitializer.h:266
DtConfigVariable< DtTime > myStatisticsReportingInterval
Definition: brokerInitializer.h:268
DtConfigVariable< int > myMaxControlMessages
Definition: brokerInitializer.h:263
A class to initialize DtBroker instances.
Definition: brokerInitializer.h:35
DtConfigVariable< DtString > myVrfVersion
Definition: brokerInitializer.h:258
DtConfigVariable< int > myLogRollingInterval
Definition: brokerInitializer.h:254
Contains the DtObjectFilter class declaration.
DtConfigVariable< int > myDarkModeEnabled
Definition: brokerInitializer.h:276
DtConfigVariable< bool > myLogTimestampingEnabled
Definition: brokerInitializer.h:253
DtConfigVariable< DtString > myQtTranslatorLocale
Definition: brokerInitializer.h:273
DtApplicationSettings mySettings
Definition: brokerInitializer.h:241
DtConfigVariable< bool > myPrintStatisticsFlag
Definition: brokerInitializer.h:269
DtConfigVariable< int > myMaxObjectMessages
Definition: brokerInitializer.h:265
int myArgc
Definition: brokerInitializer.h:236
DtConfigVariable< int > myCmdLineTcpPort
Definition: brokerInitializer.h:247
DtMultiConfigVariable< DtString > myObjectMarkingFilters
Definition: brokerInitializer.h:281
Stores the type and filter string for an individual filter.
Definition: objectFilter.h:20
DtConfigVariable< bool > myShowInfoDialogFlag
Definition: brokerInitializer.h:243
virtual const std::vector< DtString > & markingFilters() const
Definition: brokerInitializer.h:299
DtConfigVariable< DtString > myMtlFileName
Definition: brokerInitializer.h:245
DtMultiConfigVariable< DtString > myDebuggedTranslators
Definition: brokerInitializer.h:270
DtConfigVariable< DtString > myControlQueueName
Definition: brokerInitializer.h:259
DtConfigVariable< DtString > myPluginDirectory
Definition: brokerInitializer.h:256
virtual DtString fileName() const
Returns the name of the file that this initializer refers to.
Definition: brokerInitializer.h:309
virtual const std::vector< DtString > & typeFilters() const
Definition: brokerInitializer.h:294
#define DT_DLL_BROKER
Definition: include/broker/dllExport.h:20
DtMultiConfigVariable< DtString > myDisableReflectTranslators
Definition: brokerInitializer.h:272
virtual const std::vector< DtGeoLocationFilter > & geoLocationFilters() const
Definition: brokerInitializer.h:304
DtMultiConfigVariable< DtGeoLocationFilter > myObjectGeoLocationFilters
Definition: brokerInitializer.h:282
DtConfigVariable< bool > myCmdLineDumpEnvFlag
Definition: brokerInitializer.h:249
DtConfigVariable< bool > myOneToOneTranslation
Definition: brokerInitializer.h:262
DtConfigVariable< bool > myloadVrfPluginsFlag
Definition: brokerInitializer.h:257
DtString myProgramName
Definition: brokerInitializer.h:238
DtConfigVariable< bool > myUseGuiFlag
Definition: brokerInitializer.h:251
DtMultiConfigVariable< DtString > myObjectNameFilters
Definition: brokerInitializer.h:279
char ** myArgv
Definition: brokerInitializer.h:237
DtMultiConfigVariable< DtString > myDisablePublishTranslators
Definition: brokerInitializer.h:271
DtMultiConfigVariable< DtString > myObjectTypeFilters
Definition: brokerInitializer.h:280
DtConfigVariable< int > myCmdLineNotifyLevel
Definition: brokerInitializer.h:248
Contains the DtGeoLocationFilter class declaration.
DtConfigVariable< int > myMaxInterMessages
Definition: brokerInitializer.h:264
virtual const std::vector< DtString > & nameFilters() const
Definition: brokerInitializer.h:289
DtConfigVariable< DtString > myInteractionQueueName
Definition: brokerInitializer.h:260
DtConfigVariable< DtString > myObjectQueueName
Definition: brokerInitializer.h:261
DtConfigVariable< DtString > myLogFileName
Definition: brokerInitializer.h:252
DtVariableGroup myObjectFiltersGroup
Definition: brokerInitializer.h:278
DtConfigVariable< DtString > myCmdLineBrokerName
Definition: brokerInitializer.h:246
DtConfigVariable< DtTime > myLocationFilteringInterval
Definition: brokerInitializer.h:267

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)