ConOpSys_Variant_Data_Type.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       ConOpSys_Variant_Data_Type.h
//! @brief      ConOpSys variant data type class header file.
//! @copyright  (C) 2004-2020 ANVILEX LLC
//! @attention  No special attention requered.
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Common/ConOpSys_Variant.h $
//!             $Revision: 2305 $
//!             $Date: 2020-12-25 03:00:01 +0500 (Fr, 25 Dez 2020) $
//!             $Author: minch $
//------------------------------------------------------------------------------
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of ANVILEX nor the names of its contributors may be
//    used to endorse or promote products derived from this software without
//    specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// System includes
//------------------------------------------------------------------------------
 
#include "Defines.h"
 
#if CONOPSYS_TARGET == CONOPSYS_TARGET_DEVICE
#include "Application_Resource_Configuration.h"
#endif
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
enum class TConOpSys_Variant_Data_Type
{
      
  //! @brief Unassigned data type marker
  enum_Unassigned = 0,
 
  //! @brief Unknown data type marker
  enum_Unknown = 255,
 
  //! @brief Variant contains value of boolean data type
  enum_BOOL = 1,
 
  //! @brief Variant contains pointer to value of boolean data type
  enum_PBOOL = 2,
 
  //! @brief Variant contains pointer to array of values of boolean data type
  enum_ABOOL = 108,
 
  //! @brief Variant contains value of U8 data type
  enum_U8 = 3,
 
  //! @brief Variant contains pointer to value of U8 data type
  enum_PU8 = 4,
 
  //! @brief Variant contains pointer to array of values of U8 data type
  enum_AU8 = 109,
 
  //! @brief Variant contains value of I8 data type
  enum_I8 = 5,
 
  //! @brief Variant contains pointer to value of I8 data type
  enum_PI8 = 6,
 
  //! @brief Variant contains pointer to array of values of I8 data type
  enum_AI8 = 110,
 
  //! @brief Variant contains value of U16 data type
  enum_U16 = 7,
 
  //! @brief Variant contains pointer to value of U16 data type
  enum_PU16 = 8,
 
  //! @brief Variant contains pointer to array of values of U16 data type
  enum_AU16 = 111,
 
  //! @brief Variant contains value of I16 data type
  enum_I16 = 9,
 
  //! @brief Variant contains pointer to value of I16 data type
  enum_PI16 = 10,
 
  //! @brief Variant contains pointer to array of values of I16 data type
  enum_AI16 = 112,
 
  //! @brief Variant contains value of U32 data type
  enum_U32 = 11,
 
  //! @brief Variant contains pointer to value of U32 data type
  enum_PU32 = 12,
 
  //! @brief Variant contains pointer to array of values of U32 data type
  enum_AU32 = 113,
 
  //! @brief Variant contains value of I32 data type
  enum_I32 = 13,
 
  //! @brief Variant contains pointer to value of I32 data type
  enum_PI32 = 14,
 
  //! @brief Variant contains pointer to array of values of I32 data type
  enum_AI32 = 114,
 
  //! @brief Variant contains value of U64 data
  enum_U64 = 15,
 
  //! @brief Variant contains pointer to value of U64 data type
  enum_PU64 = 16,
 
  //! @brief Variant contains pointer to array of values of U64 data type
  enum_AU64 = 115,
 
  //! @brief Variant contains value of I64 data type
  enum_I64 = 17,
 
  //! @brief Variant contains pointer to value of I64 data type
  enum_PI64 = 18,
 
  //! @brief Variant contains pointer to array of values of I64 data type
  enum_AI64 = 116,
 
  // Test for U128 datatype supported
  #if ( PARAMETER_DATATYPE_U128_SUPPORT == (true) )
 
  //! @brief Variant contains value of U128 data
  //! @note PU128 data type reserved for future use
  enum_U128 = 19,
 
  //! @brief Variant contains pointer to value of U128 data type
  //! @note PU128 data type reserved for future use
  enum_PU128 = 20,
 
  //! @brief Variant contains pointer to array of values of U128 data type
  //! @note AU128 data type reserved for future use
  enum_AU128 = 117,
 
  #endif
  
  // Test for I128 datatype supported
  #if ( PARAMETER_DATATYPE_I128_SUPPORT == (true) )
 
  //! @brief Variant contains value of I128 data
  //! @note I128 data type reserved for future use
  enum_I128 = 21,
 
  //! @brief Variant contains pointer to value of I128 data type
  //! @note PI128 data type reserved for future use
  enum_PI128 = 22,
 
  //! @brief Variant contains pointer to array of values of I128 data type
  //! @note AI128 data type reserved for future use
  enum_AI128 = 118,
 
  #endif
 
  // Test for U256 datatype supported
  #if ( PARAMETER_DATATYPE_U256_SUPPORT == (true) )
 
  //! @brief Variant contains value of U256 data
  //! @note U256 data type reserved for future use
  enum_U256 = 23,
 
  //! @brief Variant contains pointer to value of U256 data type
  //! @note PU256 data type reserved for future use
  enum_PU256 = 24,
 
  //! @brief Variant contains pointer to array of values of U256 data type
  //! @note AU256 data type reserved for future use
  enum_AU256 = 119,
 
  #endif
 
  // Test for I256 datatype supported
  #if ( PARAMETER_DATATYPE_I256_SUPPORT == (true) )
 
  //! @brief Variant contains value of I256 data
  //! @note PI256 data type reserved for future use
  enum_I256 = 25,
 
  //! @brief Variant contains pointer to value of I256 data type
  //! @note PI256 data type reserved for future use
  enum_PI256 = 26,
 
  //! @brief Variant contains pointer to array of values of I256 data type
  enum_AI256 = 120,
 
  #endif
 
  //----------------------------------------------------------------------------
  // F16 datatype
  //----------------------------------------------------------------------------
  
  // Test for F16 datatype supported
  #if ( PARAMETER_DATATYPE_F16_SUPPORT == (true) )
  
  //! @brief Variant contains value of F16 data
  //! @note F16 data type reserved for future use
  enum_F16 = 27,
 
  //! @brief Variant contains pointer to value of F16 data type
  //! @note PF16 data type reserved for future use
  enum_PF16 = 28,
      
  //! @brief Variant contains pointer to array of values of F16 data type
  //! @note F16 data type reserved for future use
  enum_AF16 = 121,
 
  #endif
 
  //----------------------------------------------------------------------------
  // F32 datatype
  //----------------------------------------------------------------------------
  
  //! @brief Variant contains value of F32 data
  enum_F32 = 29,
      
  //! @brief Variant contains pointer to value of F32 data type
  enum_PF32 = 30,
 
  //! @brief Variant contains pointer to array of values of F32 data type
  enum_AF32 = 122,
 
  //----------------------------------------------------------------------------
  // F64 datatype
  //----------------------------------------------------------------------------
 
  //! @brief Variant contains value of F64 data
  enum_F64 = 31,
      
  //! @brief Variant contains pointer to value of F64 data type
  enum_PF64 = 32,
 
  //! @brief Variant contains pointer to array of values of F64 data type
  enum_AF64 = 123,
 
  //----------------------------------------------------------------------------
  // F80 datatype
  //----------------------------------------------------------------------------
 
  // Test for F80 datatype supported
  #if ( PARAMETER_DATATYPE_F80_SUPPORT == (true) )
 
  //! @brief Variant contains value of F80 data
  //! @note F80 data type reserved for future use
  enum_F80 = 33,    // Reserved
 
  //! @brief Variant contains pointer to value of F80 data type
  //! @note PF80 data type reserved for future use
  enum_PF80 = 34,   // Reserved
 
  //! @brief Variant contains pointer to array of values of F80 data type
  //! @note AF80 data type reserved for future use
  enum_AF80 = 124,
 
  #endif
 
  //----------------------------------------------------------------------------
  // F128 datatype
  //----------------------------------------------------------------------------
 
  // Test for F128 datatype supported
  #if ( PARAMETER_DATATYPE_F128_SUPPORT == (true) )
 
  //! @brief Variant contains value of F128 data
  //! @note F128 data type reserved for future use
  enum_F128 = 35,
  
  //! @brief Variant contains pointer to value of F128 data type
  //! @note PF128 data type reserved for future use
  enum_PF128 = 36,
  
  //! @brief Variant contains pointer to array of values of F128 data type
  //! @note AF128 data type reserved for future use
  enum_AF128 = 125,
 
  #endif
 
  //----------------------------------------------------------------------------
  // F256 datatype
  //----------------------------------------------------------------------------
 
  // Test for F256 datatype supported
  #if ( PARAMETER_DATATYPE_F256_SUPPORT == (true) )
 
  //! @brief Variant contains value of F256 data
  //! @note F256 data type reserved for future use
  enum_F256 = 37,
  
  //! @brief Variant contains pointer to value of F256 data type
  //! @note PF256 data type reserved for future use
  enum_PF256 = 38,
  
  //! @brief Variant contains pointer to array of values of F256 data type
  //! @note AF256 data type reserved for future use
  enum_AF256 = 126,
 
  #endif
 
  // Test for IQ datatype supported
  #if ( PARAMETER_DATATYPE_IQ_SUPPORT == (true) )
 
  // Fixed point data types
  enum_IQ1 = 39,
  enum_PIQ1 = 40,
      
  enum_IQ2 = 41,
  enum_PIQ2 = 42,
      
  enum_IQ3 = 43,
  enum_PIQ3 = 44,
      
  enum_IQ4 = 45,
  enum_PIQ4 = 46,
      
  enum_IQ5 = 47,
  enum_PIQ5 = 48,
      
  enum_IQ6 = 49,
  enum_PIQ6 = 50,
      
  enum_IQ7 = 51,
  enum_PIQ7 = 52,
      
  enum_IQ8 = 53,
  enum_PIQ8 = 54,
      
  enum_IQ9 = 55,
  enum_PIQ9 = 56,
      
  enum_IQ10 = 57,
  enum_PIQ10 = 58,
      
  enum_IQ11 = 59,
  enum_PIQ11 = 60,
      
  enum_IQ12 = 61,
  enum_PIQ12 = 62,
      
  enum_IQ13 = 63,
  enum_PIQ13 = 64,
      
  enum_IQ14 = 65,
  enum_PIQ14 = 66,
      
  enum_IQ15 = 67,
  enum_PIQ15 = 68,
      
  enum_IQ16 = 69,
  enum_PIQ16 = 70,
      
  enum_IQ17 = 71,
  enum_PIQ17 = 72,
      
  enum_IQ18 = 73,
  enum_PIQ18 = 74,
      
  enum_IQ19 = 75,
  enum_PIQ19 = 76,
      
  enum_IQ20 = 77,
  enum_PIQ20 = 78,
      
  enum_IQ21 = 79,
  enum_PIQ21 = 80,
      
  enum_IQ22 = 81,
  enum_PIQ22 = 82,
      
  enum_IQ23 = 83,
  enum_PIQ23 = 84,
      
  enum_IQ24 = 85,
  enum_PIQ24 = 86,
      
  enum_IQ25 = 87,
  enum_PIQ25 = 88,
      
  enum_IQ26 = 89,
  enum_PIQ26 = 90,
      
  enum_IQ27 = 91,
  enum_PIQ27 = 92,
      
  enum_IQ28 = 93,
  enum_PIQ28 = 94,
      
  enum_IQ29 = 95,
  enum_PIQ29 = 96,
      
  enum_IQ30 = 97,
  enum_PIQ30 = 98,
      
  enum_IQ31 = 99,
  enum_PIQ31 = 100,
      
  enum_IQ32 = 101,
  enum_PIQ32 = 102,
 
  #endif
 
  //! @brief String data types
  enum_DS = 103,
 
  //! @brief Date and time
  //! @note Reserved
  enum_DT = 104,
 
  //! @brief
  //! @note Reserved
  enum_LDT64 = 105,
 
  //! @brief Compressed data and time
  //! @note Reserved
  enum_CDT64 = 106,
 
  //! @brief Record datatype
  enum_R32 = 107,
 
  //! @brief Virtual machine command data type
  enum_VMP = 127,
 
  //! @brief Virtual machine array of commands data type
  enum_AVMP = 128,
 
  // NOTE: Last number 129
 
};
 
//------------------------------------------------------------------------------
 
BOOL Is_ConOpSys_Variant_Data_Type_Element( TConOpSys_Variant_Data_Type enum_Type );
 
BOOL Is_ConOpSys_Variant_Data_Type_Array( TConOpSys_Variant_Data_Type enum_Type );
 
BOOL Is_ConOpSys_Variant_Data_Type_Pointer( TConOpSys_Variant_Data_Type enum_Type );
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------