VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
isPartOfPdu.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1992-2013 VT MAK
3 ** All rights reserved.
4 *********************************************************************/
5 
8 
9 #pragma once
10 
11 #if DtDIS
12 
13 #include <vlutil/vlMachineTypes.h>
14 #include <matrix/vlMath.h>
15 
16 #include "hostStructs.h"
17 #include "interactionDIS.h"
18 #include "exerciseConn.h"
19 #include "packets/isPartOfP.h"
20 
21 
23 
25 typedef void (*DtIsPartOfPduCb)(DtIsPartOfPdu* pdu, void* usr);
26 
27 
32 {
33 
34 public:
35 
38  DtIsPartOfPdu(const DtNetIsPartOfPdu* initial,
39  DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0);
40  DtIsPartOfPdu(const DtIsPartOfPdu& orig);
41 
43  virtual ~DtIsPartOfPdu();
44 
47 
49  virtual void setOriginatingEntityID(const DtEntityIdentifier& entity);
50  virtual const DtEntityIdentifier& originatingEntityID() const;
51 
53  virtual void setReceivingEntityID(const DtEntityIdentifier& entity);
54  virtual const DtEntityIdentifier& receivingEntityID() const;
55 
57  virtual void setNature(DtNature value);
58  virtual DtNature nature() const;
59 
61  virtual void setConstituentPartPosition(DtPosition value);
62  virtual DtPosition constituentPartPosition() const;
63 
65  virtual void setPartLocation(const DtVector& coords);
66  virtual const DtVector& partLocation() const;
67 
69  virtual void setStationName(DtStationName value);
70  virtual DtStationName stationName() const;
71 
73  virtual void setStationNumber(DtU16 value);
74  virtual DtU16 stationNumber() const;
75 
77  virtual void setEntityType(const DtEntityType& type);
78  virtual const DtEntityType& entityType() const;
79 
81  virtual void printData() const;
82 
84  virtual void printDataToStream(std::ostream& stream) const;
85 
86 public:
87 
90  static DtPdu* create(const DtNetPacket* initial,
91  DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0);
92 
95  static void addCallback(DtExerciseConn* conn,
96  DtIsPartOfPduCb cb, void* usr);
97  static void removeCallback(DtExerciseConn* conn,
98  DtIsPartOfPduCb cb, void* usr);
99 
100 protected:
101 
103  virtual DtPduKind internalGetPduKind() const;
104 
107  virtual DtNetIsPartOfPdu* netPduStruct() const;
108 
111  DtIsPartOfPdu* self() const;
112 
113 protected:
114 
116  static const int theStaticSize;
117 
118 protected:
119 
124 
125 };
126 
127 #endif
DtInteraction is an base class for representing DIS PDUs which don&#39;t have state.
Definition: interactionDIS.h:24
Instances of DtExerciseConn are used to provide an application&#39;s interface or connection to the netwo...
Definition: exerciseConnDIS.h:61
DtInteraction & operator=(const DtInteraction &orig)
assignment operator
#define DT_DLL_VL
Definition: vlMachineTypes.h:108
DtNature
IsPartOf PDU enums.
Definition: disEnums.h:2411
DtStationName
Definition: disEnums.h:2433
Definition: pduHeader.h:14
class DtPduFactory:
Definition: pduFactory.h:38
DtPosition
Definition: disEnums.h:2426
Instances of DtIsPartOfPdu are used to join two simulation entities to form a single entity...
Definition: isPartOfPdu.h:31
virtual void printDataToStream(std::ostream &stream) const
DtEntityIdentifier myEntityID
Temporary objects for reference returns.
Definition: isPartOfPdu.h:121
This file defines math constants and methods which may be useful in simulations.
DtEntityType myEntityType
Definition: isPartOfPdu.h:123
Definition: vlVector.h:224
virtual DtPduKind internalGetPduKind() const =0
Returns the PDU kind associated with the derived PDU class.
DtPdu is the base class for all PDU&#39;s in VR-Link.
Definition: pdu.h:69
The following is the network structure for the IsPartOf PDU.
Definition: isPartOfP.h:17
Instances of DtEntityIdentifier are used as a unique ID for entities in DIS.
Definition: entityIdentifier.h:31
This file provides protocol to independence DtExerciseConn.
virtual void printData() const
Print the PDU&#39;s data (not including header).
This file is deprecated - Please see simulationAddress.h, entityIdentifier.h, entityType.h, burstDescriptor.h, and NetStructs.h.
struct DtBufferPlaceHolder * DtBufferPtr
Definition: vlBaseMsg.h:17
unsigned short DtU16
A 16 bit unsigned integer value.
Definition: vlMachineTypes.h:140
#define DtUSE_INTERNAL_BUFFER
Definition: vlBaseMsg.h:22
void(* DtIsPartOfPduCb)(DtIsPartOfPdu *pdu, void *usr)
DtIsPartOfPdu callback function signature.
Definition: isPartOfPdu.h:25
DtPduKind
([UID 4]) - PDU Type
Definition: disEnums.h:238
static const int theStaticSize
Size of PDU with zero data bytes.
Definition: isPartOfPdu.h:116
This file contains typedefs for machine dependant types.
DtVector myVector
Definition: isPartOfPdu.h:122
DtEntityType is used to represent the type an entity object.
Definition: entityType.h:26

Document ID: Generated on Tue Aug 10 00:12:31 EDT 2021 from SVN revision 232765
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)