VR-Link API Documentation for HLA Evolved
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
leDetonationPdu.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1992-2025 MAK Technologies, Inc
3 ** All rights reserved.
4 *********************************************************************/
5 
9 
10 #pragma once
11 
12 #if DtDIS
13 
14 #include <vlutil/vlMachineTypes.h>
15 #include "hostStructs.h"
16 #include "interactionDIS.h"
17 #include <matrix/vlMath.h>
18 #include "exerciseConn.h"
19 
20 #include "packets/leDetonP.h"
21 
22 #include "leEntityID.h"
23 #include "leEntityLocationWorldCoordinates.h"
24 #include "leEntityLocationEntityCoordinates.h"
25 #include "leEntityLinearVelocity.h"
26 #include "leEntityOrientation.h"
27 
28 class DT_DLL_VL DtLeDetonationPdu;
29 
31 typedef void (*DtLeDetonationPduCb)(DtLeDetonationPdu* pdu, void* usr);
32 
33 
37 class DT_DLL_VL DtLeDetonationPdu : public DtInteraction
38 {
39 
40 public:
41 
43  DtLeDetonationPdu(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
44  DtLeDetonationPdu(const DtNetLeDetonationPdu* initial,
45  DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0);
46  DtLeDetonationPdu(const DtLeDetonationPdu& orig);
47 
49  virtual ~DtLeDetonationPdu();
50 
52  DtLeDetonationPdu& operator=(const DtLeDetonationPdu& orig);
53 
55  virtual void setSubProtocol(DtSubProtocol value);
56  virtual DtSubProtocol subProtocol() const;
57 
59  virtual void setFiringEntityID(const DtLeEntityID& id);
60  virtual const DtLeEntityID& firingEntityID() const;
61 
64  virtual DtU8 detonFlagsField() const;
65 
69  virtual bool getDeton2FlagsField(DtU8& field) const;
70 
72  virtual bool detonFlag(DtLE_DetonFieldFlag flag) const;
73 
76  virtual bool getDeton2Flag(
77  DtLE_DetonField2Flag flag, bool& value) const;
78 
82 
84  virtual void setTargetEntityID(const DtLeEntityID& id);
85  virtual bool getTargetEntityID(DtLeEntityID& id) const;
86 
88  virtual void setMunitionID_Site(DtU8 value);
89  virtual bool getMunitionID_Site(DtU8& value) const;
90 
92  virtual void setMunitionID_Application(DtU8 value);
93  virtual bool getMunitionID_Application(DtU8& value) const;
94 
96  virtual void setMunitionID_Entity(DtU16 value);
97  virtual bool getMunitionID_Entity(DtU16& value) const;
98 
100  virtual void setEventID_Site(DtU8 value);
101  virtual bool getEventID_Site(DtU8& value) const;
102 
104  virtual void setEventID_Application(DtU8 value);
105  virtual bool getEventID_Application(DtU8& value) const;
106 
108  virtual void setEventID_Event(DtU16 value);
109  virtual bool getEventID_Event(DtU16& value) const;
110 
115  virtual void setLocationWorld(
116  const DtLeEntityLocationWorldCoordinates& value);
117  virtual bool getLocationWorld(
118  DtLeEntityLocationWorldCoordinates& value) const;
119 
124  virtual void setLocationEntity(
125  const DtLeEntityLocationEntityCoordinates& value);
126  virtual bool getLocationEntity(
127  DtLeEntityLocationEntityCoordinates& value) const;
128 
130  virtual void setVelocity(const DtLeEntityLinearVelocity& value);
131  virtual const DtLeEntityLinearVelocity& velocity() const;
132 
134  virtual void setOrientation(const DtLeEntityOrientation& value);
135  virtual bool getOrientation(DtLeEntityOrientation& value) const;
136 
138  virtual void setBurstMunitionType(DtEntityType& type);
139  virtual const DtEntityType& burstMunitionType() const;
140 
142  virtual void setBurstWarhead(DtU16 value);
143  virtual bool getBurstWarhead(DtU16& value) const;
144 
146  virtual void setBurstFuse(DtU16 value);
147  virtual bool getBurstFuse(DtU16& value) const;
148 
150  virtual void setBurstQuantity(DtU16 value);
151  virtual bool getBurstQuantity(DtU16& value) const;
152 
154  virtual void setBurstRate(DtU16 value);
155  virtual bool getBurstRate(DtU16& value) const;
156 
158  virtual void setDetonationResult(DtU8 value);
159  virtual DtU8 detonationResult() const;
160 
162  virtual void printData() const;
163 
165  virtual void printDataToStream(std::ostream& stream) const;
166 
168  virtual void printHeader() const;
169 
171  virtual void printHeaderToStream(std::ostream& stream) const;
172 
173 public:
174 
177  static DtPdu* create(const DtNetPacket* initial,
178  DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0);
179 
182  static void addCallback(DtExerciseConn* conn,
183  DtLeDetonationPduCb cb, void* usr);
184  static void removeCallback(DtExerciseConn* conn,
185  DtLeDetonationPduCb cb, void* usr);
186 
187 protected:
188 
190  virtual DtPduKind internalGetPduKind() const;
191 
193  virtual DtNetLeDetonationPdu* netPduStruct() const;
194 
197  DtLeDetonationPdu* self() const;
198 
200  virtual char* var() const;
201 
203  virtual void setDetonFlagsField(DtU8 value);
204 
206  virtual void setDeton2FlagsField(DtU8 value);
207 
209  virtual void setDetonFlag(DtLE_DetonFieldFlag flag);
210 
212  virtual void setDeton2Flag(DtLE_DetonField2Flag flag);
213 
217  virtual int detonFlagFieldOffset() const;
218  virtual int deton2FlagFieldOffset() const;
219  virtual int targetEntityID_Offset() const;
220  virtual int munitionID_Offset1() const;
221  virtual int munitionID_Offset2() const;
222  virtual int eventID_Offset1() const;
223  virtual int eventID_Offset2() const;
224  virtual int locationWorldOffset() const;
225  virtual int velocityOffset() const;
226  virtual int munitionOrientationOffset() const;
227  virtual int burstOffset1() const;
228  virtual int burstOffset2() const;
229  virtual int burstOffset3() const;
230  virtual int locationEntityOffset() const;
231  virtual int resultOffset() const;
232 
233 protected:
234 
236  static const int theStaticSize;
237 
238 protected:
239 
241  DtLeEntityID myEntityID;
242  DtLeEntityLinearVelocity myVelocity;
243  DtEntityType myEntityType;
244 
245 };
246 
247 #endif
DtInteraction
DtInteraction is an abstract base class for representing HLA interactions (or events) (as opposed to ...
Definition: interactionHLA.h:33
DtExerciseConn
Instances of DtExerciseConn are used to provide an application&#39;s interface or connection to the netwo...
Definition: exerciseConnHLA.h:61
leDetonP.h
This file declares the class DtNetLeDetonationPdu.
DtInteraction::operator=
DtInteraction & operator=(const DtInteraction &orig)
assignment operator
DT_DLL_VL
#define DT_DLL_VL
Definition: vlMachineTypes.h:108
leEntityLocationWorldCoordinates.h
This file declares the class DtLeEntityLocationWorldCoordinates.
DtNetPduHeader
Definition: pduHeader.h:14
DtInteraction::printHeaderToStream
virtual void printHeaderToStream(std::ostream &stream) const
Print the header info to a stream.
DtInteraction::removeCallback
static void removeCallback(DtExerciseConn *conn, const std::vector< DtString > *classes, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
vlMath.h
This file defines math constants and methods which may be useful in simulations.
DtInteraction::printData
virtual void printData() const
Print the interaction&#39;s data to DtInfo.
Definition: interactionHLA.h:358
DtLE_DetonFieldFlag
DtLE_DetonFieldFlag
Definition: disEnums.h:2813
DtInteraction::printDataToStream
virtual void printDataToStream(std::ostream &stream) const
Print the interaction&#39;s data to the stream.
Definition: interactionHLA.h:366
DtPdu
DtPdu is the base class for all PDU&#39;s in VR-Link.
Definition: pdu.h:69
DtU8
unsigned char DtU8
An eight bit unsigned integer value.
Definition: vlMachineTypes.h:137
leEntityLinearVelocity.h
This file declares the class DtLeEntityLinearVelocity.
DtInteraction::addCallback
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...
exerciseConn.h
This file provides protocol to independence DtExerciseConn.
leEntityLocationEntityCoordinates.h
This file declares the class DtLeEntityLocationEntityCoordinates.
DtLE_DetonField2Flag
DtLE_DetonField2Flag
Definition: disEnums.h:2825
DtInteraction::printHeader
virtual void printHeader() const
Print the header info.
leEntityOrientation.h
This file declares the class DtLeEntityOrientation.
hostStructs.h
This file is deprecated - Please see simulationAddress.h, entityIdentifier.h, entityType.h, burstDescriptor.h, and NetStructs.h.
DtBufferPtr
struct DtBufferPlaceHolder * DtBufferPtr
Definition: vlBaseMsg.h:17
DtU16
unsigned short DtU16
A 16 bit unsigned integer value.
Definition: vlMachineTypes.h:140
DtUSE_INTERNAL_BUFFER
#define DtUSE_INTERNAL_BUFFER
Definition: vlBaseMsg.h:22
leEntityID.h
This file declares the class DtLeEntityID.
DtSubProtocol
DtSubProtocol
Live entity protocol PDU enums.
Definition: disEnums.h:2761
DtPduKind
DtPduKind
([UID 4]) - PDU Type
Definition: disEnums.h:238
vlMachineTypes.h
This file contains typedefs for machine dependant types.
DtEntityType
DtEntityType is used to represent the type an entity object.
Definition: entityType.h:26
Document ID: Generated on Thu Oct 16 00:12:25 EDT 2025 from SVN revision 280738
Copyright © 1992-2025 MAK Technologies. All Rights Reserved (www.mak.com)