VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
interactionHLA.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1992-2010 VT MAK
3 ** All rights reserved.
4 *********************************************************************/
5 
6 #ifndef interactionHLA_H_
7 #define interactionHLA_H_
8 
9 
10 
11 #if DtHLA
12 
13 
14 
15 #include "receiveInteractionCbInfo.h"
16 
17 #include <vlutil/vlTimeStampType.h>
18 #include <vlutil/vlTime.h>
19 #include <vlutil/vlString.h>
20 #include <vl/interClassDesc.h>
21 
22 
23 class DT_DLL_VL DtInterClassDesc;
24 class DT_DLL_VL DtExerciseConn;
25 class DT_DLL_VL DtList;
26 
33 class DT_DLL_VL DtInteraction
34 {
35 public:
36 
38  DtInteraction();
39 
41  virtual ~DtInteraction();
42 
44  DtInteraction(const DtInteraction& orig);
45 
47  DtInteraction& operator=(const DtInteraction& orig);
48 
49 #if DtHLA_1516
50 
51  virtual const RTI::ParameterHandleValueMap& phvm() const = 0;
52 #else
53 
54  virtual const RTI::ParameterHandleValuePairSet& phvps() const = 0;
55 #endif
56 
57 #if DtHLA_1516
58 
59  virtual void setFromPhvm(const RTI::ParameterHandleValueMap& pvList)=0;
60 #else
61 
62  virtual void setFromPhvps(const RTI::ParameterHandleValuePairSet& pvList)=0;
63 #endif
64 
73  virtual void setExConn(DtExerciseConn* exConn,
74  DtInterClassDesc* classDesc = 0);
75 
77  virtual RTI::InteractionClassHandle interactionClassHandle() const;
78 
80  virtual char* interactionClassName() const;
81 
83  virtual int numParameters() const;
84 
87  virtual bool neededByFederation() const;
88 
90  virtual void print() const;
91 
93  virtual void printToStream(std::ostream& stream) const;
94 
96  virtual void printHeader() const;
97 
99  virtual void printHeaderToStream(std::ostream& stream) const;
100 
102  virtual void printData() const;
103 
105  virtual void printDataToString(DtString& buff) const;
106 
108  virtual void printDataToStream(std::ostream& stream) const;
109 
111  virtual void printParams(bool withHex) const;
112 
114  virtual void printParamsToStream(std::ostream& stream, bool withHex) const;
115 
117  virtual const char* name() const = 0;
118 
120  virtual DtExerciseConn* exerciseConn() const;
121 
124  virtual DtInterClassDesc* classDesc() const;
125 
127  virtual bool customTagSet() const;
128 
129 
130 #if DtHLA_1516
131 
132  virtual void setCustomTag(const RTI::VariableLengthData& a_tag);
134  virtual void setTag(const RTI::VariableLengthData& tag);
136  virtual const RTI::VariableLengthData &tag() const;
137 #else
138 
139  virtual void setCustomTag(const DtString& a_tag);
141  virtual void setTag(const DtString& tag);
143  virtual const DtString& tag() const;
144 #endif
145 
151 #if DtHLA_1516
152  virtual const RTI::RegionHandleSet* conveyedRegion() const;
153  virtual void setConveyedRegion(const RTI::RegionHandleSet* sentRegionHandleSet);
154 #else
155  virtual const RTI::Region* conveyedRegion() const;
156  virtual void setConveyedRegion(const RTI::Region* region);
157 #endif
158 
159 #if DtHLA_1516_EVOLVED
160 
161 
162 
163 
164 
165  virtual void setProducingFederateHandle(RTI::FederateHandle federateHandle);
166 
168  virtual RTI::FederateHandle producingFederateHandle() const;
169 
172  virtual const DtString& producingFederateName() const;
173 #endif
174 
175 
179  virtual void setTimeStamp(DtTime time,
180  DtTimeStampType type = DtTimeStampRelative);
181 
184  virtual DtTime timeStamp() const;
185 
187  virtual DtTimeStampType timeStampType() const;
188 
193  virtual DtTime guessTimeValid(DtTime referenceTime) const;
194 
199 #if DtHLA_1516
200  virtual void setFedTime(const RTI::LogicalTime &ft);
201 #else
202  virtual void setFedTime(const RTI::FedTime &ft);
203 #endif
204 
208 #if DtHLA_1516
209  virtual const RTI::LogicalTime *fedTime() const;
210 #else
211  virtual const RTI::FedTime *fedTime() const;
212 #endif
213 
214 #if DtHLA_1516
215 
216 
217  virtual void setMessageRetractionHandle(const RTI::MessageRetractionHandle &handle);
218 
220  virtual RTI::MessageRetractionHandle messageRetractionHandle() const;
221 
222 #else
223 
224 
225  virtual void setEventRetractionHandle(const RTI::EventRetractionHandle &handle);
226 
228  virtual RTI::EventRetractionHandle eventRetractionHandle() const;
229 #endif
230 
231 
232 public:
233 
237  static void setTagIsAsciiTime(bool val);
238  static bool tagIsAsciiTime();
239 
242  static void addCallback(DtExerciseConn* conn,
243  const std::set<DtString>* classes, DtReceiveInteractionCb cb, void* usr,
244  DtDDMRegionSP region = DtDDMRegionSP());
245  static void removeCallback(DtExerciseConn* conn,
246  const std::set<DtString>* classes, DtReceiveInteractionCb cb, void* usr,
247  DtDDMRegionSP region = DtDDMRegionSP());
248 
250  static void addCallback(DtExerciseConn* conn,
251  const char* className, DtReceiveInteractionCb cb, void* usr,
252  DtDDMRegionSP region = DtDDMRegionSP());
253  static void removeCallback(DtExerciseConn* conn,
254  const char* className, DtReceiveInteractionCb cb, void* usr,
255  DtDDMRegionSP region = DtDDMRegionSP());
256 
257 protected:
258 
261  virtual const char* interactionClassToUse(DtExerciseConn* exConn) const;
262 
266 #if DtHLA_1516
267  virtual RTI::ParameterHandleValueMap &privPvList() const;
268 #else
269  virtual RTI::ParameterHandleValuePairSet* privPvList() const;
270 #endif
271 
279  DtInteraction* self() const;
280 
281 protected:
282 
283  DtInterClassDesc* myClassDesc;
284  DtExerciseConn* myExConn;
285  DtTime myTime;
286  DtTimeStampType myTimeType;
287 
288 #if DtHLA_1516
289  RTI::LogicalTime *myFedTime;
290  RTI::ParameterHandleValueMap myPvList;
291  RTI::MessageRetractionHandle myRetractionHandle;
292  RTI::VariableLengthData myTag;
293  const RTI::RegionHandleSet* myConveyedRegion;
294 #if DtHLA_1516_EVOLVED
295  mutable DtString myProducingFederateName;
296  RTI::FederateHandle myProducingFederateHandle;
297 #endif
298 #else
299  DtString myTag;
300  RTI::ParameterHandleValuePairSet* myPvList;
301  int myPvListMaxSize;
302  RTI::FedTime *myFedTime;
303  RTI::EventRetractionHandle myRetractionHandle;
304  const RTI::Region* myConveyedRegion;
305 #endif
306 
307  bool myCustomTagSet;
308 
309 
310 protected:
311 
312  static bool theTagIsAsciiTime;
313 };
314 
315 DT_DLL_VL std::ostream & operator << (std::ostream &str, const DtInteraction &inter);
316 
317 inline RTI::InteractionClassHandle
318  DtInteraction::interactionClassHandle() const
319 {
320  return myClassDesc->handle();
321 }
322 
323 inline char* DtInteraction::interactionClassName() const
324 {
325  return (char*) (myClassDesc ? myClassDesc->name() : 0);
326 }
327 
328 inline int DtInteraction::numParameters() const
329 {
330  return myClassDesc ? myClassDesc->numParameters() : 0;
331 }
332 
333 inline DtInteraction* DtInteraction::self() const
334 {
335  return (DtInteraction*) this;
336 }
337 
338 inline DtExerciseConn* DtInteraction::exerciseConn() const
339 {
340  return myExConn;
341 }
342 
343 inline DtInterClassDesc* DtInteraction::classDesc() const
344 {
345  return myClassDesc;
346 }
347 
348 inline void DtInteraction::printData() const
349 {
350 }
351 
352 inline void DtInteraction::printDataToString(DtString& buff) const
353 {
354 }
355 
356 inline void DtInteraction::printDataToStream(std::ostream& stream) const
357 {
358 }
359 
360 #if DtHLA_1516
361 inline void DtInteraction::setMessageRetractionHandle(
362  const RTI::MessageRetractionHandle &handle)
363 {
364  myRetractionHandle = handle;
365 }
366 
367 inline RTI::MessageRetractionHandle DtInteraction::messageRetractionHandle() const
368 {
369  return myRetractionHandle;
370 }
371 
372 #else
373 inline void DtInteraction::setEventRetractionHandle(
374  const RTI::EventRetractionHandle &handle)
375 {
376  myRetractionHandle = handle;
377 }
378 
379 inline RTI::EventRetractionHandle DtInteraction::eventRetractionHandle() const
380 {
381  return myRetractionHandle;
382 }
383 #endif
384 
385 #endif
386 #endif
387 
388 
Document ID: Generated on Tue Mar 1 02:56:17 EST 2016 from SVN revision 162687
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)