VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
leFirePdu.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1992-2013 VT MAK
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/leFireP.h"
21 
22 #include "leDeadReckoningParameters.h"
23 #include "leEntityID.h"
24 #include "leEntityLocationWorldCoordinates.h"
25 #include "leEntityLinearVelocity.h"
26 
27 
28 class DT_DLL_VL DtLeFirePdu;
29 
31 typedef void (*DtLeFirePduCb)(DtLeFirePdu* pdu, void* usr);
32 
33 
37 class DT_DLL_VL DtLeFirePdu : public DtInteraction
38 {
39 
40 public:
41 
43  DtLeFirePdu(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
44  DtLeFirePdu(const DtNetLeFirePdu* initial,
45  DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0);
46  DtLeFirePdu(const DtLeFirePdu& orig);
47 
49  virtual ~DtLeFirePdu();
50 
52  DtLeFirePdu& operator=(const DtLeFirePdu& 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 fireFlagsField() const;
65 
67  virtual bool fireFlag(DtLE_FireFieldFlag flag) const;
68 
72 
74  virtual void setTargetEntityID(const DtLeEntityID& id);
75  virtual bool getTargetEntityID(DtLeEntityID& id) const;
76 
78  virtual void setMunitionID_Site(DtU8 value);
79  virtual bool getMunitionID_Site(DtU8& value) const;
80 
82  virtual void setMunitionID_Application(DtU8 value);
83  virtual bool getMunitionID_Application(DtU8& value) const;
84 
86  virtual void setMunitionID_Entity(DtU16 value);
87  virtual bool getMunitionID_Entity(DtU16& value) const;
88 
90  virtual void setEventID_Site(DtU8 value);
91  virtual bool getEventID_Site(DtU8& value) const;
92 
94  virtual void setEventID_Application(DtU8 value);
95  virtual bool getEventID_Application(DtU8& value) const;
96 
98  virtual void setEventID_Event(DtU16 value);
99  virtual DtU16 eventID_Event() const;
100 
102  virtual void setLocation(const DtLeEntityLocationWorldCoordinates& value);
103  virtual bool getLocation(
104  DtLeEntityLocationWorldCoordinates& value) const;
105 
107  virtual void setBurstMunitionType(DtEntityType& type);
108  virtual const DtEntityType& burstMunitionType() const;
109 
111  virtual void setBurstWarhead(DtU16 value);
112  virtual bool getBurstWarhead(DtU16& value) const;
113 
115  virtual void setBurstFuse(DtU16 value);
116  virtual bool getBurstFuse(DtU16& value) const;
117 
119  virtual void setBurstQuantity(DtU16 value);
120  virtual bool getBurstQuantity(DtU16& value) const;
121 
123  virtual void setBurstRate(DtU16 value);
124  virtual bool getBurstRate(DtU16& value) const;
125 
127  virtual void setVelocity(const DtLeEntityLinearVelocity& value);
128  virtual const DtLeEntityLinearVelocity& velocity() const;
129 
131  virtual void setRange(DtU16 value);
132  virtual DtU16 range() const;
133 
135  virtual void printData() const;
136 
138  virtual void printDataToStream(std::ostream& stream) const;
139 
141  virtual void printHeader() const;
142 
144  virtual void printHeaderToStream(std::ostream& stream) const;
145 
146 public:
147 
150  static DtPdu* create(const DtNetPacket* initial,
151  DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0);
152 
155  static void addCallback(DtExerciseConn* conn,
156  DtLeFirePduCb cb, void* usr);
157  static void removeCallback(DtExerciseConn* conn,
158  DtLeFirePduCb cb, void* usr);
159 
160 protected:
161 
163  virtual DtPduKind internalGetPduKind() const;
164 
166  virtual DtNetLeFirePdu* netPduStruct() const;
167 
170  DtLeFirePdu* self() const;
171 
173  virtual char* var() const;
174 
176  virtual void setFireFlagsField(DtU8 value);
177 
179  virtual void setFireFlag(DtLE_FireFieldFlag flag);
180 
182  virtual void clearFireFlags(DtLE_FireFieldFlag flag);
183 
187  virtual int fireFlagFieldOffset() const;
188  virtual int targetEntityID_Offset() const;
189  virtual int munitionID_Offset1() const;
190  virtual int munitionID_Offset2() const;
191  virtual int eventID_Offset1() const;
192  virtual int eventID_Offset2() const;
193  virtual int locationOffset() const;
194  virtual int burstOffset1() const;
195  virtual int burstOffset2() const;
196  virtual int burstOffset3() const;
197  virtual int velocityOffset() const;
198  virtual int rangeOffset() const;
199 
200 protected:
201 
203  static const int theStaticSize;
204 
205 protected:
206 
208  DtLeEntityID myEntityID;
209  DtLeEntityLinearVelocity myVelocity;
210  DtEntityType myEntityType;
211 
212 };
213 
214 #endif
DtInteraction
DtInteraction is an base class for representing DIS PDUs which don&#39;t have state.
Definition: interactionDIS.h:24
DtLeFirePdu
Instances of DtLeFirePdu are used to send firing information for live entities.
Definition: leFirePdu.h:37
DtExerciseConn
Instances of DtExerciseConn are used to provide an application&#39;s interface or connection to the netwo...
Definition: exerciseConnDIS.h:61
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.
DtLeEntityLocationWorldCoordinates
class DtLeEntityLocationWorldCoordinates:
Definition: leEntityLocationWorldCoordinates.h:29
DtNetPduHeader
Definition: pduHeader.h:14
DtLE_FireFieldFlag
DtLE_FireFieldFlag
Definition: disEnums.h:2680
DtPduFactory
class DtPduFactory:
Definition: pduFactory.h:38
DtLeFirePduCb
void(* DtLeFirePduCb)(DtLeFirePdu *pdu, void *usr)
DtLeFirePdu callback function signature.
Definition: leFirePdu.h:31
DtLeFirePdu::myEntityID
DtLeEntityID myEntityID
Temporary objects for reference returns.
Definition: leFirePdu.h:208
DtPdu::printDataToStream
virtual void printDataToStream(std::ostream &stream) const
DtNetLeFirePdu
DtNetFirePdu is the network structure for the live entity fire PDU.
Definition: leFireP.h:23
vlMath.h
This file defines math constants and methods which may be useful in simulations.
leDeadReckoningParameters.h
This file declares the class DtLeDeadReckoningParameters.
DtPdu::internalGetPduKind
virtual DtPduKind internalGetPduKind() const =0
Returns the PDU kind associated with the derived PDU class.
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.
DtPdu::printHeader
virtual void printHeader() const
Print the PDU&#39;s header. This calls printHeaderToStream(DtInfo).
exerciseConn.h
This file provides protocol to independence DtExerciseConn.
DtLeFirePdu::myEntityType
DtEntityType myEntityType
Definition: leFirePdu.h:210
DtLeEntityID
class DtLeEntityID:
Definition: leEntityID.h:28
DtPdu::printData
virtual void printData() const
Print the PDU&#39;s data (not including header).
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
leFireP.h
This file declares the class DtNetLeFirePdu.
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:2639
DtLeFirePdu::theStaticSize
static const int theStaticSize
Size of PDU with zero parameter records.
Definition: leFirePdu.h:203
DtPdu::printHeaderToStream
virtual void printHeaderToStream(std::ostream &stream) const
Print the PDU&#39;s header to a stream.
DtPduKind
DtPduKind
([UID 4]) - PDU Type
Definition: disEnums.h:238
DtLeFirePdu::myVelocity
DtLeEntityLinearVelocity myVelocity
Definition: leFirePdu.h:209
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
DtLeEntityLinearVelocity
class DtLeEntityLinearVelocity:
Definition: leEntityLinearVelocity.h:29
Document ID: Generated on Tue Feb 2 21:02:17 EST 2021 from SVN revision 223668
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)