Function_Block_Sinus_Filter_Synchroniser.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Function_Block_Sinus_Filter_Synchroniser.h
//! @author    ANVILEX GmbH
//! @version   V1.0
//! @date      28.12.2017
//! @brief     Sinus filter synchroniser class header file.
//! @attention
//!
//! COPYRIGHT(C) 2017-2021 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
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class declarations
//------------------------------------------------------------------------------
 
//! @brief Three phase sinus filter synchroniser class
class TFunction_Block_Sinus_Filter_Synchroniser : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
  
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TFunction_Block_Sinus_Filter_Synchroniser();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFunction_Block_Sinus_Filter_Synchroniser();
 
    //!-------------------------------------------------------------------------
    //! @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 );
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block parameter connectors
    //--------------------------------------------------------------------------
 
    //! @brief Function block sample time parameter
    TBlock_Input_Connector object_f32_Sample_Time; 
 
    //! @brief Voltage ramp time parameter
    TBlock_Input_Connector object_f32_Voltage_Ramp_Time; 
  
    //--------------------------------------------------------------------------
    // Function block input connectors
    //--------------------------------------------------------------------------
 
    //! @brief Block enable input signal
    TBlock_Input_Connector object_bool_Enable; 
    
    //! @brief Filter on grid state status input
    TBlock_Input_Connector object_bool_On_Grid; 
    
    //! @brief Reference voltage axis D
    TBlock_Input_Connector object_f32_Reference_Voltage_D; 
    
    //! @brief Reference voltage axis Q
    TBlock_Input_Connector object_f32_Reference_Voltage_Q; 
 
//    //! @brief Input voltage signal
//    TBlock_Input_Connector object_f32_Input_Voltage_D;
 
//    //! @brief Input voltage signal
//    TBlock_Input_Connector object_f32_Input_Voltage_Q; 
 
    //--------------------------------------------------------------------------
    // Function block output connectors
    //--------------------------------------------------------------------------
 
    //! @brief Filter output voltage signal, component D
    TBlock_Output_Connector object_f32_Output_Voltage_D; 
    
    //! @brief Filter output voltage signal, component D
    TBlock_Output_Connector object_f32_Output_Voltage_Q;
    
    //! @brief Synchronisation voltage ramp done
    TBlock_Output_Connector object_bool_Done; 
 
  //----------------------------------------------------------------------------
  // Protected methods and variables
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
  // Private methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private defines
    //--------------------------------------------------------------------------
 
    // FSM state definition
    typedef enum
    {
    
      //! @brief Idle state
      enum_Idle, 
      
      //! @brief Filter voltage ramp state
      enum_Ramp, 
      
      //! @brief Filter synchronisation done state
      enum_Synchronisation_Done, 
      
      //! @brief Filter on grid state
      enum_On_Grid 
      
    } TFSM_State;
    
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief FSM state
    TFSM_State enum_FSM_State = TFSM_State::enum_Idle; 
    
    //! @brief Ramp time in execution cycles 
    U32 u32_Ramp_Time = (U32)0;
    
    //! @brief Time delay counter
    U32 u32_Delay_Counter = (U32)0;
    
    //! @brief Integrator, D component
    F32 f32_Integrator_D = (F32)0.0f;
    
    //! @brief Integrator, Q component
    F32 f32_Integrator_Q = (F32)0.0f;
 
};
 
//------------------------------------------------------------------------------
// Export references to the objects
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Export references to the functions
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------