KG3_LCSI.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file        KG3_LCSI.h
//! @author      ANVILEX GmbH
//! @version     V1.0
//! @date        30.04.2021
//! @brief       Function block KG3_LCSI_T1 class header file.
//! @attention   No special attention requered.
//! @copyright   (C) 2015-2021 ANVILEX LLC
//!
//! COPYRIGHT(C) 2021 ANVILEX GmbH
//!
//! 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.
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Function_Block_Base.h"
#include "PRT_Sensor.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//! @brief Function block class declaration
//------------------------------------------------------------------------------
 
class TKG3_LCSI_T1 : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, variables and methods
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public defines
    //--------------------------------------------------------------------------
    
    //! @brief Register structure for generic access
    typedef struct
    {
 
      //! @brief 0x00 : Module identification register
      U16 u16_Unit_ID_L;
      
      //! @brief 0x01 : Module identification register
      U16 u16_Unit_ID_H;
    
      //! @brief 0x02 : Status register
      U16 u16_Status_Register;
 
      //! @brief 0x03 : Inlet filtred temperature register
      U16 u16_Inlet_Filtred_Temperature;
      
      //! @brief 0x04 : Outlet filtred temperature register
      U16 u16_Outlet_Filtred_Temperature;
      
      //! @brief 0x05 : Inlet filtred pressure register
      U16 u16_Inlet_Filtred_Pressure;
      
      //! @brief 0x06 : Outlet filtred pressure register
      U16 u16_Outlet_Filtred_Pressure;
      
      //! @brief 0x07 : Inlet pure temperature register
      U16 u16_Inlet_Pure_Temperature;
      
      //! @brief 0x08 : Outlet pure temperature register
      U16 u16_Outlet_Pure_Temperature;
      
      //! @brief 0x09 : Inlet pure pressure register
      U16 u16_Inlet_Pure_Pressure;
      
      //! @brief 0x0A : Outlet pure pressure register
      U16 u16_Outlet_Pure_Pressure;
 
    } TKG3_LCSI_T1_Registers;
  
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TKG3_LCSI_T1();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class desstructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TKG3_LCSI_T1();
 
    //!-------------------------------------------------------------------------
    //! @brief     Hardware mapping method.
    //! @note      None
    //! @param     [in] *struct_Registers_Base_Address - Base adress to register structure mapping
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Map( TKG3_LCSI_T1_Registers *struct_Registers_Base_Address );
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block initialisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block execution method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Send information about driver over communication link protocol
    //! @note      This method sends information driver over specified communication link protocol.
    //! @param     [in] *object_Protocol - Pointer to the communication link protocol
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Function block parameters
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block inputs
    //--------------------------------------------------------------------------
 
    //! @brief 32-bit floating point input
    TBlock_Input_Connector object_f32_Inlet_Temperature_Gain;
    
    //! @brief 32-bit floating point input
    TBlock_Input_Connector object_f32_Outlet_Temperature_Gain;
    
    //! @brief 32-bit floating point input
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_Inlet_Pressure_Current;
    
    //! @brief 32-bit floating point input
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_Outlet_Pressure_Current;
    
    //! @brief Outlet pressure gain
    TBlock_Input_Connector object_f32_Inlet_Pressure_Gain;
    
    //! @brief Intlet pressure gain
    TBlock_Input_Connector object_f32_Outlet_Pressure_Gain;
    
    //! @brief 32-bit floating point input
    TBlock_Input_Connector object_f32_Inlet_Pressure_Offset;
    
    //! @brief 32-bit floating point input
    TBlock_Input_Connector object_f32_Outlet_Pressure_Offset;
    
    //! @brief High inlet pressure bound
    TBlock_Input_Connector object_f32_High_Bound_Inlet_Pressure;
    
    //! @brief Low inlet pressure bound
    TBlock_Input_Connector object_f32_Low_Bound_Inlet_Pressure;
    
    //! @brief High outlet pressure bound
    TBlock_Input_Connector object_f32_High_Bound_Outlet_Pressure;
    
    //! @brief Low outlet pressure bound
    TBlock_Input_Connector object_f32_Low_Bound_Outlet_Pressure;
    
    //! @brief 32-bit floating point input
    TBlock_Input_Connector object_f32_Inlet_Temperature_Offset;
    
    //! @brief 32-bit floating point input
    TBlock_Input_Connector object_f32_Outlet_Temperature_Offset;
 
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------    
    
    //! @brief 16-bit unsigned integer output
    TBlock_Output_Connector object_u16_Inlet_Temperature_Raw_Data;
    
    //! @brief 16-bit unsigned integer output
    TBlock_Output_Connector object_u16_Outlet_Temperature_Raw_Data;
    
    //! @brief 16-bit unsigned integer output
    TBlock_Output_Connector object_u16_Inlet_Pressure_Raw_Data;
    
    //! @brief 16-bit unsigned integer output
    TBlock_Output_Connector object_u16_Outlet_Pressure_Raw_Data;
    
    //! @brief 32-bit floating point output
    TBlock_Output_Connector object_f32_Inlet_Pressure_Value;
    
    //! @brief 32-bit floating point output
    TBlock_Output_Connector object_f32_Outlet_Pressure_Value;
    
    //! @brief 32-bit floating point output
    TBlock_Output_Connector object_f32_Inlet_Temperature_Value;
    
    //! @brief 32-bit floating point output
    TBlock_Output_Connector object_f32_Outlet_Temperature_Value;
 
  //----------------------------------------------------------------------------
  // Protected variables and methods
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private variables and methods
  //----------------------------------------------------------------------------
 
  private:
    
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
    
    //! @brief object PRT
    TPRT object_PRT;
  
    //! @brief Inlet temperature raw data
    U16 u16_Inlet_Temperature_Raw_Data = (U16)0x00;
  
    //! @brief Outlet temperature raw data
    U16 u16_Outlet_Temperature_Raw_Data = (U16)0x00;
  
    //! @brief Inlet pressue raw data
    U16 u16_Inlet_Pressure_Raw_Data = (U16)0x00;
  
    //! @brief Outlet pressue raw data
    U16 u16_Outlet_Pressure_Raw_Data = (U16)0x00;
    
    //! @brief Inlet temperature value
    F32 f32_Inlet_Temperature_Value = (F32)0.0f;
  
    //! @brief Outlet temperature value
    F32 f32_Outlet_Temperature_Value = (F32)0.0f;
  
    //! @brief Inlet pressue value
    F32 f32_Inlet_Pressure_Value = (F32)0.0f;
    
    //! @brief Outlet pressue value
    F32 f32_Outlet_Pressure_Value = (F32)0.0f;
    
    //! @brief Inlet temperature sensor valid data count
    U32 u32_Sensor_Valid_Data_Count_Inlet_Temperature = (F32)0.0f;
 
    //! @brief Inlet temperature open sensor error count
    U32 u32_Sensor_Open_Error_Count_Inlet_Temperature = (F32)0.0f;
 
    //! @brief Inlet temperature short sensor error count
    U32 u32_Sensor_Short_Error_Count_Inlet_Temperature = (F32)0.0f;
  
    //! @brief Inlet temperature sensor valid data count
    U32 u32_Sensor_Valid_Data_Count_Outlet_Temperature = (F32)0.0f;
 
    //! @brief Inlet temperature open sensor error count
    U32 u32_Sensor_Open_Error_Count_Outlet_Temperature = (F32)0.0f;
 
    //! @brief Inlet temperature short sensor error count
    U32 u32_Sensor_Short_Error_Count_Outlet_Temperature = (F32)0.0f;
    
    //! @brief Coefficient for inlet pressure 
    F32 f32_K_Inlet_Pressure = (F32)1.0f;
 
    //! @brief Coefficient for outlet pressure
    F32 f32_K_Outlet_Pressure = (F32)1.0f;
 
    //! @brief Offset for inlet pressure
    F32 f32_Offset_Inlet_Pressure = (F32)0.0f;
 
    //! @brief Offset for outlet pressure
    F32 f32_Offset_Outlet_Pressure = (F32)0.0f;
  
    //! @brief Inlet pressure sensor current value
    F32 f32_Inlet_Pressure_Sensor_Current = (F32)0.0f;
    
    //! @brief Outlet pressure sensor current value
    F32 f32_Outlet_Pressure_Sensor_Current = (F32)0.0f;
    
    //! @brief Inlet pressure range
    F32 f32_Range_Inlet_Pressure = (F32)0.0f;
    
    //! @brief Outlet pressure range
    F32 f32_Range_Outlet_Pressure = (F32)0.0f;
  
    //! @brief Pointer to the memory area in FPGA address space
    volatile TKG3_LCSI_T1_Registers *struct_Registers = (TKG3_LCSI_T1_Registers*)NULL;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------