Function_Block_Environment.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Function_Block_Environment.h
//! @URL       $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Blocks/Function_Block_Environment.h $
//! @author    $Author: minch $ (ANVILEX GmbH)
//! @version   $Revision: 2904 $
//! @date      $Date: 2021-12-02 02:39:23 +0500 (Do, 02 Dez 2021) $
//! @brief     Environment class header file.
//! @attention
//!
//! COPYRIGHT(C) 2015-2018 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_Environment : 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_Environment(); 
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFunction_Block_Environment();
 
    //!-------------------------------------------------------------------------
    //! @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();
 
    //--------------------------------------------------------------------------
    // Function block parameter connectors
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_f32_Sample_Time; //!< Function block sample parameter
    TBlock_Input_Connector object_f32_Low_Temperature_Warning_Level; //!< Low ambient temperature warning level parameter
    TBlock_Input_Connector object_f32_Low_Temperature_Trip_Level; //!< Low ambient temperature trip level parameter
    TBlock_Input_Connector object_f32_Low_Temperature_Trip_Delay; //!< Low ambient temperature trip delay parameter
    TBlock_Input_Connector object_f32_High_Temperature_Warning_Level; //!< High ambient temperature warning level parameter
    TBlock_Input_Connector object_f32_High_Temperature_Trip_Level; //!< High ambient temperature trip level parameter
    TBlock_Input_Connector object_f32_High_Temperature_Trip_Delay; //!< High ambient temperature trip delay parameter
 
    //--------------------------------------------------------------------------
    // Function block input connectors
    //--------------------------------------------------------------------------
  
    TBlock_Input_Connector object_f32_Actual_Temperature; //!< Actual ambient temperature input connector
    TBlock_Input_Connector object_bool_Invalid_Temperature; //!< Invalid temperature flag input connector
 
    //--------------------------------------------------------------------------
    // Function block output connectors
    //--------------------------------------------------------------------------
    
    TBlock_Output_Connector object_bool_Low_Temperature_Warning; //!< Low ambient temperature warning output connector
    TBlock_Output_Connector object_bool_Low_Temperature_Alarm; //!< Low ambient temperature alarm output connector
    TBlock_Output_Connector object_bool_Low_Temperature_Trip; //!< Low ambient temperature trip output connector
    TBlock_Output_Connector object_bool_High_Temperature_Warning; //!< High ambient temperature warning output connector
    TBlock_Output_Connector object_bool_High_Temperature_Alarm; //!< High ambient temperature alarm output connector
    TBlock_Output_Connector object_bool_High_Temperature_Trip; //!< High ambient temperature trip output connector
    TBlock_Output_Connector object_bool_Temperature_Warning; //!< Ambient temperature warning output connector
    TBlock_Output_Connector object_bool_Temperature_Alarm; //!< Ambient temperature alarm output connector
    TBlock_Output_Connector object_bool_Temperature_Trip; //!< Ambient temperature trip output connector
 
    TBlock_Output_Connector object_u16_Status; // !< Status word
 
  //----------------------------------------------------------------------------
  // Protected methods and variables
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
  // private methods and variables
  //----------------------------------------------------------------------------
  
  private:
 
    typedef union
    {
      U16 u16_Word;
      struct
      {
        U16 bit_Invalid_Temperature:1; //<! Bit 0 : Invalid temperature
        U16 bit_Low_Temperature_Warning:1; //<! Bit 1 : Low temperature warning
        U16 bit_Low_Temperature_Alarm:1; //<! Bit 2 : Low temperature alarm
        U16 bit_Low_Temperature_Trip:1; //<! Bit 3 : Low temperature trip
        U16 bit_High_Temperature_Warning:1; //<! Bit 4 : High temperature warning
        U16 bit_High_Temperature_Alarm:1; //<! Bit 5 : High temperature alarm
        U16 bit_High_Temperature_Trip:1; //<! Bit 6 : High temperature trip
        U16 :9; //!< Bits 7-15 : Not used
      };
    } TStatus_Word;
    
    U32 u32_Low_Temperature_Trip_Delay; //!< Low temperature trip delay 
    U32 u32_High_Temperature_Trip_Delay; //!< High temperature trip delay   
 
    U32 u32_Low_Temperature_Trip_Delay_Counter; //!< Time delay counter
    U32 u32_High_Temperature_Trip_Delay_Counter; //!< Time delay counter
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------