VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
leAppearancePdu.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/leAppearP.h"
21 
22 #include "leEntityID.h"
23 
24 
25 class DT_DLL_VL DtLeAppearancePdu;
26 
28 typedef void (*DtLeAppearancePduCb)(DtLeAppearancePdu* pdu, void* usr);
29 
30 
35 
36 
37 class DT_DLL_VL DtLeAppearancePdu : public DtInteraction
38 {
39 
40 public:
41 
43  DtLeAppearancePdu(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
44  DtLeAppearancePdu(const DtNetLeAppearancePdu* initial,
45  DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0);
46  DtLeAppearancePdu(const DtLeAppearancePdu& orig);
47 
49  virtual ~DtLeAppearancePdu();
50 
52  DtLeAppearancePdu& operator=(const DtLeAppearancePdu& orig);
53 
55  virtual void setSubProtocol(DtSubProtocol value);
56  virtual DtSubProtocol subProtocol() const;
57 
59  virtual void setEntityID(const DtLeEntityID& id);
60  virtual const DtLeEntityID& entityID() const;
61 
64  virtual DtU8 appearanceField1() const;
65 
68  virtual bool appearanceField1Flag(DtLE_AppearanceField1Flag flag) const;
69 
73 
76  virtual bool getAppearanceField2(DtU8& value) const;
77 
80  virtual bool getAppearanceField2Flag(DtLE_AppearanceField2Flag flag,
81  bool& value) const;
82 
84  virtual void setForceID(DtForceType force);
85  virtual bool getForceID(DtForceType& force) const;
86 
88  virtual void setEntityType(const DtEntityType& type);
89  virtual bool getEntityType(DtEntityType& type) const;
90 
92  virtual void setAlternativeEntityType(const DtEntityType& type);
93  virtual bool getAlternativeEntityType(DtEntityType& type) const;
94 
96  virtual void setMarkingCharacterSet(DtCharacterSet value);
97  virtual bool getMarkingCharacterSet(DtCharacterSet& value) const;
98 
100  virtual void setMarkingText(DtU8* dataPtr);
101  virtual bool getMarkingText(DtU8* dataPtr) const;
102 
104  virtual void setCapabilities(DtU32 value);
105  virtual bool getCapabilities(DtU32& value) const;
106 
108  virtual void setCapability(DtCapability flag, bool value);
109  virtual bool getCapability(DtCapability flag, bool& value) const;
110 
112  virtual void setVisualAppearance(DtU32 value);
113  virtual bool getVisualAppearance(DtU32& value) const;
114 
116  virtual void setVisualAppearanceAttribute(
117  DtAppearAttribute attr, DtAppearAttrVal val);
118  virtual bool getVisualAppearanceAttribute(
119  DtAppearAttribute attr, DtAppearAttrVal& val);
120 
122  virtual void setIR_Appearance(DtU32 value);
123  virtual bool getIR_Appearance(DtU32& value) const;
124 
126  virtual void setEM_Appearance(DtU32 value);
127  virtual bool getEM_Appearance(DtU32& value) const;
128 
130  virtual void setAudioAppearance(DtU32 value);
131  virtual bool getAudioAppearance(DtU32& value) const;
132 
134  virtual void printData() const;
135 
137  virtual void printDataToStream(std::ostream& stream) const;
138 
140  virtual void printHeader() const;
141 
143  virtual void printHeaderToStream(std::ostream& stream) const;
144 
145 public:
146 
149  static DtPdu* create(const DtNetPacket* initial,
150  DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0);
151 
154  static void addCallback(DtExerciseConn* conn,
155  DtLeAppearancePduCb cb, void* usr);
156  static void removeCallback(DtExerciseConn* conn,
157  DtLeAppearancePduCb cb, void* usr);
158 
159 protected:
160 
162  virtual DtPduKind internalGetPduKind() const;
163 
165  virtual DtNetLeAppearancePdu* netPduStruct() const;
166 
169  DtLeAppearancePdu* self() const;
170 
172  virtual char* var() const;
173 
175  virtual void setAppearanceField1(DtU8 value);
176 
178  virtual void setAppearanceField1Flag(DtLE_AppearanceField1Flag flag);
179 
181  virtual void clearField1Flags(DtLE_AppearanceField1Flag flag);
182 
184  virtual void setAppearanceField2(DtU8 value);
185 
187  virtual void setAppearanceField2Flag(DtLE_AppearanceField2Flag flag);
188 
190  virtual int appearanceField1Offset() const;
191  virtual int appearanceField2Offset() const;
192  virtual int forceID_Offset() const;
193  virtual int entityTypeOffset() const;
194  virtual int alternativeEntityTypeOffset() const;
195  virtual int entityMarkingOffset() const;
196  virtual int capabilitiesOffset() const;
197  virtual int visualAppearanceOffset() const;
198  virtual int IR_AppearanceOffset() const;
199  virtual int EM_AppearanceOffset() const;
200  virtual int audioAppearanceOffset() const;
201 
202 protected:
203 
205  static const int theStaticSize;
206 
207 protected:
208 
210  DtLeEntityID myEntityID;
211 
212 };
213 
214 #endif
DtInteraction
DtInteraction is an abstract base class for representing HLA interactions (or events) (as opposed to ...
Definition: interactionHLA.h:33
DtAppearAttrVal
DtAppearAttrVal
Create an enumeration type, but since many of the names will have the same value, define them all as ...
Definition: disEnums.h:1441
DtExerciseConn
Instances of DtExerciseConn are used to provide an application&#39;s interface or connection to the netwo...
Definition: exerciseConnHLA.h:61
DtInteraction::operator=
DtInteraction & operator=(const DtInteraction &orig)
assignment operator
DT_DLL_VL
#define DT_DLL_VL
Definition: vlMachineTypes.h:108
DtNetPduHeader
Definition: pduHeader.h:14
DtInteraction::printHeaderToStream
virtual void printHeaderToStream(std::ostream &stream) const
Print the header info to a stream.
DtCapability
DtCapability
Definition: disEnums.h:1781
DtLE_AppearanceField2Flag
DtLE_AppearanceField2Flag
Definition: disEnums.h:2796
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
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
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...
leAppearP.h
This file declares the class DtNetLeAppearancePdu.
exerciseConn.h
This file provides protocol to independence DtExerciseConn.
DtInteraction::printHeader
virtual void printHeader() const
Print the header info.
DtCharacterSet
DtCharacterSet
Definition: disEnums.h:2766
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
DtForceType
DtForceType
Section 4.
Definition: disEnums.h:199
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
DtLE_AppearanceField1Flag
DtLE_AppearanceField1Flag
Definition: disEnums.h:2784
DtU32
unsigned long DtU32
A 32 bit unsigned integer value.
Definition: vlMachineTypes.h:153
DtAppearAttribute
DtAppearAttribute
If you put spaces between the &quot;&lt;&lt;&quot; and the surrounding strings, enumstr gets confused and thinks the ...
Definition: disEnums.h:1286
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)