Function_Block_Cabinet_Cooling_System.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Function_Block_Cabinet_Cooling_System.h
//! @URL       $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Blocks/Function_Block_Cabinet_Cooling_System.h $
//! @author    $Author: minch $ (ANVILEX GmbH)
//! @version   $Revision: 2904 $
//! @date      $Date: 2021-12-02 02:39:23 +0500 (Do, 02 Dez 2021) $
//! @brief     Cabinet cooling system class header file.
//! @attention
//!
//! COPYRIGHT(C) 2015-2019 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
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//! @brief Class declaration description
//------------------------------------------------------------------------------
 
  class TFunction_Block_Cabinet_Cooling_System : 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_Cabinet_Cooling_System();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFunction_Block_Cabinet_Cooling_System();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block initialisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    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] TProtocol_Base *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
    //--------------------------------------------------------------------------
  
    TBlock_Input_Connector object_f32_Sample_Time; //!< Function block sample time input parameter
    TBlock_Input_Connector object_f32_Low_Temperature_Warning_Level; //!< Low cabinet temperature warning level input parameter
    TBlock_Input_Connector object_f32_Low_Temperature_Trip_Level; //!< Low cabinet temperature trip level input parameter
    TBlock_Input_Connector object_f32_Low_Temperature_Trip_Delay; //!< Low cabinet temperature trip delay input parameter
    TBlock_Input_Connector object_f32_High_Temperature_Warning_Level; //!< High cabinet temperature warning level input parameter
    TBlock_Input_Connector object_f32_High_Temperature_Trip_Level; //!< High cabinet temperature trip level input parameter
    TBlock_Input_Connector object_f32_High_Temperature_Trip_Delay; //!< High cabinet temperature trip delay input parameter
    TBlock_Input_Connector object_f32_Fan_Trail_Delay; //!< Fan trail delay input parameter
  
    //--------------------------------------------------------------------------
    // Function block input connectors
    //--------------------------------------------------------------------------
  
    TBlock_Input_Connector object_bool_Enable; //!< Enable input connector
    TBlock_Input_Connector object_bool_Emergency_Trip; //!< Emergency trip input connector
    TBlock_Input_Connector object_bool_Fan_Fuse_Status; //!< Fan circuit breaker status input connector
    TBlock_Input_Connector object_bool_Fan_Contactor_Status; //!< Fan contactor status input connector
    TBlock_Input_Connector object_bool_Heater_Fuse_Status; //!< Heater circuit breaker status input connector
    TBlock_Input_Connector object_bool_Heater_Contactor_Status; //!< Heater contactor status input connector
    TBlock_Input_Connector object_f32_Actual_Temperature; //!< Actual cabinet temperature input connector
    TBlock_Input_Connector object_bool_Invalid_Temperature; //!< Invalid temperature value input connector
 
    //--------------------------------------------------------------------------
    // Function block output connectors
    //--------------------------------------------------------------------------
 
    TBlock_Output_Connector object_bool_Error; //!< Error output
    TBlock_Output_Connector object_bool_Fan_Enable; //!< Enable cabinet fan output
    TBlock_Output_Connector object_bool_Heater_Enable; //! Enable cabinet heater output
    TBlock_Output_Connector object_bool_Low_Temperature_Warning; //!< Low cabinet temperature warning output connector
    TBlock_Output_Connector object_bool_Low_Temperature_Alarm; //!< Low cabinet temperature alarm output connector
    TBlock_Output_Connector object_bool_Low_Temperature_Trip; //!< Low cabinet temperature trip output connector
    TBlock_Output_Connector object_bool_High_Temperature_Warning; //!< High cabinet temperature warning output connector
    TBlock_Output_Connector object_bool_High_Temperature_Alarm; //!< High cabinet temperature alarm output connector
    TBlock_Output_Connector object_bool_High_Temperature_Trip; //!< High cabinet temperature trip output connector
    TBlock_Output_Connector object_bool_Temperature_Warning; //!< Low or high temperature warning output connector
    TBlock_Output_Connector object_bool_Temperature_Alarm; //!< Low or high temperature alarm output connector
    TBlock_Output_Connector object_bool_Temperature_Trip; //!< Low or high temperature trip output connector
    TBlock_Output_Connector object_u16_Status; //!< Status output
    
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
  
  private:
    
    typedef union
    {
      U16 u16_Word;
      struct
      {
        U16 bit_Invalid_Temperature:1;
        U16 bit_Low_Temperature_Warning:1;
        U16 bit_Low_Temperature_Alarm:1;
        U16 bit_Low_Temperature_Trip:1;
        U16 bit_High_Temperature_Warning:1;
        U16 bit_High_Temperature_Alarm:1;
        U16 bit_High_Temperature_Trip:1;
        U16 :1;
        U16 :8;
      };
    } TStatus_Word;
 
    U32 u32_Low_Temperature_Trip_Delay; //!< Recalculated value of low temperature trip delay
    U32 u32_High_Temperature_Trip_Delay; //!< Resalculated value of high temperature trip delay
    U32 u32_Fan_Trail_Delay; //!< Recalculated value of fan trail delay 
  
    U32 u32_Low_Temperature_Trip_Delay_Counter; //!< Low temperature trip delay counter
    U32 u32_High_Temperature_Trip_Delay_Counter; //!< High temperature trip delay counter
    U32 u32_Fan_Trail_Delay_Counter; //!< Fan trail delay counter
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------