PRT_Sensor.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       PRT_Sensor.h
//! @brief      Platinum resistance thermometers class header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Common/PRT_Sensor.h $
//!             $Revision: 2796 $
//!             $Date: 2021-07-12 02:57:34 +0500 (Mo, 12 Jul 2021) $
//!             $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.
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Defines.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class fefinitions
//------------------------------------------------------------------------------
 
//! @brief Platinum resistance thermometers (PRT) class
class TPRT
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public defines
    //--------------------------------------------------------------------------
  
    //! @brief Platin resistance temperature scala
    typedef enum
    {
 
      //! @brief IPTS68 scala
      enum_IPTS_68 = 1,
 
      //! @ ITS90 scale
      enum_ITS_90 = 2
 
    } TPRT_Scala;
 
    //! @brief Platin resistance temperature sensor type
    typedef enum
    {
 
      //! @brief Pt100 based sensor
      enum_Pt100 = 1,
 
      //! @brief Pt200 based sensor
      enum_Pt200 = 2,
 
      //! @brief Pt500 based sensor
      enum_Pt500 = 3,
 
      //! @brief Pt1000 based sensor
      enum_Pt1000 = 4,
 
      //! @brief Pt3000 based sensor
      enum_Pt3000 = 5,
 
      //! @brief Pt6000 based sensor
      enum_Pt6000 = 6,
 
      //! @brief Pt9000 based sensor
      enum_Pt9000 = 7
 
    } TPRT_Type;
 
    //-------------------------------------------------------------------------------
    // Public methods
    //-------------------------------------------------------------------------------
    
    //!------------------------------------------------------------------------------
    //! @brief  The function calculates the electrical resistance for a Platinum Resistance Thermometer (PRT) at given temperature and defined resistance R0 at 0°C for a PRT element.
    //! @note   Only ITS-90 scala implemented
    //! @param  [out] *f32_Resistance Resistance at given temperature.
    //! @param  [in] f32_Temperature Temperature in degree celsius.
    //! @param  [in] enum_PRT_Scala Temperature scala
    //! @param  [in] enum_PRT_Type Type of the platinum resistance termomenter.
    //! @return Converstion status code
    //! @retval true Converstion successed
    //! @retval false Converstion error
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! @dotfile   TPRT__Temperature_To_Resistance.dt
    //------------------------------------------------------------------------------
 
    BOOL Temperature_To_Resistance( F32 *f32_Resistance, F32 f32_Temperature, TPRT_Scala enum_PRT_Scala, TPRT_Type enum_PRT_Type );
 
    //!-------------------------------------------------------------------------
    //! @brief  The function calculates the electrical resistance for a Platinum Resistance Thermometer (PRT) at given temperature and defined resistance R0 at 0°C for a PRT element.
    //! @note   Only ITS-90 scala implemented
    //! @param  [out] *f32_Temperature Temperature in degree celsius.
    //! @param  [in] f32_Resistance Resistance at given temperature.
    //! @param  [in] enum_PRT_Scala Temperature scala
    //! @param  [in] enum_PRT_Type Type of the platinum resistance termomenter.
    //! @return Converstion status code
    //! @retval true Converstion successed
    //! @retval false Conversuin error
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! @dotfile   TPRT__Resistance_To_Temperature.dt
    //--------------------------------------------------------------------------
 
    BOOL Resistance_To_Temperature( F32 *f32_Temperature, F32 f32_Resistance, TPRT_Scala enum_PRT_Scala, TPRT_Type enum_PRT_Type );
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private methods
    //--------------------------------------------------------------------------
  
    //!-------------------------------------------------------------------------
    //! @brief  The function returns base electrical resistance in ohms.
    //! @note   None
    //! @param  [out] *f32_Resistance Resistance at given temperature.
    //! @param  [in] enum_PRT_Type Type of the platinum resistance termomenter.
    //! @return Converstion status code
    //! @retval true Converstion successed
    //! @retval false Conversuin error
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! @dotfile   TPRT__Get_Base_Resistance.dt
    //--------------------------------------------------------------------------
 
    BOOL Get_Base_Resistance( F32 *f32_Resistance, TPRT_Type enum_PRT_Type );
 
    //!-------------------------------------------------------------------------
    //! @brief  The function returns base electrical resistance in ohms.
    //! @note   None
    //! @param  [out] *f32_A Scala coefficient A.
    //! @param  [out] *f32_B Scala coefficient B.
    //! @param  [out] *f32_C Scala coefficient C.
    //! @param  [in] enum_PRT_Scala Temperature scala
    //! @return Converstion status code
    //! @retval true Converstion successed
    //! @retval false Conversuin error
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! @dotfile   TPRT__Get_Scala_Coefficients.dt
    //--------------------------------------------------------------------------
 
    BOOL Get_Scala_Coefficients( F32 *f32_A, F32 *f32_B, F32 *f32_C, TPRT_Scala enum_PRT_Scala );
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------