MAK RTIspy API Documentation for HLA Evolved
 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(DtIFSPEC1516) && !defined(DtIFSPEC1516E)
13 
14 #include "momNetParam.h"
15 
16 #define DtMomArgument DtMomNetParameter
17 
18 #else
19 
20 
21 #include "rtiMsConfig.h"
22 #include <vlutil/vlBaseMsg.h>
23 #include <vlutil/vlString.h>
24 #include "internalTypes.h"
25 #include <RTI/Typedefs.h>
26 #include <RTI/RangeBounds.h>
27 #include <RTI/LogicalTime.h>
28 #include <RTI/LogicalTimeInterval.h>
29 #include <RTI/FederateAmbassador.h>
30 #include <string>
31 #include <vector>
32 
33 class DtFederateMgr;
34 class DtMomMgr;
35 class DtObjectMgr;
36 class DtFomClassMgr;
37 class DtObjectClassInfo;
38 class DtInteractionClassInfo;
39 class DtRtiObject;
40 class DtFederateHandleSet;
41 class DtAttributeHandleSet;
42 class DtAhvps;
43 class DtPhvps;
44 
45 #if defined(DtIFSPEC1516)
46 #define RTI_PREFIX rti1516
47 #else
48 #define RTI_PREFIX rti1516e
49 #endif
50 
51 class DtMomArgument : public std::wstring
52 {
53 public:
54 
55  virtual ~DtMomArgument();
56 
58  DtMomArgument(const DtMomArgument& orig);
59 
61 
62  DtMomArgument();
63  DtMomArgument(bool value);
64  DtMomArgument(double value);
65  DtMomArgument(unsigned long value);
66  DtMomArgument(wchar_t const * value);
67  DtMomArgument(std::wstring const & value);
68  DtMomArgument(std::vector<std::wstring> const & value);
69  DtMomArgument(std::set<std::wstring> const & value);
70  DtMomArgument(RTI_PREFIX::AttributeHandle value);
71  DtMomArgument(RTI_PREFIX::AttributeHandleSet const & value);
72  DtMomArgument(RTI_PREFIX::AttributeHandleSetRegionHandleSetPairVector const & value);
73  DtMomArgument(RTI_PREFIX::AttributeHandleValueMap const& value);
74  DtMomArgument(RTI_PREFIX::DimensionHandle const& value);
75  DtMomArgument(RTI_PREFIX::DimensionHandleSet const& value);
76  DtMomArgument(RTI_PREFIX::FederateAmbassador & value);
77  DtMomArgument(RTI_PREFIX::FederateHandle value);
78 #if defined(DtIFSPEC1516)
79  DtMomArgument(RTI_PREFIX::FederateHandleRestoreStatusPairVector const & value);
80 #else
81  DtMomArgument(RTI_PREFIX::FederateRestoreStatusVector const & value);
82 #endif
83  DtMomArgument(RTI_PREFIX::FederateHandleSaveStatusPairVector const & value);
84  DtMomArgument(RTI_PREFIX::FederateHandleSet const& value);
85  DtMomArgument(RTI_PREFIX::InteractionClassHandle value);
86  DtMomArgument(RTI_PREFIX::LogicalTime const& value);
87  DtMomArgument(RTI_PREFIX::LogicalTimeInterval const& value);
88  DtMomArgument(RTI_PREFIX::MessageRetractionHandle const & value);
89  DtMomArgument(RTI_PREFIX::ObjectClassHandle value);
90  DtMomArgument(RTI_PREFIX::ObjectInstanceHandle value);
91  DtMomArgument(RTI_PREFIX::OrderType value);
92  DtMomArgument(RTI_PREFIX::ParameterHandle value);
93  DtMomArgument(RTI_PREFIX::ParameterHandleValueMap const& value);
94  DtMomArgument(RTI_PREFIX::RangeBounds const & value);
95  DtMomArgument(RTI_PREFIX::RegionHandle value);
96  DtMomArgument(RTI_PREFIX::RegionHandleSet const & value);
97  DtMomArgument(RTI_PREFIX::ResignAction value);
98  DtMomArgument(RTI_PREFIX::RestoreFailureReason value);
99  DtMomArgument(RTI_PREFIX::SaveFailureReason value);
100 #if defined(DtIFSPEC1516)
101  DtMomArgument(RTI_PREFIX::ServiceGroupIndicator value);
102  DtMomArgument(RTI_PREFIX::SynchronizationFailureReason value);
103 #else
104  DtMomArgument(RTI_PREFIX::ServiceGroup value);
105  DtMomArgument(RTI_PREFIX::SynchronizationPointFailureReason value);
106 #endif
107  DtMomArgument(RTI_PREFIX::TransportationType value);
108  DtMomArgument(RTI_PREFIX::VariableLengthData const & value);
109 
110 #if defined(DtIFSPEC1516E)
111  DtMomArgument(RTI_PREFIX::CallbackModel value);
112  DtMomArgument(RTI_PREFIX::SupplementalReflectInfo const & value);
113  DtMomArgument(RTI_PREFIX::SupplementalReceiveInfo const & value);
114  DtMomArgument(RTI_PREFIX::SupplementalRemoveInfo const & value);
115  DtMomArgument(RTI_PREFIX::FederationExecutionInformationVector const & value);
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_PREFIX::AttributeHandle value);
131  DtMomArgument& operator = (RTI_PREFIX::AttributeHandleSet const & value);
132  DtMomArgument& operator = (RTI_PREFIX::AttributeHandleSetRegionHandleSetPairVector const & value);
133  DtMomArgument& operator = (RTI_PREFIX::AttributeHandleValueMap const& value);
134  DtMomArgument& operator = (RTI_PREFIX::DimensionHandle const& value);
135  DtMomArgument& operator = (RTI_PREFIX::DimensionHandleSet const& value);
136  DtMomArgument& operator = (RTI_PREFIX::FederateAmbassador & value);
137  DtMomArgument& operator = (RTI_PREFIX::FederateHandle value);
138  DtMomArgument& operator = (RTI_PREFIX::FederateHandleSet const& value);
139 #if defined(DtIFSPEC1516)
140  DtMomArgument& operator = (RTI_PREFIX::FederateHandleRestoreStatusPairVector const & value);
141 #else
142  DtMomArgument& operator = (RTI_PREFIX::FederateRestoreStatusVector const & value);
143 #endif
144  DtMomArgument& operator = (RTI_PREFIX::FederateHandleSaveStatusPairVector const & value);
145  DtMomArgument& operator = (RTI_PREFIX::InteractionClassHandle value);
146  DtMomArgument& operator = (RTI_PREFIX::LogicalTime const& value);
147  DtMomArgument& operator = (RTI_PREFIX::LogicalTimeInterval const& value);
148  DtMomArgument& operator = (RTI_PREFIX::MessageRetractionHandle const & value);
149  DtMomArgument& operator = (RTI_PREFIX::ObjectClassHandle value);
150  DtMomArgument& operator = (RTI_PREFIX::ObjectInstanceHandle value);
151  DtMomArgument& operator = (RTI_PREFIX::OrderType value);
152  DtMomArgument& operator = (RTI_PREFIX::ParameterHandle value);
153  DtMomArgument& operator = (RTI_PREFIX::ParameterHandleValueMap const& value);
154  DtMomArgument& operator = (RTI_PREFIX::RangeBounds const & value);
155  DtMomArgument& operator = (RTI_PREFIX::RegionHandle value);
156  DtMomArgument& operator = (RTI_PREFIX::RegionHandleSet const & value);
157  DtMomArgument& operator = (RTI_PREFIX::ResignAction value);
158  DtMomArgument& operator = (RTI_PREFIX::RestoreFailureReason value);
159  DtMomArgument& operator = (RTI_PREFIX::SaveFailureReason value);
160 #if defined(DtIFSPEC1516)
161  DtMomArgument& operator = (RTI_PREFIX::ServiceGroupIndicator value);
162 #else
163  DtMomArgument& operator = (RTI_PREFIX::ServiceGroup value);
164 #endif
165 #if defined(DtIFSPEC1516)
166  DtMomArgument& operator = (RTI_PREFIX::SynchronizationFailureReason value);
167 #else
168  DtMomArgument& operator = (RTI_PREFIX::SynchronizationPointFailureReason value);
169 #endif
170  DtMomArgument& operator = (RTI_PREFIX::TransportationType value);
171  DtMomArgument& operator = (RTI_PREFIX::VariableLengthData const & value);
172 
173 #if defined(DtIFSPEC1516E)
174  DtMomArgument& operator = (RTI_PREFIX::CallbackModel value);
175  DtMomArgument& operator = (RTI_PREFIX::SupplementalReflectInfo const & value);
176  DtMomArgument& operator = (RTI_PREFIX::SupplementalReceiveInfo const & value);
177  DtMomArgument& operator = (RTI_PREFIX::SupplementalRemoveInfo const & value);
178  DtMomArgument& operator = (RTI_PREFIX::FederationExecutionInformationVector const & value);
179 #endif
180 
182 
184 
185 
186  DtMomArgument& assignVerbose(RTI_PREFIX::AttributeHandle value, DtObjectClassInfo* classInfo, int verboseLevel);
187  DtMomArgument& assignVerbose(RTI_PREFIX::AttributeHandleSet const & value,
188  DtObjectClassInfo* classInfo, int verboseLevel);
189  DtMomArgument& assignVerbose(RTI_PREFIX::AttributeHandleSetRegionHandleSetPairVector const & value,
190  DtObjectClassInfo* classInfo, int verboseLevel);
191  DtMomArgument& assignVerbose(RTI_PREFIX::AttributeHandleValueMap const& value, DtRtiObject* object,
192  int verboseLevel);
193  DtMomArgument& assignVerbose(RTI_PREFIX::DimensionHandle const& value, DtFomClassMgr* fomMgr, int verboseLevel);
194  DtMomArgument& assignVerbose(RTI_PREFIX::DimensionHandleSet const& value, DtFomClassMgr* fomMgr, int verboseLevel);
195  DtMomArgument& assignVerbose(RTI_PREFIX::FederateHandle value, DtFederateMgr* fedMgr, int verboseLevel);
196  DtMomArgument& assignVerbose(RTI_PREFIX::FederateHandleSet const& value, DtFederateMgr* fedMgr, int verboseLevel);
197 #if defined(DtIFSPEC1516)
198  DtMomArgument& assignVerbose(RTI_PREFIX::FederateHandleRestoreStatusPairVector const & value,
199  DtFederateMgr* fedMgr,int verboseLevel);
200 #else
201  DtMomArgument& assignVerbose(RTI_PREFIX::FederateRestoreStatusVector const & value,
202  DtFederateMgr* fedMgr, int verboseLevel);
203 #endif
204  DtMomArgument& assignVerbose(RTI_PREFIX::FederateHandleSaveStatusPairVector const & value,
205  DtFederateMgr* fedMgr, int verboseLevel);
206  DtMomArgument& assignVerbose(RTI_PREFIX::InteractionClassHandle value, DtInteractionClassInfo* classInfo,
207  int verboseLevel);
208  DtMomArgument& assignVerbose(RTI_PREFIX::ObjectClassHandle value, DtObjectClassInfo* classInfo,
209  int verboseLevel);
210  DtMomArgument& assignVerbose(RTI_PREFIX::ObjectInstanceHandle value, DtRtiObject* object,
211  int verboseLevel);
212  DtMomArgument& assignVerbose(RTI_PREFIX::ParameterHandle value, DtInteractionClassInfo* classInfo,
213  int verboseLevel);
214  DtMomArgument& assignVerbose(RTI_PREFIX::ParameterHandleValueMap const& value,
215  DtInteractionClassInfo* classInfo, int verboseLevel);
216  DtMomArgument& assignVerbose(RTI_PREFIX::VariableLengthData const & value, int verboseLevel);
217 
218 #if defined(DtIFSPEC1516E)
219  DtMomArgument& assignVerbose(RTI_PREFIX::SupplementalReflectInfo const & value, int verboseLevel);
220  DtMomArgument& assignVerbose(RTI_PREFIX::SupplementalReceiveInfo const & value, int verboseLevel);
221  DtMomArgument& assignVerbose(RTI_PREFIX::SupplementalRemoveInfo const & value, int verboseLevel);
222  DtMomArgument& assignVerbose(RTI_PREFIX::FederationExecutionInformationVector const & value,
223  int verboseLevel);
224 #endif
225 
227 
228 
230 
231  void appendWithLabel(std::wstring const& label, std::wstring const& value);
232  void appendWithLabel(std::wstring const& label, const char* value);
233  void appendWithLabel(const char* label, std::wstring const& value);
234  void appendWithLabel(const char* label, const char* value);
236 
237 
238 protected:
239 
244 
245  DtMomArgument(char* value);
246  DtMomArgument(char const* value);
247  DtMomArgument& operator = (char const* value);
249 
251 
252 
253  bool tryAssignVerbose(RTI_PREFIX::AttributeHandle value, DtObjectClassInfo* classInfo, int verboseLevel);
254  bool tryAssignVerbose(RTI_PREFIX::AttributeHandleSet const & value,
255  DtObjectClassInfo* classInfo, int verboseLevel);
256  bool tryAssignVerbose(RTI_PREFIX::AttributeHandleSetRegionHandleSetPairVector const & value,
257  DtObjectClassInfo* classInfo, int verboseLevel);
258  bool tryAssignVerbose(RTI_PREFIX::AttributeHandleValueMap const& value, DtRtiObject* object,
259  int verboseLevel);
260  bool tryAssignVerbose(RTI_PREFIX::DimensionHandle const& value, DtFomClassMgr* fomMgr, int verboseLevel);
261  bool tryAssignVerbose(RTI_PREFIX::DimensionHandleSet const& value, DtFomClassMgr* fomMgr, int verboseLevel);
262  bool tryAssignVerbose(RTI_PREFIX::FederateHandle value, DtFederateMgr* fedMgr, int verboseLevel);
263  bool tryAssignVerbose(RTI_PREFIX::FederateHandleSet const& value, DtFederateMgr* fedMgr,
264  int verboseLevel);
265 #if defined(DtIFSPEC1516)
266  bool tryAssignVerbose(RTI_PREFIX::FederateHandleRestoreStatusPairVector const & value,
267  DtFederateMgr* fedMgr, int verboseLevel);
268 #else
269  bool tryAssignVerbose(RTI_PREFIX::FederateRestoreStatusVector const & value, DtFederateMgr* fedMgr,
270  int verboseLevel);
271 #endif
272  bool tryAssignVerbose(RTI_PREFIX::FederateHandleSaveStatusPairVector const & value,
273  DtFederateMgr* fedMgr, int verboseLevel);
274  bool tryAssignVerbose(RTI_PREFIX::InteractionClassHandle value, DtInteractionClassInfo* classInfo,
275  int verboseLevel);
276  bool tryAssignVerbose(RTI_PREFIX::ObjectClassHandle value, DtObjectClassInfo* classInfo, int verboseLevel);
277  bool tryAssignVerbose(RTI_PREFIX::ObjectInstanceHandle value, DtRtiObject* object,
278  int verboseLevel);
279  bool tryAssignVerbose(RTI_PREFIX::ParameterHandle value, DtInteractionClassInfo* classInfo,
280  int verboseLevel);
281  bool tryAssignVerbose(RTI_PREFIX::ParameterHandleValueMap const& value,
282  DtInteractionClassInfo* classInfo, int verboseLevel);
283  bool tryAssignVerbose(RTI_PREFIX::VariableLengthData const & value, int verboseLevel);
284 
285 #if defined(DtIFSPEC1516E)
286  bool tryAssignVerbose(RTI_PREFIX::SupplementalReflectInfo const & value, int verboseLevel);
287  bool tryAssignVerbose(RTI_PREFIX::SupplementalReceiveInfo const & value, int verboseLevel);
288  bool tryAssignVerbose(RTI_PREFIX::SupplementalRemoveInfo const & value, int verboseLevel);
289  bool tryAssignVerbose(RTI_PREFIX::FederationExecutionInformationVector const & value,
290  int verboseLevel);
291 #endif
292 
294 
296  void appendAsHex(void const* data, unsigned long size);
297 
299 
300  void appendWithName(std::wstring const& name, std::wstring const& value);
301  void appendWithName(std::wstring const& name, const char* value);
302  void appendWithName(const char* name, std::wstring const& value);
303  void appendWithName(const char* name, const char* value);
305 
307  void appendWithSize(std::wstring const& value, unsigned long size);
308 
309 };
310 
311 typedef std::vector<DtMomArgument> DtMomArgumentList;
312 
313 #undef RTI_PREFIX
314 
315 #endif
316 #endif
rti1516e::RestoreFailureReason
RestoreFailureReason
Definition: Enums.h:43
rti1516e::SynchronizationPointFailureReason
SynchronizationPointFailureReason
Definition: Enums.h:91
rti1516e::AttributeHandleSet
std::set< AttributeHandle > AttributeHandleSet
Definition: Typedefs.h:35
DtFederateHandleSet
Definition: fedHandleSet.h:102
LogicalTime.h
rti1516e::SaveFailureReason
SaveFailureReason
Definition: Enums.h:62
rti1516e::FederationExecutionInformationVector
std::vector< FederationExecutionInformation > FederationExecutionInformationVector
Definition: Typedefs.h:99
rti1516e::ResignAction
ResignAction
Definition: Enums.h:33
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:84
DtAttributeHandleSet
Definition: attrHandSet.h:37
rti1516e::RegionHandleSet
std::set< RegionHandle > RegionHandleSet
Definition: Typedefs.h:39
DtRtiObject
The RTI object maintains the internal RTI object state.
Definition: rtiObject.h:116
Typedefs.h
This file contains the standard RTI types that are defined in namespace rti1516.
DtFomClassMgr
Definition: fomMgr.h:53
rti1516e::AttributeHandleSetRegionHandleSetPairVector
std::vector< AttributeHandleSetRegionHandleSetPair > AttributeHandleSetRegionHandleSetPairVector
Definition: Typedefs.h:57
rti1516e::FederateHandleSaveStatusPairVector
std::vector< FederateHandleSaveStatusPair > FederateHandleSaveStatusPairVector
Definition: Typedefs.h:65
rti1516e::OrderType
OrderType
Definition: Enums.h:27
DtObjectMgr
The object manager class processes the object management services.
Definition: objMgr.h:90
rti1516e::ServiceGroup
ServiceGroup
Definition: Enums.h:80
rti1516e::CallbackModel
CallbackModel
Definition: Enums.h:21
rti1516e::AttributeHandleValueMap
std::map< AttributeHandle, VariableLengthData > AttributeHandleValueMap
Definition: Typedefs.h:44
DtInteractionClassInfo
Definition: intClassInfo.h:41
rti1516e::FederateHandleSet
std::set< FederateHandle > FederateHandleSet
Definition: Typedefs.h:37
rti1516e::TransportationType
TransportationType
Definition: Enums.h:97
internalTypes.h
The declaration of internal types.
DtObjectClassInfo
Definition: objClassInfo.h:37
LogicalTimeInterval.h
rti1516e::FederateRestoreStatusVector
std::vector< FederateRestoreStatus > FederateRestoreStatusVector
Definition: Typedefs.h:83
FederateAmbassador.h
his file contains the rti1516e::FederateAmbassador class.
RangeBounds.h
This file contains the interface for DDM region ranges.
rti1516e::DimensionHandleSet
std::set< DimensionHandle > DimensionHandleSet
Definition: Typedefs.h:38
rti1516e::ParameterHandleValueMap
std::map< ParameterHandle, VariableLengthData > ParameterHandleValueMap
Definition: Typedefs.h:49
Document ID: Generated on Mon Sep 7 15:40:32 EDT 2020 from SVN revision 217499
Copyright © 2005-2020 MAK Technologies Inc. All Rights Reserved (www.mak.com)