MAK RTIspy API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
momNetParam.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 2001 MAK Technologies, Inc.
3 ** All rights reserved.
4 *********************************************************************/
5 /*********************************************************************
6 ** $RCSfile: momNetParam.h,v $ $Revision: 1.18 $ $State: Exp $
7 *********************************************************************/
10 
11 #ifndef DtMomNetParameter_H_
12 #define DtMomNetParameter_H_
13 
14 #include <vlutil/vlBaseMsg.h>
15 
16 #ifdef DtMOM
17 #include <rtiMsConfig.h>
18 #include <internalTypes.h>
19 
20 #if !defined(DtIFSPEC13)
21 #include <momArgument.h>
22 #endif
23 
24 #include <vlutil/vlFedTarget.h>
25 #include <vlutil/vlString.h>
26 
27 #include <rtiApiTypes.h>
28 
29 #if !defined(DtIFSPEC13)
30 #include <RTI/FederateAmbassador.h>
31 #include <string>
32 #endif
33 
34 class DtFederateHandleSet;
35 class DtAttributeHandleSet;
36 class DtAhvps;
37 class DtPhvps;
38 class DtMomHandleList;
39 class DtMomTallyList;
40 class DtSyncPt;
41 
42 enum DT_DLL_LRC DtMomAttributeStateOptions
43 {
44  DT_MOM_OWNED,
45  DT_MOM_UNOWNED
46 };
47 
48 enum DT_DLL_LRC DtMomAlertTypes
49 {
50  DT_MOM_EXCEPTION,
51  DT_MOM_RTI_INTERNAL_ERROR,
52  DT_MOM_FEDERATE_INTERNAL_ERROR,
53  DT_MOM_SERVICE_EXCEPTION,
54  DT_MOM_INVALID_PARAMS
55 };
56 
57 enum DT_DLL_LRC DtMomInitiatorOptions
58 {
59  DT_MOM_FEDERATE,
60  DT_MOM_RTI
61 };
62 
63 enum DT_DLL_LRC DtMomFederateStates {
64  DT_MOM_FEDERATE_RUNNING,
65  DT_MOM_FEDERATE_SAVE_PENDING,
66  DT_MOM_FEDERATE_SAVING,
67  DT_MOM_FEDERATE_RESTORE_PENDING,
68  DT_MOM_FEDERATE_RESTORING,
71  DT_MOM_FEDERATE_INACTIVE
72 };
73 
74 enum DT_DLL_LRC DtMomTimeManagerStates {
75  DT_MOM_TIME_IDLE,
76  DT_MOM_TIME_EVENTS_PENDING
77 };
78 
79 enum DT_DLL_LRC DtMomSyncPointStatus
80 {
81  DtMomSyncNoActivity,
82  DtMomSyncAttemptingToRegister,
83  DtMomSyncMovingToSyncPoint,
84  DtMomSyncWaitingForRestOfFederation
85 };
86 
87 struct DtMomNetHandle
88 {
89  MAKRti::DtNetU32 length;
90  MAKRti::DtNetU32 value;
91 };
92 
95 class DT_DLL_LRC DtMomNetParameter : public MAKRti::DtBaseMsg
96 {
97 public:
98 
100  virtual ~DtMomNetParameter();
101 
103  DtMomNetParameter();
104 
106  DtMomNetParameter(const DtMomNetParameter& orig);
107 
109  DtMomNetParameter(const char* netRepArg, int size,
110  MAKRti::DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
111 
114  DtMomNetParameter(const DtPhvps& parameters, int index,
115  bool useInternalBuffer=true);
116 
118 
119  DtMomNetParameter(bool value);
120  DtMomNetParameter(long value);
121  DtMomNetParameter(unsigned long value);
122  DtMomNetParameter(unsigned int value);
123  DtMomNetParameter(int value);
124  DtMomNetParameter(double value);
125  DtMomNetParameter(char const * value);
126  DtMomNetParameter(wchar_t const * value);
127  DtMomNetParameter(DtAttributeHandleSet const & value);
128  DtMomNetParameter(DtMomAttributeStateOptions value);
129  DtMomNetParameter(DtMomFederateStates value);
130  DtMomNetParameter(DtMomHandleList const & value);
131  DtMomNetParameter(DtMomTallyList const & value);
132  DtMomNetParameter(DtMomTimeManagerStates value);
133  DtMomNetParameter(MAKRti::DtOrderType value);
134  DtMomNetParameter(MAKRti::DtTransportType value);
136 
137 #if defined(DtIFSPEC13)
138 
140 
141  DtMomNetParameter(MAKRti::DtString const & value);
142  DtMomNetParameter(DtMomAlertTypes value);
143  DtMomNetParameter(DtMomInitiatorOptions value);
144  DtMomNetParameter(RTI_API::AttributeHandle * value);
145  DtMomNetParameter(RTI_API::AttributeHandleSet const & value);
146  DtMomNetParameter(RTI_API::AttributeHandleSet const * value);
147  DtMomNetParameter(RTI_API::AttributeHandleValuePairSet const & value);
148  DtMomNetParameter(RTI_API::Boolean value);
149  DtMomNetParameter(RTI_API::EventRetractionHandle const & value);
150  DtMomNetParameter(RTI_API::FederateAmbassador const * value);
151  DtMomNetParameter(RTI_API::FederateAmbassadorPtr value);
152  DtMomNetParameter(RTI_API::FederateHandleSet const & value);
153  DtMomNetParameter(RTI_API::FedTime const & value);
154  DtMomNetParameter(RTI_API::ParameterHandleValuePairSet const & value);
155  DtMomNetParameter(RTI_API::Region const & value);
156  DtMomNetParameter(RTI_API::Region const * value);
157  DtMomNetParameter(RTI_API::Region** value);
158  DtMomNetParameter(RTI_API::ResignAction value);
160 
161 #else
162 
164 
165  DtMomNetParameter(std::wstring const & value);
166  DtMomNetParameter(std::vector<std::wstring> const & value);
167  DtMomNetParameter(DtMomArgumentList const & value);
168  //DtMomNetParameter(DtSyncPt const & value);
169  DtMomNetParameter(RTI_API::AttributeHandleSet const & value);
170  DtMomNetParameter(RTI_API::LogicalTime const & value);
171  DtMomNetParameter(RTI_API::LogicalTimeInterval const & value);
172  DtMomNetParameter(RTI_API::ResignAction value);
173  DtMomNetParameter(DtServiceGroup value);
174 #if defined(DtIFSPEC1516)
175  DtMomNetParameter(RTI_API::FederateHandleSet const & value);
176 #else
177  DtMomNetParameter(DtFederationHandle fedexHandle, RTI_API::FederateHandleSet const & value);
178  DtMomNetParameter(RTI_API::CallbackModel value);
179 #endif
180 
181 
182 #endif
183 
185 
186  DtMomNetParameter& operator=(const DtMomNetParameter& orig);
187  DtMomNetParameter& operator = (bool value);
188  DtMomNetParameter& operator = (int value);
189  DtMomNetParameter& operator = (unsigned int value);
190  DtMomNetParameter& operator = (long value);
191  DtMomNetParameter& operator = (unsigned long value);
192  DtMomNetParameter& operator = (double value);
193  DtMomNetParameter& operator = (char const * value);
194  DtMomNetParameter& operator = (wchar_t const * value);
195  DtMomNetParameter& operator = (DtAttributeHandleSet const & value);
196  DtMomNetParameter& operator = (DtFederateHandleSet const & value);
197  DtMomNetParameter& operator = (DtMomAttributeStateOptions value);
198  DtMomNetParameter& operator = (DtMomFederateStates value);
199  DtMomNetParameter& operator = (DtMomHandleList const & value);
200  DtMomNetParameter& operator = (DtMomTallyList const & value);
201  DtMomNetParameter& operator = (DtMomTimeManagerStates value);
202  DtMomNetParameter& operator = (MAKRti::DtOrderType value);
203  DtMomNetParameter& operator = (MAKRti::DtTransportType value);
205 
206 #if defined(DtIFSPEC13)
207 
209 
210  DtMomNetParameter& operator = (DtAhvps const & value);
211  DtMomNetParameter& operator = (DtMomAlertTypes value);
212  DtMomNetParameter& operator = (DtMomInitiatorOptions value);
213  DtMomNetParameter& operator = (DtPhvps const & value);
214  DtMomNetParameter& operator = (MAKRti::DtString const & value);
215  DtMomNetParameter& operator = (RTI::FedTime const & value);
216  DtMomNetParameter& operator = (RTI::FederateAmbassador const * value);
217  DtMomNetParameter& operator = (RTI::FederateAmbassadorPtr value);
218  DtMomNetParameter& operator = (RTI::EventRetractionHandle const & value);
219  DtMomNetParameter& operator = (RTI::Region const & value);
220  DtMomNetParameter& operator = (RTI::Region const * value);
221  DtMomNetParameter& operator = (RTI::Region ** value);
222  DtMomNetParameter& operator = (RTI::ResignAction value);
224 
225 #else
226 
228 
229  DtMomNetParameter& operator = (std::wstring const & value);
230  DtMomNetParameter& operator = (std::vector<std::wstring> const & value);
231  DtMomNetParameter& operator = (DtMomArgumentList const & value);
232  //DtMomNetParameter& operator = (DtSyncPt const & value);
233  DtMomNetParameter& operator = (RTI_API::LogicalTime const & value);
234  DtMomNetParameter& operator = (RTI_API::LogicalTimeInterval const & value);
235  DtMomNetParameter& operator = (RTI_API::ResignAction value);
236  DtMomNetParameter& operator = (DtServiceGroup value);
238 
239 #endif
240 
241 
245 
246  virtual bool getValue(bool & value) const;
247  virtual bool getValue(int & value) const;
248  virtual bool getValue(unsigned int & value) const;
249  virtual bool getValue(long & value) const;
250  virtual bool getValue(unsigned long & value) const;
251  virtual bool getValue(double & value) const;
252  virtual bool getValue(DtAttributeHandleSet & value) const;
253  virtual bool getValue(DtMomAttributeStateOptions & value) const;
254  virtual bool getValue(DtMomFederateStates & value) const;
255  virtual bool getValue(DtMomHandleList & value) const;
256  virtual bool getValue(DtMomTallyList & value) const;
257  virtual bool getValue(DtMomTimeManagerStates & value) const;
258  virtual bool getValue(MAKRti::DtOrderType & value) const;
259  virtual bool getValue(MAKRti::DtTransportType & value) const;
261 
262 #if defined(DtIFSPEC13)
263 
265 
266  virtual bool getValue(DtMomAlertTypes & value) const;
267  virtual bool getValue(DtMomInitiatorOptions & value) const;
268  virtual bool getValue(MAKRti::DtString & value) const;
269 
270  virtual bool getValue(RTI::FedTime & value) const;
271  virtual bool getValue(RTI::ResignAction & value) const;
273 
274 #else
275 
277 
278  virtual bool getValue(std::wstring & value) const;
279  virtual bool getValue(std::vector<std::wstring> & value) const;
280  virtual bool getValue(DtMomArgumentList & value) const;
281 
282  virtual bool getValue(RTI_API::LogicalTime & value) const;
283  virtual bool getValue(RTI_API::LogicalTimeInterval & value) const;
284  virtual bool getValue(RTI_API::ResignAction & value) const;
285  virtual bool getValue(DtServiceGroup& value) const;
287 
288 #endif
289 
290 protected:
291 
294  virtual void sizeChanged(int size);
295 
296 #if !defined(DtIFSPEC13)
297 
301  virtual unsigned long encodedWideStringLength(unsigned long valueLength,
302  bool addPadding);
303 
306  virtual unsigned long encodedLength(std::wstring const & value, bool addPadding);
307 
312  virtual void* encodeWideString(void* destination, wchar_t const * source,
313  bool addPadding);
314 
321  virtual void* encodeWideString(void* destination, wchar_t const * source,
322  unsigned long sourceLength, bool addPadding);
323 
329  virtual void* encodeWideString(void* destination, std::wstring const & source,
330  bool addPadding);
331 
337  virtual void encodeWideString(wchar_t const * source,
338  unsigned long sourceLength, bool addPadding);
339 
343  virtual void encodeWideString(wchar_t const * source, bool addPadding);
344 
348  virtual void encodeWideString(std::wstring const & source, bool addPadding);
349 
358  virtual unsigned long decodeWideString(char const * source,
359  unsigned long sourceLength, std::wstring & value) const;
360 #endif
361 
364 #if ( __solaris__ )
365 public:
366 #else
367 private:
368 #endif
369 };
370 
375 class DT_DLL_LRC DtMomNetHandleParameter : public DtMomNetParameter
376 {
377 public:
378 
379  virtual ~DtMomNetHandleParameter();
380 
382  DtMomNetHandleParameter();
383 
385  DtMomNetHandleParameter(const DtMomNetHandleParameter& orig);
386 
388  DtMomNetHandleParameter(const char* netRepArg, int size,
389  MAKRti::DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
390 
393  DtMomNetHandleParameter(const DtPhvps& parameters, int index,
394  bool useInternalBuffer=true);
395 
397  DtMomNetHandleParameter(DtHandle value);
398 
399 
401  DtMomNetHandleParameter& operator=(const DtMomNetHandleParameter& orig);
402  DtMomNetHandleParameter& operator = (DtHandle value);
403 
405  virtual bool getValue(DtHandle & value) const;
406 
407 };
408 
409 #endif
410 #endif
FederateAmbassadorPtr
FederateAmbassador * FederateAmbassadorPtr
Definition: RTIambServices13.h:23
DtFederationHandle
DtHandle DtFederationHandle
Definition: internalTypes.h:44
DtSyncPt
Definition: syncPt.h:24
DtFederateHandleSet
Definition: fedHandleSet.h:61
rti1516_2025::fedpro::CallbackModel
CallbackModel
Definition: datatypes.pb.h:280
DtAttributeHandleSet
Defines the internal representation of attribute/parameter handle sets.
Definition: attrHandSet.h:30
rti13::EventRetractionHandle
struct EventRetractionHandle_s EventRetractionHandle
Definition: RTItypes13.h:525
rti13::Boolean
Boolean
Definition: baseTypes13.h:26
rti1516_2025::fedpro::ResignAction
ResignAction
Definition: datatypes.pb.h:305
DtHandle
unsigned long DtHandle
The internal types.
Definition: internalTypes.h:41
DtAhvps
Definition: aHandValSet.h:33
DT_DLL_LRC
#define DT_DLL_LRC
Definition: rtiMsConfig.h:155
DtPhvps
Definition: pHandValSet.h:38
internalTypes.h
The declaration of internal types.
rti13::AttributeHandle
Handle AttributeHandle
Definition: RTItypes13.h:112
Document ID: Generated on Wed Jul 8 16:20:32 EDT 2026 from SVN revision 291616
Copyright © 2005-2025 MAK Technologies Inc. All Rights Reserved (www.mak.com)