KDIS/KDIS/PDU/Live_Entity/Articulated_Parts_PDU.h

   1 /*********************************************************************
   2 Copyright 2013 Karl Jones
   3 All rights reserved.
   4
   5 Redistribution and use in source and binary forms, with or without
   6 modification, are permitted provided that the following conditions are met:
   7
   8 1. Redistributions of source code must retain the above copyright notice, this
   9    list of conditions and the following disclaimer.
  10 2. Redistributions in binary form must reproduce the above copyright notice,
  11    this list of conditions and the following disclaimer in the documentation
  12    and/or other materials provided with the distribution.
  13
  14 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  15 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  17 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
  18 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  19 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  20 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  21 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  23 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24
  25 For Further Information Please Contact me at
  26 Karljj1@yahoo.com
  27 http://p.sf.net/kdis/UserGuide
  28 *********************************************************************/
  29
  30 /********************************************************************
  31     class:      Articulated_Parts_PDU
  32     DIS:        (6) 1278.1a - 1998
  33     created:    17/07/2010
  34     author:     Karl Jones
  35
  36     purpose:    Contains information about the articulated and attached parts of a live entity.
  37
  38     size:       136 bits / 17 octets - Min size
  39 *********************************************************************/
  40
  41 #pragma once
  42
  43 #include "./LE_Header.h"
  44 #include "./../../DataTypes/VariableParameter.h"
  45 #include <vector>
  46
  47 namespace KDIS {
  48 namespace PDU {
  49
  50 class KDIS_EXPORT Articulated_Parts_PDU : public LE_Header
  51 {
  52 protected:
  53
  54     KUINT8 m_ui8NumOfVariableParams;
  55
  56     std::vector<KDIS::DATA_TYPE::VarPrmPtr> m_vVariableParameters;
  57
  58 public:
  59
  60     static const KUINT16 ARTICULATED_PARTS_PDU_SIZE = 17; // Min size
  61
  62     Articulated_Parts_PDU();
  63
  64     Articulated_Parts_PDU( KDataStream & stream ) ;
  65
  66     Articulated_Parts_PDU( const Header & H, KDataStream & stream ) ;
  67
  68     Articulated_Parts_PDU( const KDIS::DATA_TYPE::LE_EntityIdentifier & ID );
  69
  70     virtual ~Articulated_Parts_PDU();
  71
  72     //************************************
  73     // FullName:    KDIS::PDU::Articulated_Parts_PDU::GetNumberOfVariableParams
  74     // Description: Number of variable parameters.
  75     //************************************
  76     KUINT8 GetNumberOfVariableParams() const;
  77
  78     //************************************
  79     // FullName:    KDIS::PDU::Articulated_Parts_PDU::AddVariableParameter
  80     //              KDIS::PDU::Articulated_Parts_PDU::SetVariableParameter
  81     //              KDIS::PDU::Articulated_Parts_PDU::GetVariableParameters
  82     //              KDIS::PDU::Articulated_Parts_PDU::ClearVariableParameters
  83     // Description: Information associated with an entity or detonation, not otherwise accounted
  84     //              for in a PDU such as Articulated and Attached Parts.
  85     //              See VariableParameter for supported/implemented types.
  86     // Parameter:   VarPrmPtr VP, vector<VarPrmPtr> & VP
  87     //************************************
  88     void AddVariableParameter( KDIS::DATA_TYPE::VarPrmPtr VP );
  89     void SetVariableParameters( const std::vector<KDIS::DATA_TYPE::VarPrmPtr> & VP );
  90     const std::vector<KDIS::DATA_TYPE::VarPrmPtr> & GetVariableParameters() const;
  91     void ClearVariableParameters();
  92
  93     //************************************
  94     // FullName:    KDIS::PDU::Articulated_Parts_PDU::GetAsString
  95     // Description: Returns a string representation of the PDU
  96     //************************************
  97     virtual KString GetAsString() const;
  98
  99     //************************************
 100     // FullName:    KDIS::PDU::Articulated_Parts_PDU::Decode
 101     // Description: Convert From Network Data.
 102     // Parameter:   KDataStream & stream
 103     // Parameter:   bool ignoreHeader = false - Decode the header from the stream?
 104     //************************************
 105     virtual void Decode( KDataStream & stream, bool ignoreHeader = false ) ;
 106
 107     //************************************
 108     // FullName:    KDIS::PDU::Articulated_Parts_PDU::Encode
 109     // Description: Convert To Network Data.
 110     // Parameter:   KDataStream & stream
 111     //************************************
 112     virtual KDataStream Encode() const;
 113     virtual void Encode( KDataStream & stream ) const;
 114
 115     KBOOL operator == ( const Articulated_Parts_PDU & Value ) const;
 116     KBOOL operator != ( const Articulated_Parts_PDU & Value ) const;
 117 };
 118
 119 } // END namespace PDU
 120 } // END namespace KDIS