VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
exerciseConnInitializerDIS.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1992-2010 VT MAK
3 ** All rights reserved.
4 *********************************************************************/
5 
6 #ifndef _dExConnInit_H_
7 #define _dExConnInit_H_
8 
13 
14 #if DtDIS
15 
16 #include <vlutil/vlUtil.h>
17 #include <cmdLine/cmdLine.h>
18 #include <vlutil/vlTimeStampType.h>
19 #include <vlutil/vlString.h>
20 
22 
23 #include <mtl/configVariable.h>
25 
26 #include <vlutil/vlDisSocket.h>
27 #include <vlutil/vlInetAddr.h>
28 
29 #include <vlpi/disEnums.h>
30 
31 class DtMtlEnvironment;
32 
37 {
38 public:
41 
43  virtual ~DtExerciseConnInitializer();
44 
47 
50 
52  virtual void setPort(int port);
53 
55  virtual int port() const;
56 
58  virtual void setExerciseId(int id);
59 
61  virtual int exerciseId() const;
62 
64  virtual void setSiteId(int id);
65 
67  virtual int siteId() const;
68 
70  virtual void setApplicationNumber(int num);
71 
73  virtual int applicationNumber() const;
74 
76  virtual void setUseAsynchIO(bool on);
77 
79  virtual bool useAsynchIO() const;
80 
83  virtual void setDestinationAddress(const DtString &addr);
84 
87  virtual DtString destinationAddress() const;
88 
93  virtual void setSocket(DtDisSocket* sock);
94 
96  virtual DtDisSocket* socket() const;
97 
99  virtual void setNotifyLevel(int level);
100 
102  virtual void setDisVersionToSend(int version);
103 
107  virtual void setTimeStampType(DtTimeStampType relOrAbs);
108 
110  virtual DtTimeStampType timeStampType() const;
111 
113  virtual void setSendBufferSize(int numBytes);
114 
116  virtual int sendBufferSize() const;
117 
119  virtual void setReceiveBufferSize(int numBytes);
120 
122  virtual int receiveBufferSize() const;
123 
124  virtual void setUseIpv6(bool val);
125  virtual bool useIpv6() const;
126 
132  virtual void setMulticastTtl(int ttl);
133 
135  virtual int multicastTtl() const;
136 
137  virtual void setMulticastAddresses(const std::vector<DtString>& addresses);
138 
139  virtual const std::vector<DtString>& multicastAddresses() const;
140 
143  virtual void setDeviceAddress(const DtString& devAddr);
144 
146  virtual DtString deviceAddress() const;
147 
149  virtual void setSubnetMask(const DtString& mask);
150 
152  virtual DtString subnetMask() const;
153 
155  virtual void setSuppressSelfReflect(bool yesNo);
156 
158  virtual bool suppressSelfReflect() const;
159 
161  virtual void setAttributePduStrategy(DtAttributePduStrategy strat);
162 
164  virtual DtAttributePduStrategy attributePduStrategy() const;
165 
166 public:
167 
169  static DtString vrlinkVersion();
170 
171 private:
172  int myPort;
174  int mySiteId;
181  std::vector<DtString> myMulticastAddresses;
182  bool myUseIpv6;
189 };
190 
203 {
204 public:
205  DtVrlApplicationInitializer(int argc, char* argv[], const DtString& appName,
207 
208  virtual ~DtVrlApplicationInitializer();
209 
210  virtual void parseCmdLine();
211 
215  virtual void loadFile(const DtString& fileName);
216 
218  virtual void saveFile(const DtString& filename);
219 
222  virtual void setArgc(int);
224  virtual int argc() const;
225 
228  virtual void setArgv(char**);
230  virtual char** argv() const;
231 
232  virtual void setPort(int port);
233  virtual int port() const;
234 
235  virtual void setExerciseId(int id);
236  virtual int exerciseId() const;
237 
238  virtual void setApplicationNumber(int num);
239  virtual int applicationNumber() const;
240 
241  virtual void setSiteId(int id);
242  virtual int siteId() const;
243 
244  virtual void setDestinationAddress(const DtString& address);
245  virtual DtString destinationAddress() const;
246 
247  virtual void setNotifyLevel(int level);
248 
249  //{@
251  virtual void setNotifyFileLevel(int level);
252  virtual int notifyFileLevel() const;
254 
255  //{@
257  virtual void setNotifyFilename(const DtString& file);
258  virtual DtString notifyFilename() const;
260 
261  virtual void setSendBufferSize(int numBytes);
262  virtual int sendBufferSize() const;
263 
264  virtual void setReceiveBufferSize(int numBytes);
265  virtual int receiveBufferSize() const;
266 
268  virtual void setUseAsynchIO(bool on);
269 
271  virtual bool useAsynchIO() const;
272 
275  virtual void setMulticastTtl(int ttl);
276 
279  virtual int multicastTtl() const;
280 
283  virtual void setTimeStampType(DtTimeStampType relOrAbs);
284 
286  virtual DtTimeStampType timeStampType() const;
287 
288  virtual void setMulticastAddresses(const std::vector<DtString>& addresses);
289  virtual const std::vector<DtString>& multicastAddresses() const;
290 
291  virtual void setUseIpv6(bool val);
292  virtual bool useIpv6() const;
293 
295  virtual void setSuppressSelfReflect(bool yesNo);
296 
298  virtual bool suppressSelfReflect() const;
299 
302  virtual void setDeviceAddress(const DtString& devAddr);
303 
305  virtual DtString deviceAddress() const;
306 
308  virtual void setSubnetMask(const DtString& mask);
309 
311  virtual DtString subnetMask() const;
312 
315 
318 
323  virtual void setOutputInterval(double period);
324 
326  virtual double outputInterval() const;
327 
328 protected:
330  virtual void initializeFileLogging();
331 
332 protected:
333  int myArgc;
334  char** myArgv;
336 
337  virtual void initializeMtlParams();
338  virtual void loadMtlFile(const DtString& fileName);
339 
363 
364  // If logging is turned on, this printer will remain in memory
365  // even after this class is destroyed. Otherwise we would
366  // have to stop logging prematurely.
368 
374 };
375 
376 #endif
377 #endif
378 
command line support
Definition: mtlEnvironment.h:42
DtConfigVariable< int > myConfigVarMulticastTtl
Definition: exerciseConnInitializerDIS.h:355
DtConfigVariable< DtString > myConfigVarDestinationAddress
Definition: exerciseConnInitializerDIS.h:348
Contains the DtApplicationSettings class declaration.
DtConfigVariable< bool > myConfigVarUseAbsoluteTimestamps
Definition: exerciseConnInitializerDIS.h:354
DtDisSocket * mySocket
Definition: exerciseConnInitializerDIS.h:187
virtual bool suppressSelfReflect() const
Returns whether the application should not self reflect.
Definition: applicationSettings.h:24
#define DT_DLL_VL
Definition: vlMachineTypes.h:108
virtual void setAttributePduStrategy(DtAttributePduStrategy strat)
Set whether to couple the attribute PDU.
Instances of DtExerciseConnInitializer are used to provide the DtExerciseConn with initialization dat...
Definition: exerciseConnInitializerDIS.h:36
Contains the DtString class declaration.
DtFilePrinter is a subclass of DtPrinter which opens a file and dumps all information received from D...
Definition: vlPrint.h:80
virtual void setPort(int port)
Sets the port.
virtual void setUseAsynchIO(bool on)
Sets the use of asynchronous I/O.
virtual DtString subnetMask() const
Returns the subnet mask to use.
char ** myArgv
Definition: exerciseConnInitializerDIS.h:334
virtual void setDeviceAddress(const DtString &devAddr)
Set the device to use for the DIS connection.
virtual int exerciseId() const
Returns the exercise ID.
DtConfigVariable< int > myConfigVarExerciseId
Definition: exerciseConnInitializerDIS.h:344
DtTimeStampType myTimeStampType
Definition: exerciseConnInitializerDIS.h:177
virtual int siteId() const
Returns the site ID.
int myMtlUseAbsoluteTimeStamps
Definition: exerciseConnInitializerDIS.h:371
virtual int receiveBufferSize() const
Get the receive buffer size.
DtInetAddr myCachedDestAddr
Definition: exerciseConnInitializerDIS.h:369
DtConfigVariable< int > myConfigVarDisVersion
Definition: exerciseConnInitializerDIS.h:347
bool mySuppressSelfReflect
Definition: exerciseConnInitializerDIS.h:183
virtual int sendBufferSize() const
Get the send buffer size.
DtConfigVariable< int > myConfigVarNotifyFileLevel
Definition: exerciseConnInitializerDIS.h:359
static DtString vrlinkVersion()
Returns a string indicating the VR-Link version number.
int myPort
Definition: exerciseConnInitializerDIS.h:172
virtual DtTimeStampType timeStampType() const
Get the time stamp type.
virtual bool useIpv6() const
Contains the DtMultiConfigVariable class declaration.
bool myUseIpv6
Definition: exerciseConnInitializerDIS.h:182
virtual void setMulticastAddresses(const std::vector< DtString > &addresses)
virtual void setMulticastTtl(int ttl)
Set the mcast TTL.
virtual void setDestinationAddress(const DtString &addr)
Sets the destination address Same as above but takes address as a string.
int mySendBufferSize
Definition: exerciseConnInitializerDIS.h:178
DtString myDestinationAddress
Definition: exerciseConnInitializerDIS.h:185
The DtDisSocket class provides an address family independent datagram socket.
Definition: vlDisSocket.h:75
int myAttributePduStrategy
Definition: exerciseConnInitializerDIS.h:188
virtual void setApplicationNumber(int num)
Sets the application number.
DtConfigVariable< DtString > myConfigVarSubnetMask
Definition: exerciseConnInitializerDIS.h:358
Represents a IPv4 or IPv6 address.
Definition: vlInetAddr.h:36
int myMtlUseAsynchronousIO
Definition: exerciseConnInitializerDIS.h:370
virtual void setSuppressSelfReflect(bool yesNo)
Set the suppression of reflection DIS PDU&#39;s. Off by default.
Contains the DtConfigVariable class declaration.
virtual DtString deviceAddress() const
Returns the device address to use.
DtMtlEnvironment * myMtlEnv
Definition: exerciseConnInitializerDIS.h:335
bool myUseAsynchIO
Definition: exerciseConnInitializerDIS.h:176
Instances of DtVrlApplicationInitializer are used to initialize the exercise connection with command ...
Definition: exerciseConnInitializerDIS.h:202
virtual void setUseIpv6(bool val)
int myMtlSuppressSelfReflect
Definition: exerciseConnInitializerDIS.h:373
DtAttributePduStrategy
Definition: vlAttributePduStrategy.h:16
DtVariableGroup myDisConnection
Definition: exerciseConnInitializerDIS.h:342
virtual void setSubnetMask(const DtString &mask)
Set the subnet mask to use for the DIS connection.
virtual bool useAsynchIO() const
Returns the use of asynchronous I/O.
virtual int multicastTtl() const
Returns the multicast TTL.
This file contains the declaration of the DtInetAddr class.
DtMultiConfigVariable< DtString > myConfigVarMulticastAddresses
Definition: exerciseConnInitializerDIS.h:356
DtApplicationSettings mySettings
Definition: exerciseConnInitializerDIS.h:340
int mySiteId
Definition: exerciseConnInitializerDIS.h:174
This file declares the class DtCmdLine::CmdLine.
virtual int port() const
Returns the port.
int socket(int, int, int)
int myApplicationNumber
Definition: exerciseConnInitializerDIS.h:175
virtual void setExerciseId(int id)
Sets the exercise ID.
DtConfigVariable< int > myConfigVarSendBufferSize
Definition: exerciseConnInitializerDIS.h:349
DtConfigVariable< DtString > myConfigVarNotifyFilename
Definition: exerciseConnInitializerDIS.h:360
DtConfigVariable< double > myConfigVarOutputInterval
Definition: exerciseConnInitializerDIS.h:362
Contains the DtDisSocket class declaration.
virtual DtString destinationAddress() const
Returns the destination address.
DtConfigVariable< bool > myConfigVarUseIpv6
Definition: exerciseConnInitializerDIS.h:352
std::vector< DtString > myMulticastAddresses
Definition: exerciseConnInitializerDIS.h:181
DtConfigVariable< int > myConfigVarApplicationNumber
Definition: exerciseConnInitializerDIS.h:346
virtual void setTimeStampType(DtTimeStampType relOrAbs)
Set the time stamp type (DtTimeStampAbsolute or DtTimeStampRelative).
int myMtlUseIpv6
Definition: exerciseConnInitializerDIS.h:372
virtual int applicationNumber() const
Returns the application number.
int myMulticastTtl
Definition: exerciseConnInitializerDIS.h:180
DtString myDeviceAddress
Definition: exerciseConnInitializerDIS.h:184
int myReceiveBufferSize
Definition: exerciseConnInitializerDIS.h:179
Represents a group of variables.
Definition: variableGroup.h:21
Contains the standard DIS enumerations.
DtTimeStampType
Definition: vlTimeStampType.h:16
int myExerciseId
Definition: exerciseConnInitializerDIS.h:173
int myArgc
Definition: exerciseConnInitializerDIS.h:333
DtConfigVariable< bool > myConfigVarUseAsyncIo
Definition: exerciseConnInitializerDIS.h:351
provides basic Operating Independent Methods useful to a federate
virtual DtAttributePduStrategy attributePduStrategy() const
Returns whether to couple the attribute PDU.
Instances of DtString are used to represent strings.
Definition: vlString.h:29
DtConfigVariable< bool > myConfigVarSuppressSelfReflect
Definition: exerciseConnInitializerDIS.h:353
DtFilePrinter * myLogFilePrinter
Definition: exerciseConnInitializerDIS.h:367
DtString mySubnetMask
Definition: exerciseConnInitializerDIS.h:186
virtual void setReceiveBufferSize(int numBytes)
Set the receive buffer size.
DtConfigVariable< DtString > myConfigVarDeviceAddress
Definition: exerciseConnInitializerDIS.h:357
DtConfigVariable< int > myConfigVarAttributeStrategy
Definition: exerciseConnInitializerDIS.h:361
virtual void setNotifyLevel(int level)
Sets the notify level.
virtual void setSiteId(int id)
Sets the site ID.
virtual const std::vector< DtString > & multicastAddresses() const
virtual void setSendBufferSize(int numBytes)
Set the send buffer size.
DtConfigVariable< int > myConfigVarReceiveBufferSize
Definition: exerciseConnInitializerDIS.h:350
DtConfigVariable< int > myConfigVarPort
Definition: exerciseConnInitializerDIS.h:343
DtConfigVariable< int > myNotifyLevel
Definition: exerciseConnInitializerDIS.h:341
DtConfigVariable< int > myConfigVarSiteNumber
Definition: exerciseConnInitializerDIS.h:345

Document ID: Generated on Mon Apr 25 03:39:01 EDT 2022 from SVN revision 242502
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)