KDIS/DataTypes/JammingTechnique.h

   1 /*********************************************************************
   2 Copyright 2017 Karl Jones
   3                Dale Marchand
   4 All rights reserved.
   5
   6 Redistribution and use in source and binary forms, with or without
   7 modification, are permitted provided that the following conditions are met:
   8
   9 1. Redistributions of source code must retain the above copyright notice, this
  10    list of conditions and the following disclaimer.
  11 2. Redistributions in binary form must reproduce the above copyright notice,
  12    this list of conditions and the following disclaimer in the documentation
  13    and/or other materials provided with the distribution.
  14
  15 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  16 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  17 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
  19 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  20 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  21 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  22 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  24 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25
  26 For Further Information Please Contact me at
  27 Karljj1@yahoo.com
  28 http://p.sf.net/kdis/UserGuide
  29 *********************************************************************/
  30
  31 /********************************************************************
  32     class:      JammingTechnique
  33     created:    2017/06/30
  34     author:     Dale Marchand
  35
  36     purpose:    Contains information about a emitter beam
  37     size:       32 bits / 4 octets size
  38 *********************************************************************/
  39
  40 #pragma once
  41
  42 #include "./DataTypeBase.h"
  43 #include <vector>
  44
  45 namespace KDIS {
  46 namespace DATA_TYPE {
  47
  48 #if DIS_VERSION > 6
  49
  50 class KDIS_EXPORT JammingTechnique : public DataTypeBase
  51 {
  52 protected:
  53
  54     KUINT8 m_ui8Kind;
  55
  56     KUINT8 m_ui8Category;
  57
  58     KUINT8 m_ui8Subcategory;
  59
  60     KUINT8 m_ui8Specific;
  61
  62 public:
  63
  64     static const KUINT16 JAMMING_TECHNIQUE_SIZE = 4;
  65
  66     JammingTechnique();
  67
  68     JammingTechnique( KDataStream & stream );
  69
  70     JammingTechnique( KUINT8 KIND, KUINT8 CATEGORY, KUINT8 SUBCATEGORY,
  71                  KUINT8 SPECIFIC );
  72
  73     virtual ~JammingTechnique();
  74
  75     //************************************
  76     // FullName:    KDIS::DATA_TYPE::JammingTechnique::SetKind
  77     //              KDIS::DATA_TYPE::JammingTechnique::GetKind
  78     // Description: Kind.
  79     // Parameter:   KUINT8 KIND, void
  80     //************************************
  81     void SetKind( KUINT8 KIND );
  82     KUINT8 GetKind() const;
  83
  84     //************************************
  85     // FullName:    KDIS::DATA_TYPE::JammingTechnique::SetCategory
  86     //              KDIS::DATA_TYPE::JammingTechnique::GetCategory
  87     // Description: Category.
  88     // Parameter:   KUINT8 CATEGORY, void
  89     //************************************
  90     void SetCategory( KUINT8 CATEGORY );
  91     KUINT8 GetCategory() const;
  92
  93     //************************************
  94     // FullName:    KDIS::DATA_TYPE::JammingTechnique::SetSubcategory
  95     //              KDIS::DATA_TYPE::JammingTechnique::GetSubcategory
  96     // Description: Kind.
  97     // Parameter:   KUINT8 SUBCATEGORY, void
  98     //************************************
  99     void SetSubcategory( KUINT8 SUBCATEGORY );
 100     KUINT8 GetSubcategory() const;
 101
 102     //************************************
 103     // FullName:    KDIS::DATA_TYPE::JammingTechnique::SetSpecific
 104     //              KDIS::DATA_TYPE::JammingTechnique::GetSpecific
 105     // Description: Kind.
 106     // Parameter:   KUINT8 SPECIFIC, void
 107     //************************************
 108     void SetSpecific( KUINT8 SPECIFIC );
 109     KUINT8 GetSpecific() const;
 110
 111     //************************************
 112     // FullName:    KDIS::DATA_TYPE::JammingTechnique::GetAsString
 113     // Description: Returns a string representation
 114     //************************************
 115     virtual KString GetAsString() const;
 116
 117     //************************************
 118     // FullName:    KDIS::DATA_TYPE::JammingTechnique::Decode
 119     // Description: Convert From Network Data.
 120     // Parameter:   KDataStream & stream
 121     //************************************
 122     virtual void Decode( KDataStream & stream ) ;
 123
 124     //************************************
 125     // FullName:    KDIS::DATA_TYPE::JammingTechnique::Encode
 126     // Description: Convert To Network Data.
 127     // Parameter:   KDataStream & stream
 128     //************************************
 129     virtual KDataStream Encode() const;
 130     virtual void Encode( KDataStream & stream ) const;
 131
 132     KBOOL operator == ( const JammingTechnique & Value ) const;
 133     KBOOL operator != ( const JammingTechnique & Value ) const;
 134 };
 135
 136 #endif
 137
 138 } // END namespace DATA_TYPES
 139 } // END namespace KDIS