Function_Block_ABB_SACE_FSM.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Function_Block_ABB_SACE_FSM.h
//! @author    ANVILEX GmbH
//! @version   V1.0
//! @date      16.05.2015
//! @brief     ABB SACE circuit braker FSM 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.
//------------------------------------------------------------------------------
//
// TFunction_Block_ABB_SACE_FSM_T1
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// 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
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//! @brief Global FSM class declaration description
//------------------------------------------------------------------------------
 
class TFunction_Block_ABB_SACE_FSM_T1 : 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_ABB_SACE_FSM_T1();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFunction_Block_ABB_SACE_FSM_T1();
 
    //!-------------------------------------------------------------------------
    //! @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 parameters
    //--------------------------------------------------------------------------
  
    //!< Circuit breaker spring charge timeout in seconds
    TBlock_Input_Connector object_f32_Spring_Charge_Timeout; 
    
    //!< Circuit breaker spring charge end timeout in seconds
    TBlock_Input_Connector object_f32_Spring_Charge_End_Delay; 
    
    //!< Enable timeout in seconds
    TBlock_Input_Connector object_f32_Enable_Timeout; 
    
    //!< Circuit breaker close timeout in seconds
    TBlock_Input_Connector object_f32_Close_Timeout; 
    
    //!< Circuit breaker release timeout in seconds
    TBlock_Input_Connector object_f32_Release_Timeout; 
    
    //!< Circuit breaker trip timeout in seconds
    TBlock_Input_Connector object_f32_Emergency_Trip_Timeout; 
    
    //!< Circuit breaker reset timeout in seconds
    TBlock_Input_Connector object_f32_Reset_Timeout; 
    
    //!< Function block sample time in seconds.
    TBlock_Input_Connector object_f32_Sample_Time; 
 
    //--------------------------------------------------------------------------
    // Function block inputs
    //--------------------------------------------------------------------------
    
    //!< Enable circuit breaker spring charge input
    TBlock_Input_Connector object_bool_Charge; 
    
    //!< Curcuit breaker close/release control input
    TBlock_Input_Connector object_bool_Enable; 
    
    //!< Circuit breaker reset input
    TBlock_Input_Connector object_bool_Reset; 
 
    //--------------------------------------------------------------------------
    // Function block hardware interface to circuit breaker inputs
    //--------------------------------------------------------------------------
    
    //!< Circuit breaker racked in position feedback status input
    TBlock_Input_Connector object_bool_CB_Racked_In_Position; 
    
    //!< Circuit breaker racked out position feedback status input
    TBlock_Input_Connector object_bool_CB_Racked_Out_Position; 
    
    //!< Circuit breaker isolated position feedback status input
    TBlock_Input_Connector object_bool_CB_Isolation_Position; 
    
    //!< Circuit breaker overcurrent trip status input
    TBlock_Input_Connector object_bool_CB_Overcurrent_Trip; 
    
    //!< Circuit breaker ready to close status input
    TBlock_Input_Connector object_bool_CB_Ready_To_Close;  
    
    //!< Circuit breaker spring charged status input
    TBlock_Input_Connector object_bool_CB_Spring_Charged; 
    
    //!< Circuit breaker auxiliary contact status input
    TBlock_Input_Connector object_bool_CB_Aux_Contact; 
    
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------
    
    //!< Circuit breaker FSM block ready status output
    TBlock_Output_Connector object_bool_Ready; 
    
    //!< Circuit breaker spring charged status output
    TBlock_Output_Connector object_bool_Spring_Charged; 
    
    //!< Circuit breaker closed status output
    TBlock_Output_Connector object_bool_Closed; 
    
    //!< Circuit breaker released status output
    TBlock_Output_Connector object_bool_Released; 
    
    //!< Circuit breaker FSM block error status output
    TBlock_Output_Connector object_bool_Error; 
 
    //--------------------------------------------------------------------------
    // Function block hardware interface to circuit breaker outputs
    //--------------------------------------------------------------------------
 
    //!< Circuit breaker reset request output
    TBlock_Output_Connector object_bool_CB_Reset; 
    
    //!< Circuit breaker close request output
    TBlock_Output_Connector object_bool_CB_Close; 
    
    //! Circuit breaker release request output
    TBlock_Output_Connector object_bool_CB_Release; 
    
    //!< Circuit breaker spring charge enable output
    TBlock_Output_Connector object_bool_CB_Spring_Charge; 
    
    //! Circuit breaker enable output
    TBlock_Output_Connector object_bool_CB_Enable; 
    
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
  
  private:
  
    // FSM states
    typedef enum
    {
    
      enum_Init,
      enum_Opened,
      enum_Spring_Charging,
      enum_Spring_Charged_End_Delay,
      enum_Spring_Charged,
      enum_Enabling,
      enum_Closing,
      enum_Closed,
      enum_Releaseing,
      enum_Error,
      enum_Reset,
      enum_Emergency_Trip
      
    } TGlobal_FSM_State;
    
    //!< FSM state variable
    TGlobal_FSM_State enum_FSM_State; 
  
    //!< Spring charge timeout in execution cycles
    U32 u32_Spring_Charge_Timeout; 
    
    //!< Spring charge end delay in execution cycles
    U32 u32_Spring_Charge_End_Delay; 
    
    //!< Enable timeout in execution cycles
    U32 u32_Enable_Timeout; 
    
    //!< Close timeout in execution cycles
    U32 u32_Close_Timeout;
    
    //! Release timeout in execution cycles
    U32 u32_Release_Timeout;
    
    //!< Emergency trip timeout in execution cycles
    U32 u32_Emergency_Trip_Timeout;
    
    //!< Reset timeout in execution cycles
    U32 u32_Reset_Timeout;
    
    //!< Internal action start timestamp
    U32 u32_Start_Timestamp;  
    
    //!< Circuit breaker spring charge time
    U32 u32_Circuit_Breaker_Spring_Charge_Time; 
    
    //!< Circuit breaker close time
    U32 u32_Circuit_Breaker_Close_Time; 
    
    //!< Circuit breaker release time
    U32 u32_Circuit_Breaker_Release_Time; 
    
    //!< Internal delay counter
    U32 u32_Delay_Counter; 
    
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------