include/KDIS/DataTypes/Enums/EnumIFF.hpp

   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     EnumFundamentalOperationalData
  32     created:    5/12/2008
  33     author:     Karl Jones
  34
  35     purpose:    Enums for Fundamental Operational Data
  36 *********************************************************************/
  37
  38 #pragma once
  39
  40 #include "./EnumDescriptor.h"
  41
  42 namespace KDIS {
  43 namespace DATA_TYPE {
  44 namespace ENUMS {
  45
  46 /************************************************************************/
  47 /* Alternate Parameter 4                                                */
  48 /* Used for an alternative representation of parameter 4                */
  49 /* Used In:                                                             */
  50 /*  Fundamental Operational Data                                        */
  51 /************************************************************************/
  52
  53 enum AlternateParameter4
  54 {
  55     OtherAlternateParameter4                                          = 0,
  56     Valid                                                             = 1,
  57     Invalid                                                           = 2,
  58     NoResponse                                                        = 3,
  59     // 4+ Not used
  60 };
  61
  62 // Returns number of values in the EnumDescriptor for this enum.
  63 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
  64 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
  65 KDIS_EXPORT KUINT32 GetEnumSizeAlternateParameter4();
  66
  67 // Returns the EnumDescriptor value for the specified index.
  68 // Use GetEnumSize<enum> to get the array size.
  69 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
  70 KDIS_EXPORT const EnumDescriptor * GetEnumDescriptorAlternateParameter4( KUINT32 Index );
  71
  72 KDIS_EXPORT KString GetEnumAsStringAlternateParameter4( KINT32 Value );
  73
  74 // Returns true if a value was found.
  75 KDIS_EXPORT KBOOL GetEnumFromStringAlternateParameter4( const KString & Value, KINT32 & ValueOut );
  76
  77 /************************************************************************/
  78 /* TCAS                                                                 */
  79 /* TCAS Version                                                         */
  80 /* Used In:                                                             */
  81 /*  Fundamental Operational Data System 1                               */
  82 /************************************************************************/
  83
  84 enum TCAS
  85 {
  86     TCAS_I                                                            = 0,
  87     TCAS_II                                                           = 1
  88 };
  89
  90 // Returns number of values in the EnumDescriptor for this enum.
  91 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
  92 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
  93 KDIS_EXPORT KUINT32 GetEnumSizeTCAS();
  94
  95 // Returns the EnumDescriptor value for the specified index.
  96 // Use GetEnumSize<enum> to get the array size.
  97 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
  98 KDIS_EXPORT const EnumDescriptor * GetEnumDescriptorTCAS( KUINT32 Index );
  99
 100 KDIS_EXPORT KString GetEnumAsStringTCAS( KINT32 Value );
 101
 102 // Returns true if a value was found.
 103 KDIS_EXPORT KBOOL GetEnumFromStringTCAS( const KString & Value, KINT32 & ValueOut );
 104
 105 #if DIS_VERSION > 6
 106
 107 /************************************************************************/
 108 /* Mode 5 Message Format                                                */
 109 /* Indicate the Mode 5 Message Format.                                  */
 110 /* Used In:                                                             */
 111 /*  Mode 5 Interrogator Status                                          */
 112 /************************************************************************/
 113
 114 enum Mode5MessageFormat
 115 {
 116     Capability                                                        = 0,
 117     ActiveInterrogation                                               = 1
 118 };
 119
 120 // Returns number of values in the EnumDescriptor for this enum.
 121 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
 122 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
 123 KDIS_EXPORT KUINT32 GetEnumSizeMode5MessageFormat();
 124
 125 // Returns the EnumDescriptor value for the specified index.
 126 // Use GetEnumSize<enum> to get the array size.
 127 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
 128 KDIS_EXPORT const EnumDescriptor * GetEnumDescriptorMode5MessageFormat( KUINT32 Index );
 129
 130 KDIS_EXPORT KString GetEnumAsStringMode5MessageFormat( KINT32 Value );
 131
 132 // Returns true if a value was found.
 133 KDIS_EXPORT KBOOL GetEnumFromStringMode5MessageFormat( const KString & Value, KINT32 & ValueOut );
 134
 135 /************************************************************************/
 136 /* Mode 5 Reply                                                         */
 137 /* Specifies the validity of a reply that would be transmitted          */
 138 /* by a Mode 5 transponder if interrogated.                             */
 139 /* Used In:                                                             */
 140 /*  Mode 5 Transponder Status                                           */
 141 /************************************************************************/
 142
 143 enum Mode5Reply
 144 {
 145     NoResponseReply                                                   = 0,
 146     ValidReply                                                        = 1,
 147     InvalidReply                                                      = 2,
 148     UnableToVerify                                                    = 3
 149 };
 150
 151 // Returns number of values in the EnumDescriptor for this enum.
 152 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
 153 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
 154 KDIS_EXPORT KUINT32 GetEnumSizeMode5Reply();
 155
 156 // Returns the EnumDescriptor value for the specified index.
 157 // Use GetEnumSize<enum> to get the array size.
 158 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
 159 KDIS_EXPORT const EnumDescriptor * GetEnumDescriptorMode5Reply( KUINT32 Index );
 160
 161 KDIS_EXPORT KString GetEnumAsStringMode5Reply( KINT32 Value );
 162
 163 // Returns true if a value was found.
 164 KDIS_EXPORT KBOOL GetEnumFromStringMode5Reply( const KString & Value, KINT32 & ValueOut );
 165
 166 /************************************************************************/
 167 /* Antenna Selection                                                    */
 168 /* The present Mode 5 transponder antenna selection                     */
 169 /* Used In:                                                             */
 170 /*  Mode 5 Transponder Status                                           */
 171 /************************************************************************/
 172
 173 enum AntennaSelection
 174 {
 175     AntennaSelectionNoStatement                                       = 0,
 176     Top                                                               = 1,
 177     Bottom                                                            = 2,
 178     Diversity                                                         = 3
 179 };
 180
 181 // Returns number of values in the EnumDescriptor for this enum.
 182 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
 183 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
 184 KDIS_EXPORT KUINT32 GetEnumSizeAntennaSelection();
 185
 186 // Returns the EnumDescriptor value for the specified index.
 187 // Use GetEnumSize<enum> to get the array size.
 188 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
 189 KDIS_EXPORT const EnumDescriptor * GetEnumDescriptorAntennaSelection( KUINT32 Index );
 190
 191 KDIS_EXPORT KString GetEnumAsStringAntennaSelection( KINT32 Value );
 192
 193 // Returns true if a value was found.
 194 KDIS_EXPORT KBOOL GetEnumFromStringAntennaSelection( const KString & Value, KINT32 & ValueOut );
 195
 196 /************************************************************************/
 197 /* Platform Type                                                            */
 198 /* The type of platform (air or ground) that is associated with a Mode  */
 199 /* 5 transponder.                                                       */
 200 /* Used In:                                                             */
 201 /*  Mode 5 Transponder Status                                           */
 202 /************************************************************************/
 203
 204 enum PlatformType
 205 {
 206     GroundPlatformType                                                = 0,
 207     AirPlatformType                                                   = 1
 208 };
 209
 210 // Returns number of values in the EnumDescriptor for this enum.
 211 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
 212 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
 213 KDIS_EXPORT KUINT32 GetEnumSizePlatformType();
 214
 215 // Returns the EnumDescriptor value for the specified index.
 216 // Use GetEnumSize<enum> to get the array size.
 217 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
 218 KDIS_EXPORT const EnumDescriptor * GetEnumDescriptorPlatformType( KUINT32 Index );
 219
 220 KDIS_EXPORT KString GetEnumAsStringPlatformType( KINT32 Value );
 221
 222 // Returns true if a value was found.
 223 KDIS_EXPORT KBOOL GetEnumFromStringPlatformType( const KString & Value, KINT32 & ValueOut );
 224
 225 /************************************************************************/
 226 /* Navigation Source                                                    */
 227 /* The navigation source.                                               */
 228 /* Used In:                                                             */
 229 /*  Mode 5 Transponder Basic Data                                       */
 230 /************************************************************************/
 231
 232 enum NavigationSource
 233 {
 234     NoStatementNavigationSource                                       = 0,
 235     GPS                                                               = 1,
 236     INS                                                               = 2,
 237     INS_GPS                                                           = 3
 238 };
 239
 240 // Returns number of values in the EnumDescriptor for this enum.
 241 // This can be used to iterate through all possible enum values by using GetEnumDescriptor<enum>.
 242 // If KDIS_USE_ENUM_DESCRIPTORS is not set then 0 will be returned.
 243 KDIS_EXPORT KUINT32 GetEnumSizeNavigationSource();
 244
 245 // Returns the EnumDescriptor value for the specified index.
 246 // Use GetEnumSize<enum> to get the array size.
 247 // If KDIS_USE_ENUM_DESCRIPTORS is not set then NULL will be returned.
 248 KDIS_EXPORT const EnumDescriptor * GetEnumDescriptorNavigationSource( KUINT32 Index );
 249
 250 KDIS_EXPORT KString GetEnumAsStringNavigationSource( KINT32 Value );
 251
 252 // Returns true if a value was found.
 253 KDIS_EXPORT KBOOL GetEnumFromStringNavigationSource( const KString & Value, KINT32 & ValueOut );
 254
 255 #endif // DIS 6
 256
 257 } // END namespace ENUMS
 258 } // END namespace DATA_TYPES
 259 } // END namespace KDIS