VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
transferControlInteractionHLA.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1992-2010 VT MAK
3 ** All rights reserved.
4 *********************************************************************/
5 
6 
7 #ifndef transferControlInteractionHLA_H_
8 #define transferControlInteractionHLA_H_
9 
10 #if DtHLA
11 
12 #include "interactionWithData.h"
13 #include "vlpi/recordSetList.h"
14 
18 
19 class DT_DLL_VL DtTransferControlInteraction;
20 class DT_DLL_VL DtExerciseConn;
21 
23 typedef void (*DtTransferControlInteractionCb)
24  (DtTransferControlInteraction* inter, void *user);
25 
30 
31 class DT_DLL_VL DtTransferControlInteraction : public DtInteractionWithEncDec
32 {
33 public:
34 
36  DtTransferControlInteraction();
37 
39  DtTransferControlInteraction
40  (const DtTransferControlInteraction& other);
41 
43  virtual ~DtTransferControlInteraction();
44 
46  DtTransferControlInteraction& operator=
47  (const DtTransferControlInteraction& other);
48 
50  virtual void printData() const;
51 
53  virtual void printDataToStream(std::ostream& stream) const;
54 
56  virtual void setOriginatingEntityID(const DtEntityIdentifier& entity);
57  virtual const DtEntityIdentifier& originatingEntityID() const;
58 
60  virtual void setReceivingEntityID(const DtEntityIdentifier &entity);
61  virtual const DtEntityIdentifier receivingEntityID() const;
62 
64  virtual void setRequestID(DtU32 id);
65  virtual DtU32 requestID() const;
66 
67 
69  virtual void setTransferType(const DtTransferType type);
70  virtual const DtTransferType transferType() const;
71 
73  virtual void setTransferredEntityID(const DtGlobalObjectDesignator &);
74  virtual const DtGlobalObjectDesignator &transferredEntityID() const;
75 
79  virtual void setNumRecordSets(DtU32 number);
80  virtual DtU32 numRecordSets() const;
81 
84  virtual bool setRecordSet(int index, const DtRecordSet &set);
85  virtual const DtRecordSet &recordSet(int index,
86  bool *valid = NULL);
87 
89  virtual bool getRecordSet(int index, DtRecordSet& recSet) const;
90 
92  virtual const DtRecordSetList &recordSetList() const;
93  virtual DtRecordSetList *recordSetList();
94 
97  virtual const char* name() const;
98 
99 public:
102  static DtInteraction* create();
103 
106  static void addCallback(DtExerciseConn *conn,
107  DtTransferControlInteractionCb cb, void *usr,
108  DtDDMRegionSP region = DtDDMRegionSP());
109  static void removeCallback(DtExerciseConn *conn,
110  DtTransferControlInteractionCb cb, void *usr,
111  DtDDMRegionSP region = DtDDMRegionSP());
112 
113 protected:
114 
115  DtEntityIdentifier myOriginatingEnt;
116  DtEntityIdentifier myReceivingEnt;
117  DtU32 myRequestId;
118  DtGlobalObjectDesignator myTransferEntity;
119  DtTransferType myTransferType;
120  DtRecordSetList myRecordSetList;
121 
122 };
123 
127 inline void
128 DtTransferControlInteraction::setOriginatingEntityID
129  (const DtEntityIdentifier& id)
130 {
131  myOriginatingEnt = id;
132 }
133 
134 inline const DtEntityIdentifier &
135 DtTransferControlInteraction::originatingEntityID() const
136 {
137  return myOriginatingEnt;
138 }
139 
140 inline void
141 DtTransferControlInteraction::setReceivingEntityID(
142  const DtEntityIdentifier &id)
143 {
144  myReceivingEnt = id;
145 }
146 
147 inline const DtEntityIdentifier
148 DtTransferControlInteraction::receivingEntityID() const
149 {
150  return myReceivingEnt;
151 }
152 
153 inline void
154 DtTransferControlInteraction::setRequestID(DtU32 id)
155 {
156  myRequestId = id;
157 }
158 
159 inline DtU32
160 DtTransferControlInteraction::requestID() const
161 {
162  return myRequestId;
163 }
164 
165 inline void
166 DtTransferControlInteraction::setTransferType(const DtTransferType type)
167 {
168  myTransferType = type;
169 }
170 
171 inline const DtTransferType
172 DtTransferControlInteraction::transferType() const
173 {
174  return myTransferType;
175 }
176 
177 inline void
178 DtTransferControlInteraction::setTransferredEntityID(
179  const DtGlobalObjectDesignator &id)
180 {
181  myTransferEntity = id;
182 }
183 
184 inline const DtGlobalObjectDesignator&
185 DtTransferControlInteraction::transferredEntityID() const
186 {
187  return myTransferEntity;
188 }
189 
190 inline const DtRecordSetList &
191 DtTransferControlInteraction::recordSetList() const
192 {
193  return myRecordSetList;
194 }
195 
196 inline DtRecordSetList *
197 DtTransferControlInteraction::recordSetList()
198 {
199  return &myRecordSetList;
200 }
201 
202 inline const char*
203 DtTransferControlInteraction::name() const
204 {
205  return "DtTransferControlInteraction";
206 }
207 
208 #endif
209 #endif
210 
Document ID: Generated on Thu Feb 22 04:26:36 EST 2018 from SVN revision 186468
Copyright © 2005-2016 VT MÄK. All Rights Reserved (www.mak.com)