Function_Block_LVRT_FSM.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Function_Block_LVRT_FSM.h
//! @author    ANVILEX GmbH
//! @version   V1.0
//! @date      18.05.2016
//! @brief     LVRT FSM class header file.
//! @attention
//!
//! COPYRIGHT(C) 2016-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
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//! @brief Class declaration description
//------------------------------------------------------------------------------
 
class TFunction_Block_LVRT_FSM : 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_LVRT_FSM();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFunction_Block_LVRT_FSM();
 
    //!-------------------------------------------------------------------------
    //! @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
 
    TBlock_Input_Connector object_f32_LVRT_Enter_Level; //!< Enter LVRT operation voltage level
    TBlock_Input_Connector object_f32_LVRT_Sag_Level; //!< Minimal sag voltage during LVRT operation
    TBlock_Input_Connector object_f32_LVRT_Exit_Level; //!< Exit LVRT operation voltage level
    TBlock_Input_Connector object_f32_LVRT_Asymmetry_Level; //! Phase voltage asymmetry level
    TBlock_Input_Connector object_f32_LVRT_Asymmetry_Detection_Time; //! Asymmetry detection time in seconds
    TBlock_Input_Connector object_f32_LVRT_Sag_Time; //!< Maximal voltage sag time in seconds
    TBlock_Input_Connector object_f32_LVRT_Ramp_Time; //!< Ramp up time after voltage sag in seconds
    TBlock_Input_Connector object_f32_LVRT_Trail_Time; //!< Trail time after voltage sag in seconds
 
    //--------------------------------------------------------------------------
    // Function block input connectors
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_bool_Enable; //!< Enable LVRT Function block operation
    TBlock_Input_Connector object_bool_Reset; //!< Reset LVRT Function block
//    TBlock_Input_Connector object_f32_Grid_Voltage_Magnitude; //!< Actual phase-neutral grid voltage magnitude
    TBlock_Input_Connector object_f32_Grid_Phase_Voltage_L1; //!< Actual phase-neutral grid voltage L1 (r.m.s.)
    TBlock_Input_Connector object_f32_Grid_Phase_Voltage_L2; //!< Actual phase-neutral grid voltage L2 (r.m.s.)
    TBlock_Input_Connector object_f32_Grid_Phase_Voltage_L3; //!< Actual phase-neutral grid voltage L3 (r.m.s.)
    
    //--------------------------------------------------------------------------
    // Function block output connectors
    //--------------------------------------------------------------------------
 
    TBlock_Output_Connector object_bool_Operation; //!< LVRT in operation status output
    TBlock_Output_Connector object_bool_Asymmetry; //!< LVRT with asymmetry status output
    TBlock_Output_Connector object_bool_Trip; //!< LVRT trip request output
    TBlock_Output_Connector object_bool_Error; //!< LVRT error status output
    
  //----------------------------------------------------------------------------
  // Protected methods and variables
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
  // Private methods and variables
  //----------------------------------------------------------------------------
  
  private:
 
    // FSM state definition
    typedef enum
    {
    
      enum_Init, //!< LVRT FSM initialisation state
      enum_Standby, //!< LVRT FSM standby state
      enum_Sag, //!< LVRT FSM processeg voltage sag region state
      enum_Ramp, //!< LVRT FSM processed voltage ramp region state
      enum_Trail, //!< LVRT FSM processed voltage trail region state
      enum_Trip, //!< LVRT FSM trip state
      enum_Error //!< LVRT FSM error state
 
    } TLVRT_FSM_State;
    
    TLVRT_FSM_State enum_FSM_State; //!< FSM state
 
    // Internal variables   
 
    F32 f32_Ramp_Slope; //!< Ramp slope parameter 
    
    U32 u32_Timeout_Counter; //!< Timeout counter
    U32 u32_Ramp_Slope_Counter; //!< Ramp slope counter
    U32 u32_LVRT_Asymmetry_Detection_Counter; //!< Voltage asymmetry detection counter
    
    U32 u32_LVRT_Asymmetry_Detection_Time; //!< Voltage asymmetry detection time, given in task counts
    U32 u32_LVRT_Sag_Time; //!< Maximal voltage sag time, given in task counts
    U32 u32_LVRT_Ramp_Time; //!< Rump up time after voltage sag, given in task counts
    U32 u32_LVRT_Trail_Time; //!< Trail time after LVRT, given in task counts
    
    BOOL bool_Asymmetry_Valid; //!< Voltage asymmetry valid flag
    BOOL bool_Asymmetry; //!< Asymmetry flag
    
    U32 u32_LVRT_Cycle_Counter; //!< Count of detected LVRT cycles
    U32 u32_Symmetrical_LVRT_Cycle_Counter; //!< Count of detected symmetrical LVRT cycles
    U32 u32_Asymmetrical_LVRT_Cycle_Counter; //!< Count of detected asymmetrical LVRT cycles
 
};
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------