MAK RTIspy API Documentation for HLA 1516
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
momArgument.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 2001 MAK Technologies, Inc.
3 ** All rights reserved.
4 *********************************************************************/
7 
8 #pragma once
9 
10 #ifdef DtMOM
11 
12 #if defined(DtIFSPEC13)
13 
14 #include "momNetParam.h"
15 
16 #define DtMomArgument DtMomNetParameter
17 
18 #else
19 
20 
21 #include <rtiMsConfig.h>
22 #include <internalTypes.h>
23 
24 #include <vlutil/vlBaseMsg.h>
25 #include <vlutil/vlString.h>
26 
27 #include <rtiApiTypes.h>
28 #include <RTI/RangeBounds.h>
29 #include <RTI/FederateAmbassador.h>
30 
31 #include <string>
32 #include <vector>
33 
34 class DtFederateMgr;
35 class DtMomMgr;
36 class DtObjectMgr;
37 class DtFomClassMgr;
38 class DtObjectClassInfo;
39 class DtInteractionClassInfo;
40 class DtRtiObject;
41 class DtFederateHandleSet;
42 class DtAttributeHandleSet;
43 class DtAhvps;
44 class DtPhvps;
45 
46 class DtMomArgument : public std::wstring
47 {
48 public:
49 
50  virtual ~DtMomArgument();
51 
53  DtMomArgument(const DtMomArgument& orig);
54 
56 
57  DtMomArgument();
58  DtMomArgument(bool value);
59  DtMomArgument(double value);
60  DtMomArgument(unsigned long value);
61  DtMomArgument(wchar_t const * value);
62  DtMomArgument(std::wstring const & value);
63  DtMomArgument(std::vector<std::wstring> const & value);
64  DtMomArgument(std::set<std::wstring> const & value);
65  DtMomArgument(RTI_API::AttributeHandle value);
66  DtMomArgument(RTI_API::AttributeHandleSet const & value);
67  DtMomArgument(RTI_API::AttributeHandleSetRegionHandleSetPairVector const & value);
68  DtMomArgument(RTI_API::AttributeHandleValueMap const& value);
69  DtMomArgument(RTI_API::DimensionHandle const& value);
70  DtMomArgument(RTI_API::DimensionHandleSet const& value);
71  DtMomArgument(RTI_API::FederateAmbassador & value);
72  DtMomArgument(RTI_API::FederateHandle value);
73 #if defined(DtIFSPEC1516_2025)
74  DtMomArgument(RTI_API::FederationExecutionMemberInformationVector const & value);
75 #endif
76 #if defined(DtIFSPEC1516)
77  DtMomArgument(RTI_API::FederateHandleRestoreStatusPairVector const & value);
78 #else
79  DtMomArgument(RTI_API::FederateRestoreStatusVector const & value);
80 #endif
81  DtMomArgument(RTI_API::FederateHandleSaveStatusPairVector const & value);
82  DtMomArgument(RTI_API::FederateHandleSet const& value);
83  DtMomArgument(RTI_API::InteractionClassHandle value);
84  DtMomArgument(RTI_API::LogicalTime const& value);
85  DtMomArgument(RTI_API::LogicalTimeInterval const& value);
86  DtMomArgument(RTI_API::MessageRetractionHandle const & value);
87  DtMomArgument(RTI_API::ObjectClassHandle value);
88  DtMomArgument(RTI_API::ObjectInstanceHandle value);
89  DtMomArgument(RTI_API::OrderType value);
90  DtMomArgument(RTI_API::ParameterHandle value);
91  DtMomArgument(RTI_API::ParameterHandleValueMap const& value);
92  DtMomArgument(RTI_API::RangeBounds const & value);
93  DtMomArgument(RTI_API::RegionHandle value);
94  DtMomArgument(RTI_API::RegionHandleSet const & value);
95  DtMomArgument(RTI_API::ResignAction value);
96  DtMomArgument(RTI_API::RestoreFailureReason value);
97  DtMomArgument(RTI_API::SaveFailureReason value);
98 #if defined(DtIFSPEC1516)
99  DtMomArgument(RTI_API::ServiceGroupIndicator value);
100  DtMomArgument(RTI_API::SynchronizationFailureReason value);
101 #else
102  DtMomArgument(RTI_API::ServiceGroup value);
103  DtMomArgument(RTI_API::SynchronizationPointFailureReason value);
104 #endif
105  DtMomArgument(DtRtiApiTransportationType value);
106  DtMomArgument(RTI_API::VariableLengthData const & value);
107 
108 #if !defined(DtIFSPEC1516)
109  DtMomArgument(RTI_API::CallbackModel value);
110  DtMomArgument(RTI_API::FederationExecutionInformationVector const & value);
111 #if defined(DtIFSPEC1516E)
112  DtMomArgument(RTI_API::SupplementalReflectInfo const& value);
113  DtMomArgument(RTI_API::SupplementalReceiveInfo const& value);
114  DtMomArgument(RTI_API::SupplementalRemoveInfo const & value);
115 #endif
116 #endif
117 
119 
121 
122  DtMomArgument& operator=(const DtMomArgument& orig);
123  DtMomArgument& operator = (bool value);
124  DtMomArgument& operator = (double value);
125  DtMomArgument& operator = (unsigned long value);
126  DtMomArgument& operator = (wchar_t const * value);
127  DtMomArgument& operator = (std::wstring const & value);
128  DtMomArgument& operator = (std::vector<std::wstring> const & value);
129  DtMomArgument& operator = (std::set<std::wstring> const & value);
130  DtMomArgument& operator = (RTI_API::AttributeHandle value);
131  DtMomArgument& operator = (RTI_API::AttributeHandleSet const & value);
132  DtMomArgument& operator = (RTI_API::AttributeHandleSetRegionHandleSetPairVector const & value);
133  DtMomArgument& operator = (RTI_API::AttributeHandleValueMap const& value);
134  DtMomArgument& operator = (RTI_API::DimensionHandle const& value);
135  DtMomArgument& operator = (RTI_API::DimensionHandleSet const& value);
136  DtMomArgument& operator = (RTI_API::FederateAmbassador & value);
137  DtMomArgument& operator = (RTI_API::FederateHandle value);
138  DtMomArgument& operator = (RTI_API::FederateHandleSet const& value);
139 #if defined(DtIFSPEC1516_2025)
140  DtMomArgument& operator = (RTI_API::FederationExecutionMemberInformationVector const & value);
141 #endif
142 #if defined(DtIFSPEC1516)
143  DtMomArgument& operator = (RTI_API::FederateHandleRestoreStatusPairVector const & value);
144 #else
145  DtMomArgument& operator = (RTI_API::FederateRestoreStatusVector const & value);
146 #endif
147  DtMomArgument& operator = (RTI_API::FederateHandleSaveStatusPairVector const & value);
148  DtMomArgument& operator = (RTI_API::InteractionClassHandle value);
149  DtMomArgument& operator = (RTI_API::LogicalTime const& value);
150  DtMomArgument& operator = (RTI_API::LogicalTimeInterval const& value);
151  DtMomArgument& operator = (RTI_API::MessageRetractionHandle const & value);
152  DtMomArgument& operator = (RTI_API::ObjectClassHandle value);
153  DtMomArgument& operator = (RTI_API::ObjectInstanceHandle value);
154  DtMomArgument& operator = (RTI_API::OrderType value);
155  DtMomArgument& operator = (RTI_API::ParameterHandle value);
156  DtMomArgument& operator = (RTI_API::ParameterHandleValueMap const& value);
157  DtMomArgument& operator = (RTI_API::RangeBounds const & value);
158  DtMomArgument& operator = (RTI_API::RegionHandle value);
159  DtMomArgument& operator = (RTI_API::RegionHandleSet const & value);
160  DtMomArgument& operator = (RTI_API::ResignAction value);
161  DtMomArgument& operator = (RTI_API::RestoreFailureReason value);
162  DtMomArgument& operator = (RTI_API::SaveFailureReason value);
163 #if defined(DtIFSPEC1516)
164  DtMomArgument& operator = (RTI_API::ServiceGroupIndicator value);
165 #else
166  DtMomArgument& operator = (RTI_API::ServiceGroup value);
167 #endif
168 #if defined(DtIFSPEC1516)
169  DtMomArgument& operator = (RTI_API::SynchronizationFailureReason value);
170 #else
171  DtMomArgument& operator = (RTI_API::SynchronizationPointFailureReason value);
172 #endif
173  DtMomArgument& operator = (DtRtiApiTransportationType value);
174  DtMomArgument& operator = (RTI_API::VariableLengthData const & value);
175 
176 #if !defined(DtIFSPEC1516)
177  DtMomArgument& operator = (RTI_API::CallbackModel value);
178  DtMomArgument& operator = (RTI_API::FederationExecutionInformationVector const & value);
179 #if defined(DtIFSPEC1516E)
180  DtMomArgument& operator = (RTI_API::SupplementalReflectInfo const& value);
181  DtMomArgument& operator = (RTI_API::SupplementalReceiveInfo const& value);
182  DtMomArgument& operator = (RTI_API::SupplementalRemoveInfo const & value);
183 #endif
184 #endif
185 
187 
189 
190 
191  DtMomArgument& assignVerbose(RTI_API::AttributeHandle value, DtObjectClassInfo* classInfo, int verboseLevel);
192  DtMomArgument& assignVerbose(RTI_API::AttributeHandleSet const & value,
193  DtObjectClassInfo* classInfo, int verboseLevel);
194  DtMomArgument& assignVerbose(RTI_API::AttributeHandleSetRegionHandleSetPairVector const & value,
195  DtObjectClassInfo* classInfo, int verboseLevel);
196  DtMomArgument& assignVerbose(RTI_API::AttributeHandleValueMap const& value, DtRtiObject* object,
197  int verboseLevel);
198  DtMomArgument& assignVerbose(RTI_API::DimensionHandle const& value, DtFomClassMgr* fomMgr, int verboseLevel);
199  DtMomArgument& assignVerbose(RTI_API::DimensionHandleSet const& value, DtFomClassMgr* fomMgr, int verboseLevel);
200  DtMomArgument& assignVerbose(RTI_API::FederateHandle value, DtFederateMgr* fedMgr, int verboseLevel);
201  DtMomArgument& assignVerbose(RTI_API::FederateHandleSet const& value, DtFederateMgr* fedMgr, int verboseLevel);
202 #if defined(DtIFSPEC1516_2025)
203  DtMomArgument& assignVerbose(RTI_API::FederationExecutionMemberInformationVector const & value,
204  DtFederateMgr* fedMgr, int verboseLevel);
205 #endif
206 #if defined(DtIFSPEC1516)
207  DtMomArgument& assignVerbose(RTI_API::FederateHandleRestoreStatusPairVector const & value,
208  DtFederateMgr* fedMgr,int verboseLevel);
209 #else
210  DtMomArgument& assignVerbose(RTI_API::FederateRestoreStatusVector const & value,
211  DtFederateMgr* fedMgr, int verboseLevel);
212 #endif
213  DtMomArgument& assignVerbose(RTI_API::FederateHandleSaveStatusPairVector const & value,
214  DtFederateMgr* fedMgr, int verboseLevel);
215  DtMomArgument& assignVerbose(RTI_API::InteractionClassHandle value, DtInteractionClassInfo* classInfo,
216  int verboseLevel);
217  DtMomArgument& assignVerbose(RTI_API::ObjectClassHandle value, DtObjectClassInfo* classInfo,
218  int verboseLevel);
219  DtMomArgument& assignVerbose(RTI_API::ObjectInstanceHandle value, DtRtiObject* object,
220  int verboseLevel);
221  DtMomArgument& assignVerbose(RTI_API::ParameterHandle value, DtInteractionClassInfo* classInfo,
222  int verboseLevel);
223  DtMomArgument& assignVerbose(RTI_API::ParameterHandleValueMap const& value,
224  DtInteractionClassInfo* classInfo, int verboseLevel);
225  DtMomArgument& assignVerbose(RTI_API::VariableLengthData const & value, int verboseLevel);
226 
227 #if !defined(DtIFSPEC1516)
228  DtMomArgument& assignVerbose(RTI_API::FederationExecutionInformationVector const & value, int verboseLevel);
229 #if defined(DtIFSPEC1516E)
230  DtMomArgument& assignVerbose(RTI_API::SupplementalReflectInfo const& value, int verboseLevel);
231  DtMomArgument& assignVerbose(RTI_API::SupplementalReceiveInfo const& value, int verboseLevel);
232  DtMomArgument& assignVerbose(RTI_API::SupplementalRemoveInfo const & value, int verboseLevel);
233 #endif
234 #endif
235 
237 
238 
240 
241  void appendWithLabel(std::wstring const& label, std::wstring const& value);
242  void appendWithLabel(std::wstring const& label, const char* value);
243  void appendWithLabel(const char* label, std::wstring const& value);
244  void appendWithLabel(const char* label, const char* value);
246 
247 
248 protected:
249 
254 
255  DtMomArgument(char* value);
256  DtMomArgument(char const* value);
257  DtMomArgument& operator = (char const* value);
259 
261 
262 
263  bool tryAssignVerbose(RTI_API::AttributeHandle value, DtObjectClassInfo* classInfo, int verboseLevel);
264  bool tryAssignVerbose(RTI_API::AttributeHandleSet const & value,
265  DtObjectClassInfo* classInfo, int verboseLevel);
266  bool tryAssignVerbose(RTI_API::AttributeHandleSetRegionHandleSetPairVector const & value,
267  DtObjectClassInfo* classInfo, int verboseLevel);
268  bool tryAssignVerbose(RTI_API::AttributeHandleValueMap const& value, DtRtiObject* object,
269  int verboseLevel);
270  bool tryAssignVerbose(RTI_API::DimensionHandle const& value, DtFomClassMgr* fomMgr, int verboseLevel);
271  bool tryAssignVerbose(RTI_API::DimensionHandleSet const& value, DtFomClassMgr* fomMgr, int verboseLevel);
272  bool tryAssignVerbose(RTI_API::FederateHandle value, DtFederateMgr* fedMgr, int verboseLevel);
273  bool tryAssignVerbose(RTI_API::FederateHandleSet const& value, DtFederateMgr* fedMgr,
274  int verboseLevel);
275 #if defined(DtIFSPEC1516_2025)
276  bool tryAssignVerbose(RTI_API::FederationExecutionMemberInformationVector const & value,
277  DtFederateMgr* fedMgr, int verboseLevel);
278 #endif
279 #if defined(DtIFSPEC1516)
280  bool tryAssignVerbose(RTI_API::FederateHandleRestoreStatusPairVector const & value,
281  DtFederateMgr* fedMgr, int verboseLevel);
282 #else
283  bool tryAssignVerbose(RTI_API::FederateRestoreStatusVector const & value, DtFederateMgr* fedMgr,
284  int verboseLevel);
285 #endif
286  bool tryAssignVerbose(RTI_API::FederateHandleSaveStatusPairVector const & value,
287  DtFederateMgr* fedMgr, int verboseLevel);
288  bool tryAssignVerbose(RTI_API::InteractionClassHandle value, DtInteractionClassInfo* classInfo,
289  int verboseLevel);
290  bool tryAssignVerbose(RTI_API::ObjectClassHandle value, DtObjectClassInfo* classInfo, int verboseLevel);
291  bool tryAssignVerbose(RTI_API::ObjectInstanceHandle value, DtRtiObject* object,
292  int verboseLevel);
293  bool tryAssignVerbose(RTI_API::ParameterHandle value, DtInteractionClassInfo* classInfo,
294  int verboseLevel);
295  bool tryAssignVerbose(RTI_API::ParameterHandleValueMap const& value,
296  DtInteractionClassInfo* classInfo, int verboseLevel);
297  bool tryAssignVerbose(RTI_API::VariableLengthData const & value, int verboseLevel);
298 
299 #if !defined(DtIFSPEC1516)
300  bool tryAssignVerbose(RTI_API::FederationExecutionInformationVector const & value, int verboseLevel);
301 #if defined(DtIFSPEC1516E)
302  bool tryAssignVerbose(RTI_API::SupplementalReflectInfo const& value, int verboseLevel);
303  bool tryAssignVerbose(RTI_API::SupplementalReceiveInfo const& value, int verboseLevel);
304  bool tryAssignVerbose(RTI_API::SupplementalRemoveInfo const & value, int verboseLevel);
305 #endif
306 #endif
307 
309 
311  void appendAsHex(void const* data, unsigned long size);
312 
314 
315  void appendWithName(std::wstring const& name, std::wstring const& value);
316  void appendWithName(std::wstring const& name, const char* value);
317  void appendWithName(const char* name, std::wstring const& value);
318  void appendWithName(const char* name, const char* value);
320 
322  void appendWithSize(std::wstring const& value, unsigned long size);
323 
324 };
325 
326 typedef std::vector<DtMomArgument> DtMomArgumentList;
327 
328 #endif
329 
330 enum DtServiceGroup
332 {
333  DtServiceGroupFederation,
334  DtServiceGroupDeclaration,
335  DtServiceGroupObject,
336  DtServiceGroupOwnership,
337  DtServiceGroupTime,
338  DtServiceGroupDistribution,
339  DtServiceGroupSupport,
340  DtServiceGroupInvalid,
341  DtServiceGroupMax = DtServiceGroupInvalid
342 };
343 
344 
345 #endif
rti1516::FederateHandleSaveStatusPairVector
std::vector< FederateHandleSaveStatusPair > FederateHandleSaveStatusPairVector
Definition: Typedefs.h:57
rti1516_2025::fedpro::OrderType
OrderType
Definition: datatypes.pb.h:472
DtRtiApiTransportationType
RTI_API::TransportationTypeHandle DtRtiApiTransportationType
Definition: rtiApiTypes.h:114
rti1516::RegionHandleSet
std::set< RegionHandle > RegionHandleSet
Definition: Typedefs.h:31
DtFederateHandleSet
Definition: fedHandleSet.h:61
rti1516_2025::fedpro::ServiceGroup
ServiceGroup
Definition: datatypes.pb.h:497
rti1516_2025::fedpro::RestoreFailureReason
RestoreFailureReason
Definition: datatypes.pb.h:388
rti1516::DimensionHandleSet
std::set< DimensionHandle > DimensionHandleSet
Definition: Typedefs.h:30
rti1516_2025::fedpro::CallbackModel
CallbackModel
Definition: datatypes.pb.h:280
rti1516::FederateHandleRestoreStatusPairVector
std::vector< FederateHandleRestoreStatusPair > FederateHandleRestoreStatusPairVector
Definition: Typedefs.h:65
DtFederateMgr
Instances of DtFederateMgr process federation-level messages (such as create, destroy, join, resign, and sync points) and manages the objects responsible for handling general communication, objects, interactions, the FOM, MOM, and data distribution mmg.
Definition: fedMgr.h:93
DtAttributeHandleSet
Defines the internal representation of attribute/parameter handle sets.
Definition: attrHandSet.h:30
DtRtiObject
The RTI object maintains the internal RTI object state.
Definition: rtiObject.h:123
rti1516::ServiceGroupIndicator
ServiceGroupIndicator
Definition: Enums.h:64
rti1516::ParameterHandleValueMap
std::map< ParameterHandle, VariableLengthData > ParameterHandleValueMap
Definition: Typedefs.h:41
DtFomClassMgr
Definition: fomMgr.h:49
rti1516_2025::fedpro::SaveFailureReason
SaveFailureReason
Definition: datatypes.pb.h:359
rti1516::SynchronizationFailureReason
SynchronizationFailureReason
Definition: Enums.h:75
rti1516::AttributeHandleValueMap
std::map< AttributeHandle, VariableLengthData > AttributeHandleValueMap
Definition: Typedefs.h:36
DtObjectMgr
The object manager class processes the object management services.
Definition: objMgr.h:81
rti1516::AttributeHandleSet
std::set< AttributeHandle > AttributeHandleSet
Definition: Typedefs.h:27
rti1516_2025::fedpro::ResignAction
ResignAction
Definition: datatypes.pb.h:305
rti1516::AttributeHandleSetRegionHandleSetPairVector
std::vector< AttributeHandleSetRegionHandleSetPair > AttributeHandleSetRegionHandleSetPairVector
Definition: Typedefs.h:49
DtInteractionClassInfo
Definition: intClassInfo.h:40
DtAhvps
Definition: aHandValSet.h:33
rti1516::FederateHandleSet
std::set< FederateHandle > FederateHandleSet
Definition: Typedefs.h:29
DtPhvps
Definition: pHandValSet.h:38
internalTypes.h
The declaration of internal types.
DtObjectClassInfo
Definition: objClassInfo.h:36
FederateAmbassador.h
his file contains the rti1516_2025::FederateAmbassador class.
rti1516_2025::fedpro::SynchronizationPointFailureReason
SynchronizationPointFailureReason
Definition: datatypes.pb.h:334
RangeBounds.h
This file contains the interface for DDM region ranges.
Document ID: Generated on Sun Jul 20 16:15:30 EDT 2025 from SVN revision 277985
Copyright © 2005-2025 MAK Technologies Inc. All Rights Reserved (www.mak.com)