VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
setRecordInteractionHLA.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1992-2010 MAK Technologies, Inc
3 ** All rights reserved.
4 *********************************************************************/
5 
6 #ifndef setRecordInteractionHLA_H_
7 #define setRecordInteractionHLA_H_
8 
9 #if DtHLA
10 
11 #include "interactionWithData.h"
12 #include "vlpi/recordSetList.h"
13 
17 
20 
21 typedef void (*DtSetRecordInteractionCb)
22  (DtSetRecordInteraction *inter, void *user);
23 
25 {
26 public:
27 
28  //default constructor
30 
33 
35  virtual ~DtSetRecordInteraction();
36 
38  DtSetRecordInteraction& operator=
39  (const DtSetRecordInteraction& other);
40 
42  virtual void printData() const;
43 
45  virtual void printDataToStream(std::ostream& stream) const;
46 
48  virtual void setOriginatingEntityID(const DtEntityIdentifier& entity);
49  virtual const DtEntityIdentifier& originatingEntityID() const;
50 
52  virtual void setReceivingEntityID(const DtEntityIdentifier &entity);
53  virtual const DtEntityIdentifier receivingEntityID() const;
54 
56  virtual void setRequestID(DtU32 id);
57  virtual DtU32 requestID() const;
58 
60  virtual void setReqRelService(enum DtRequiredReliabilityService service);
61  virtual DtRequiredReliabilityService reqRelService() const;
62 
66  virtual void setNumRecordSets(DtU32 number);
67  virtual DtU32 numRecordSets() const;
68 
71  virtual bool setRecordSet(int index, const DtRecordSet &set);
72  virtual const DtRecordSet &recordSet(int index,
73  bool *valid = NULL);
74 
76  virtual bool getRecordSet(int index, DtRecordSet& recSet) const;
77 
79  virtual const DtRecordSetList &recordSetList() const;
80  virtual DtRecordSetList *recordSetList();
81 
84  virtual const char* name() const;
85 
86 public:
89  static DtInteraction* create();
90 
93  static void addCallback(DtExerciseConn *conn,
94  DtSetRecordInteractionCb cb, void *usr,
95  DtDDMRegionSP region = DtDDMRegionSP());
96  static void removeCallback(DtExerciseConn *conn,
97  DtSetRecordInteractionCb cb, void *usr,
98  DtDDMRegionSP region = DtDDMRegionSP());
99 
100 
101 protected:
102 
108 
109 };
110 
111 inline void
113  (const DtEntityIdentifier& id)
114 {
115  myOriginatingEnt = id;
116 }
117 
118 inline const DtEntityIdentifier &
120 {
121  return myOriginatingEnt;
122 }
123 
124 inline void
126  const DtEntityIdentifier &id)
127 {
128  myReceivingEnt = id;
129 }
130 
131 inline const DtEntityIdentifier
133 {
134  return myReceivingEnt;
135 }
136 
137 inline void
139 {
140  myRequestId = id;
141 }
142 
143 inline DtU32
145 {
146  return myRequestId;
147 }
148 
150 inline void
152 {
154 }
155 
158 {
160 }
161 
162 
163 inline const DtRecordSetList &
165 {
166  return myRecordSetList;
167 }
168 
169 inline DtRecordSetList *
171 {
172  return &myRecordSetList;
173 }
174 
175 inline const char*
177 {
178  return "DtSetRecordInteraction";
179 }
180 
181 #endif
182 #endif
183 
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:2497
Instances of DtExerciseConn are used to provide an application's interface or connection to the netwo...
Definition: exerciseConnHLA.h:61
#define DT_DLL_VL
Definition: vlMachineTypes.h:108
void(* DtSetRecordInteractionCb)(DtSetRecordInteraction *inter, void *user)
Definition: setRecordInteractionHLA.h:22
virtual const DtEntityIdentifier receivingEntityID() const
Definition: setRecordInteractionHLA.h:132
Instances of DtRecordSetList are lists of RecordSets.
Definition: vlpi/recordSetList.h:17
virtual void setReceivingEntityID(const DtEntityIdentifier &entity)
Set/Get receiver ID.
Definition: setRecordInteractionHLA.h:125
This file provides a declaration of the class DtInteractionWithData.
DtEntityIdentifier myReceivingEnt
Definition: setRecordInteractionHLA.h:104
virtual const DtEntityIdentifier & originatingEntityID() const
Definition: setRecordInteractionHLA.h:119
virtual DtRequiredReliabilityService reqRelService() const
Definition: setRecordInteractionHLA.h:157
virtual const DtRecordSetList & recordSetList() const
They exist for the mapper to use for conversion to net data.
Definition: setRecordInteractionHLA.h:164
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:348
DtU32 myRequestId
Definition: setRecordInteractionHLA.h:105
virtual void printDataToStream(std::ostream &stream) const
Print the interaction&#39;s data to the stream.
Definition: interactionHLA.h:356
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...
DtEntityIdentifier myOriginatingEnt
Definition: setRecordInteractionHLA.h:103
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
Definition: setRecordInteractionHLA.h:24
virtual void setRequestID(DtU32 id)
Set/Get request ID.
Definition: setRecordInteractionHLA.h:138
DtRequiredReliabilityService myRequiredReliabilityService
Definition: setRecordInteractionHLA.h:106
virtual void setOriginatingEntityID(const DtEntityIdentifier &entity)
Set/Get originator ID.
Definition: setRecordInteractionHLA.h:113
class DtInteractionWithEncDec:
Definition: interactionWithEncDec.h:44
unsigned long DtU32
A 32 bit unsigned integer value.
Definition: vlMachineTypes.h:153
DtRecordSetList myRecordSetList
Definition: setRecordInteractionHLA.h:107
virtual DtU32 requestID() const
Definition: setRecordInteractionHLA.h:144
virtual void setReqRelService(enum DtRequiredReliabilityService service)
Set/Get required reliability service.
Definition: setRecordInteractionHLA.h:151
virtual const char * name() const
name of the interaction.
Definition: setRecordInteractionHLA.h:176

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)