Function_Block_OSG_1_Phase_PLL.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Function_Block_OSG_1_Phase_PLL.h
//! @author    ANVILEX GmbH
//! @version   V1.0
//! @date      16.05.2015
//! @brief     OSG 1 phase PLL class header file.
//! @attention
//!
//! COPYRIGHT(C) 2015 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_OSG_1_Phase_PLL
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// 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_OSG_1_Phase_PLL : 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_OSG_1_Phase_PLL();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFunction_Block_OSG_1_Phase_PLL();
 
    //!-------------------------------------------------------------------------
    //! @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_Base_Frequency;   //!< Base frequency in herz
    TBlock_Input_Connector object_f32_Base_Magnitude;   //!< Base magnitude of input signal
  
    TBlock_Input_Connector object_f32_Zetta;            //!< Damping factor : 0.7
    TBlock_Input_Connector object_f32_Delta;            //!< Tolerance band : 0.05 (5%) oder 0.02 (2%)
    TBlock_Input_Connector object_f32_Ts;               //!< Settling time in seconds : 0.03s
  
    TBlock_Input_Connector object_f32_Sample_Time;      //!< Sample time
 
    TBlock_Input_Connector object_f32_Theta_Offset;     //!< Phase offset
 
    //--------------------------------------------------------------------------
    // Function block input connectors
    //--------------------------------------------------------------------------
  
    TBlock_Input_Connector object_f32_Input;            //!< Input signal
 
    //--------------------------------------------------------------------------
    // Function block output connectors
    //--------------------------------------------------------------------------
 
    TBlock_Output_Connector object_f32_Magnitude;         //!< Magnitude of the input signal
    TBlock_Output_Connector object_f32_Frequency;         //!< Frequency of the input signal 
    TBlock_Output_Connector object_f32_Angular_Frequency; //!< Angular frequency of the input signal
    TBlock_Output_Connector object_f32_Theta_360;         //!< Phase of the input signal
    TBlock_Output_Connector object_f32_Theta_180;         //!< Phase of the input signal
    TBlock_Output_Connector object_f32_Sin;               //!< Cosinus
    TBlock_Output_Connector object_f32_Cos;               //!< Sinus
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
    
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Input related parameters
    //--------------------------------------------------------------------------
 
    F32 f32_Angular_Base_Frequency;   //!< Angular base frequency
 
    F32 f32_Input_Z0;   //!< Non delayed input signal
    F32 f32_Input_Z1;   //!< One sample delayed input signal
    F32 f32_Input_Z2;   //!< Two samples delayed input signal
 
    //--------------------------------------------------------------------------
    // OSG related parameters
    //--------------------------------------------------------------------------
 
    F32 f32_OSG_b0;
    F32 f32_OSG_b2;
    
    F32 f32_OSG_a1;
    F32 f32_OSG_a2;
 
    F32 f32_OSG_qb0;
    F32 f32_OSG_qb1;
    F32 f32_OSG_qb2;
 
    F32 f32_OSG_alpha_Z2;
    F32 f32_OSG_alpha_Z1;
    F32 f32_OSG_alpha_Z0;
 
    F32 f32_OSG_beta_Z2;
    F32 f32_OSG_beta_Z1;
    F32 f32_OSG_beta_Z0;
 
    F32 f32_D;
    F32 f32_Q;
 
    //--------------------------------------------------------------------------
    // LPF related parameters
    //--------------------------------------------------------------------------
 
    F32 f32_LPF_Wn;     //!< LPF natural frequency in radian per second
    F32 f32_LPF_Ti;     //!< LPF time constant
    F32 f32_LPF_Kp;     //!< LPF proportional gain
    F32 f32_LPF_Ki;     //!< LPF integral gain
 
    F32 f32_LPF_Temporary_Output;
    F32 f32_LPF_Output; //!< LPF output
 
    //--------------------------------------------------------------------------
    // Angle integrator related parameters
    //--------------------------------------------------------------------------
    
    F32 f32_Theta;      //!< Phase angle
    F32 f32_Sin;        //!< Sinus
    F32 f32_Cos;        //!< Cosinus
 
};
  
//------------------------------------------------------------------------------
// End Of File 
//------------------------------------------------------------------------------