Function_Block_Temperature_Monitor.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Function_Block_Temperature_Monitor.h
//! @URL       $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Blocks/Function_Block_Temperature_Monitor.h $
//! @author    $Author: minch $ (ANVILEX GmbH)
//! @version   $Revision: 2904 $
//! @date      $Date: 2021-12-02 02:39:23 +0500 (Do, 02 Dez 2021) $
//! @brief     Temperature monitor class header file.
//! @attention
//!
//! COPYRIGHT(C) 2015 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 ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief Temperature monitor class
class TFunction_Block_Temperature_Monitor : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
  
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TFunction_Block_Temperature_Monitor();
    
    //!-------------------------------------------------------------------------
    //! @brief     Function block class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFunction_Block_Temperature_Monitor();
 
    //!-------------------------------------------------------------------------
    //! @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 Function block over communication link protocol
    //! @note      This method sends information about Function block 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 parameter connectors
    //--------------------------------------------------------------------------
    
    //! @brief Function block sample time input parameter
    TBlock_Input_Connector object_f32_Sample_Time; 
    
    //! @brief Low temperature warning level input parameter
    TBlock_Input_Connector object_f32_Low_Temperature_Warning_Level; 
    
    //! @brief Low temperature trip level input parameter
    TBlock_Input_Connector object_f32_Low_Temperature_Trip_Level; 
    
    //! @brief Low temperature trip delay input parameter
    TBlock_Input_Connector object_f32_Low_Temperature_Trip_Delay; 
    
    //! @brief High temperature warning level input parameter
    TBlock_Input_Connector object_f32_High_Temperature_Warning_Level; 
    
    //! @brief High temperature trip level input parameter
    TBlock_Input_Connector object_f32_High_Temperature_Trip_Level; 
    
    //! @brief High temperature trip delay input parameter
    TBlock_Input_Connector object_f32_High_Temperature_Trip_Delay; 
 
    //--------------------------------------------------------------------------
    // Function block input connectors
    //--------------------------------------------------------------------------
 
    //! @brief Actual ambient temperature input connector
    TBlock_Input_Connector object_f32_Actual_Temperature; 
    
    //! @brief Invalid temperature status flag
    TBlock_Input_Connector object_bool_Invalid_Temperature; 
 
    //--------------------------------------------------------------------------
    // Function block output connectors
    //--------------------------------------------------------------------------
 
// ANVILEX KM: Not used now.
//    //! @brief Enable fan
//  TBlock_Output_Connector object_bool_Fan_Enable; 
 
    //! @brief Low temperature warning output connector
    TBlock_Output_Connector object_bool_Low_Temperature_Warning;
 
    //! @brief Low temperature alarm output connector
    TBlock_Output_Connector object_bool_Low_Temperature_Alarm; 
    
    //! @brief Low temperature trip output connector
    TBlock_Output_Connector object_bool_Low_Temperature_Trip; 
    
    //! @brief High temperature warning output connector
    TBlock_Output_Connector object_bool_High_Temperature_Warning;
 
    //! @brief High temperature alarm output connector
    TBlock_Output_Connector object_bool_High_Temperature_Alarm; 
    
    //! @brief High temperature trip output connector
    TBlock_Output_Connector object_bool_High_Temperature_Trip; 
    
    //! @brief Low or high temperature warning output connector
    TBlock_Output_Connector object_bool_Temperature_Warning; 
    
    //! @brief Low or high temperature alarm output connector
    TBlock_Output_Connector object_bool_Temperature_Alarm; 
    
    //! @brief Low or high temperature trip output connector
    TBlock_Output_Connector object_bool_Temperature_Trip; 
    
    //! @brief Status output connector
    TBlock_Output_Connector object_u16_Status;
  
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
    
    //--------------------------------------------------------------------------
    // Private defines
    //--------------------------------------------------------------------------
    
    //! @brief Status word register structure
    typedef union
    {
      
      //! @brief Status word register raw data
      U16 u16_Word;
      
      //! @brief Status word register as bit structure
      struct
      {
        
        //! @brief Bit 0 : Invalid temperature
        U16 bit_Invalid_Temperature:1; 
        
        //! @brief Bit 1 : Low temperature warning
        U16 bit_Low_Temperature_Warning:1;
 
        //! @brief Bit 2 : Low temperature alarm
        U16 bit_Low_Temperature_Alarm:1; 
        
        //! @brief Bit 3 : Low temperature trip
        U16 bit_Low_Temperature_Trip:1; 
        
        //! @brief Bit 4 : High temperature warning
        U16 bit_High_Temperature_Warning:1;
 
        //! @brief Bit 5 : High temperature alarm
        U16 bit_High_Temperature_Alarm:1; 
        
        //! @brief Bit 6 : High temperature trip
        U16 bit_High_Temperature_Trip:1; 
        
        //!< Bits 7-15 : Not used bits
        U16 :9; 
      
      };
      
    } TStatus_Word;
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
    
    //! @brief Low temperature trip delay
    U32 u32_Low_Temperature_Trip_Delay = (U32)0; 
    
    //! @brief High temperature trip delay
    U32 u32_High_Temperature_Trip_Delay = (U32)0; 
  
    //! @brief Low temperature trip delay counter
    U32 u32_Low_Temperature_Trip_Delay_Counter = (U32)0; 
    
    //! @brief High temperature trip delay counter
    U32 u32_High_Temperature_Trip_Delay_Counter = (U32)0;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------