VR-Link API Documentation for HLA Evolved
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
recordRInteractionHLA.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1992-2010 VT MAK
3 ** All rights reserved.
4 *********************************************************************/
5 
6 
7 
8 #ifndef recordRInteractionHLA_H_
9 #define recordRInteractionHLA_H_
10 
11 #if DtHLA
12 
13 #include "interactionWithData.h"
14 #include "vlpi/recordSetList.h"
15 
19 
22 
24 typedef void (*DtRecordRInteractionCb)
25  (DtRecordRInteraction* inter, void *user);
26 
31 
33 {
34 public:
35 
38 
41  (const DtRecordRInteraction& other);
42 
44  virtual ~DtRecordRInteraction();
45 
47  DtRecordRInteraction& operator=
48  (const DtRecordRInteraction& other);
49 
51  virtual void printData() const;
52 
54  virtual void printDataToStream(std::ostream& stream) const;
55 
57  virtual void setOriginatingEntityID(const DtEntityIdentifier& entity);
58  virtual const DtEntityIdentifier& originatingEntityID() const;
59 
61  virtual void setReceivingEntityID(const DtEntityIdentifier &entity);
62  virtual const DtEntityIdentifier receivingEntityID() const;
63 
65  virtual void setRequestID(DtU32 id);
66  virtual DtU32 requestID() const;
67 
69  virtual void setReqRelService(enum DtRequiredReliabilityService service);
70  virtual DtRequiredReliabilityService reqRelService() const;
71 
73  virtual void setEventType(DtEventType type);
74  virtual DtEventType eventType() const;
75 
77  virtual void setResponseSerialNumber(DtU32 num);
78  virtual DtU32 responseSerialNumber() const;
79 
83  virtual void setNumRecordSets(DtU32 number);
84  virtual DtU32 numRecordSets() const;
85 
88  virtual bool setRecordSet(int index, const DtRecordSet &set);
89  virtual const DtRecordSet &recordSet(int index,
90  bool *valid = NULL);
91 
93  virtual bool getRecordSet(int index, DtRecordSet& recSet) const;
94 
96  virtual const DtRecordSetList &recordSetList() const;
97  virtual DtRecordSetList *recordSetList();
98 
101  virtual const char* name() const;
102 
103 public:
106  static DtInteraction* create();
107 
110  static void addCallback(DtExerciseConn *conn,
111  DtRecordRInteractionCb cb, void *usr,
112  DtDDMRegionSP region = DtDDMRegionSP());
113  static void removeCallback(DtExerciseConn *conn,
114  DtRecordRInteractionCb cb, void *usr,
115  DtDDMRegionSP region = DtDDMRegionSP());
116 
117 protected:
118 
126 
127 };
128 
133  (const DtEntityIdentifier& id)
134 {
135  myOriginatingEnt = id;
136 }
137 
139 {
140  return myOriginatingEnt;
141 }
142 
144  const DtEntityIdentifier &id)
145 {
146  myReceivingEnt = id;
147 }
148 
150 {
151  return myReceivingEnt;
152 }
153 
155 {
156  myRequestId = id;
157 }
158 
160 {
161  return myRequestId;
162 }
163 
165  enum DtRequiredReliabilityService service)
166 {
168 }
169 
171 {
173 }
174 
176 {
177  myEventType = type;
178 }
179 
181 {
182  return myEventType;
183 }
184 
186 {
188 }
189 
191 {
192  return myResponceSerialNumber;
193 }
194 
196 {
197  return myRecordSetList;
198 }
199 
201 {
202  return &myRecordSetList;
203 }
204 
205 inline const char* DtRecordRInteraction::name() const
206 {
207  return "DtRecordRInteraction";
208 }
209 
210 #endif
211 #endif
212 
DtInteraction is an abstract base class for representing HLA interactions (or events) (as opposed to ...
Definition: interactionHLA.h:33
DtRequiredReliabilityService
Reliable service PDU enums.
Definition: disEnums.h:2401
virtual void setResponseSerialNumber(DtU32 num)
Set/Get the response serial number.
Definition: recordRInteractionHLA.h:185
virtual DtEventType eventType() const
Definition: recordRInteractionHLA.h:180
virtual void setEventType(DtEventType type)
Set/Get the event type.
Definition: recordRInteractionHLA.h:175
DtEntityIdentifier myReceivingEnt
Definition: recordRInteractionHLA.h:120
Instances of DtExerciseConn are used to provide an application's interface or connection to the netwo...
Definition: exerciseConnHLA.h:58
#define DT_DLL_VL
Definition: vlMachineTypes.h:108
virtual DtU32 requestID() const
Definition: recordRInteractionHLA.h:159
DtRequiredReliabilityService myRequiredReliabilityService
Definition: recordRInteractionHLA.h:124
virtual void setOriginatingEntityID(const DtEntityIdentifier &entity)
Set/Get originator ID.
Definition: recordRInteractionHLA.h:133
void(* DtRecordRInteractionCb)(DtRecordRInteraction *inter, void *user)
RecordR interaction callback function signature.
Definition: recordRInteractionHLA.h:25
DtU32 myRequestId
Definition: recordRInteractionHLA.h:121
Instances of DtRecordSetList are lists of RecordSets.
Definition: vlpi/recordSetList.h:17
DtU32 myResponceSerialNumber
Definition: recordRInteractionHLA.h:123
virtual const char * name() const
name of the interaction.
Definition: recordRInteractionHLA.h:205
class DtRecordRInteraction:
Definition: recordRInteractionHLA.h:32
This file provides a declaration of the class DtInteractionWithData.
virtual const DtRecordSetList & recordSetList() const
They exist for the mapper to use for conversion to net data.
Definition: recordRInteractionHLA.h:195
DtEntityIdentifier myOriginatingEnt
Definition: recordRInteractionHLA.h:119
DtRecordSetList myRecordSetList
Definition: recordRInteractionHLA.h:125
static void removeCallback(DtExerciseConn *conn, const std::vector< DtString > *classes, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
Instances of DtRecordSet are used to contain the record sets used by the PDU classes which inherit fr...
Definition: recordSet.h:38
virtual void printData() const
Print the interaction&#39;s data to DtInfo.
Definition: interactionHLA.h:349
virtual void setRequestID(DtU32 id)
Set/Get request ID.
Definition: recordRInteractionHLA.h:154
virtual void setReqRelService(enum DtRequiredReliabilityService service)
Set/Get required reliability service.
Definition: recordRInteractionHLA.h:164
virtual void printDataToStream(std::ostream &stream) const
Print the interaction&#39;s data to the stream.
Definition: interactionHLA.h:357
virtual const char * name() const =0
Name of the interaction. (Not necessarily the ClassName from the FOM.)
static void addCallback(DtExerciseConn *conn, const std::vector< DtString > *classes, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
Register/Deregister callback function cb with conn, on all interaction class name (char*) contained i...
Instances of DtEntityIdentifier are used as a unique ID for entities in DIS.
Definition: entityIdentifier.h:31
DtBoost::shared_ptr< DtDDMRegion > DtDDMRegionSP
Definition: region13.h:31
virtual DtRequiredReliabilityService reqRelService() const
Definition: recordRInteractionHLA.h:170
DtEventType
Definition: disEnums.h:479
virtual const DtEntityIdentifier receivingEntityID() const
Definition: recordRInteractionHLA.h:149
class DtInteractionWithEncDec:
Definition: interactionWithEncDec.h:44
unsigned long DtU32
A 32 bit unsigned integer value.
Definition: vlMachineTypes.h:153
DtEventType myEventType
Definition: recordRInteractionHLA.h:122
virtual void setReceivingEntityID(const DtEntityIdentifier &entity)
Set/Get receiver ID.
Definition: recordRInteractionHLA.h:143
virtual const DtEntityIdentifier & originatingEntityID() const
Definition: recordRInteractionHLA.h:138
virtual DtU32 responseSerialNumber() const
Definition: recordRInteractionHLA.h:190

Document ID: Generated on Tue Aug 10 00:12:31 EDT 2021 from SVN revision 232765
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)