open-dis-cpp
PduSuperclass.h
1 #pragma once
2 
3 #include <dis7/utils/DataStream.h>
4 #include <dis7/opendis7_export.h>
5 
6 
7 namespace DIS
8 {
9 // The superclass for all PDUs, including classic and Live Entity (LE) PDUs. This incorporates the PduHeader record, section 7.2.2
10 
11 // Copyright (c) 2007-2009, MOVES Institute, Naval Postgraduate School. All rights reserved.
12 //
13 // @author DMcG, jkg
14 
15 class OPENDIS7_EXPORT PduSuperclass
16 {
17 protected:
19  unsigned char _protocolVersion;
20 
22  unsigned char _exerciseID;
23 
25  unsigned char _pduType;
26 
28  unsigned char _protocolFamily;
29 
31  unsigned int _timestamp;
32 
34  unsigned short _length;
35 
36 
37  public:
38  PduSuperclass();
39  virtual ~PduSuperclass();
40 
41  virtual void marshal(DataStream& dataStream) const;
42  virtual void unmarshal(DataStream& dataStream);
43 
44  unsigned char getProtocolVersion() const;
45  void setProtocolVersion(unsigned char pX);
46 
47  unsigned char getExerciseID() const;
48  void setExerciseID(unsigned char pX);
49 
50  unsigned char getPduType() const;
51  void setPduType(unsigned char pX);
52 
53  unsigned char getProtocolFamily() const;
54  void setProtocolFamily(unsigned char pX);
55 
56  unsigned int getTimestamp() const;
57  void setTimestamp(unsigned int pX);
58 
59  unsigned short getLength() const;
60  void setLength(unsigned short pX);
61 
62 
63 virtual int getMarshalledSize() const;
64 
65  bool operator ==(const PduSuperclass& rhs) const;
66 };
67 }
68 
69 // Copyright (c) 1995-2009 held by the author(s). All rights reserved.
70 // Redistribution and use in source and binary forms, with or without
71 // modification, are permitted provided that the following conditions
72 // are met:
73 //
74 // * Redistributions of source code must retain the above copyright
75 // notice, this list of conditions and the following disclaimer.
76 // * Redistributions in binary form must reproduce the above copyright
77 // notice, this list of conditions and the following disclaimer
78 // in the documentation and/or other materials provided with the
79 // distribution.
80 // * Neither the names of the Naval Postgraduate School (NPS)
81 // Modeling Virtual Environments and Simulation (MOVES) Institute
82 // (http://www.nps.edu and http://www.MovesInstitute.org)
83 // nor the names of its contributors may be used to endorse or
84 // promote products derived from this software without specific
85 // prior written permission.
86 //
87 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
88 // AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
89 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
90 // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
91 // COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
92 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
93 // BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
94 // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
95 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
96 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
97 // ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
98 // POSSIBILITY OF SUCH DAMAGE.
Symbolic names as defined in 5.1.4.
Definition: AcknowledgePdu.h:8
unsigned char _protocolVersion
The version of the protocol.
Definition: PduSuperclass.h:19
a class to support managing a network buffer.
Definition: DataStream.h:28
unsigned short _length
Length, in bytes, of the PDU.
Definition: PduSuperclass.h:34
Definition: PduSuperclass.h:15
unsigned char _exerciseID
Exercise ID.
Definition: PduSuperclass.h:22
unsigned char _protocolFamily
value that refers to the protocol family, eg SimulationManagement, et
Definition: PduSuperclass.h:28
unsigned int _timestamp
Timestamp value.
Definition: PduSuperclass.h:31
unsigned char _pduType
Type of pdu, unique for each PDU class.
Definition: PduSuperclass.h:25