VR-Link API Documentation for DIS
 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 MAK Technologies, Inc
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 
32 class DT_DLL_VL DtRecordRInteraction : public DtInteractionWithEncDec
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 
119  DtEntityIdentifier myOriginatingEnt;
120  DtEntityIdentifier myReceivingEnt;
121  DtU32 myRequestId;
122  DtEventType myEventType;
123  DtU32 myResponceSerialNumber;
124  DtRequiredReliabilityService myRequiredReliabilityService;
125  DtRecordSetList myRecordSetList;
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 {
167  myRequiredReliabilityService = service;
168 }
169 
171 {
172  return myRequiredReliabilityService;
173 }
174 
176 {
177  myEventType = type;
178 }
179 
181 {
182  return myEventType;
183 }
184 
186 {
187  myResponceSerialNumber = num;
188 }
189 
191 {
192  return myResponceSerialNumber;
193 }
194 
195 inline const DtRecordSetList & DtRecordRInteraction::recordSetList() const
196 {
197  return myRecordSetList;
198 }
199 
200 inline DtRecordSetList * DtRecordRInteraction::recordSetList()
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 base class for representing DIS PDUs which don't have state.
Definition: interactionDIS.h:24
virtual void setReceivingEntityID(const DtEntityIdentifier &entity)
Set/Get receiving entity identifier.
DtRequiredReliabilityService
Reliable service PDU enums.
Definition: disEnums.h:2497
virtual DtU32 requestID() const
Instances of DtExerciseConn are used to provide an application's interface or connection to the netwo...
Definition: exerciseConnDIS.h:62
#define DT_DLL_VL
Definition: vlMachineTypes.h:108
virtual const DtEntityIdentifier & originatingEntityID() const
Instances of DtRecordSetList are lists of RecordSets.
Definition: vlpi/recordSetList.h:17
virtual void setOriginatingEntityID(const DtEntityIdentifier &entity)
Set/Get originating entity identifier.
virtual void setReqRelService(enum DtRequiredReliabilityService service)
Set/Get required reliability service.
Instances of DtRecordSet are used to contain the record sets used by the PDU classes which inherit fr...
Definition: recordSet.h:38
DtRecordPdu DtRecordRInteraction
Definition: recordPdu.h:22
virtual void setResponseSerialNumber(DtU32 num)
Set/Get the response serial number.
virtual DtU32 responseSerialNumber() const
Instances of DtEntityIdentifier are used as a unique ID for entities in DIS.
Definition: entityIdentifier.h:31
virtual const DtEntityIdentifier & receivingEntityID() const
DtEventType
Definition: disEnums.h:483
Instances of DtRecordPdu are used to send responses to the Record Query PDU.
Definition: recordPdu.h:32
virtual void setRequestID(DtU32 id)
Set/Get request ID.
virtual DtRequiredReliabilityService reqRelService() const
unsigned long DtU32
A 32 bit unsigned integer value.
Definition: vlMachineTypes.h:153
virtual DtEventType eventType() const
virtual void setEventType(DtEventType type)
Set/Get the event type.

Document ID: Generated on Wed Mar 27 02:04:30 EDT 2024 from SVN revision 264570
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)