Function_Block_RMS_Moving_Average_Filter.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Function_Block_RMS_Moving_Average_Filter.h
//! @brief     Root mean squere moving average filter class header file.
//! @copyright ANVILEX GmbH
//! @attention No special attention requered.
//!            $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Blocks/Function_Block_RMS_Moving_Average_Filter.h $
//!            $Revision: 2912 $
//!            $Date: 2021-12-17 10:36:24 +0500 (Fr, 17 Dez 2021) $
//!            $Author: minch $
//
//! COPYRIGHT(C) 2018-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.
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// 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 declaration description
//------------------------------------------------------------------------------
/*
class TFunction_Block_RMS_Moving_Average_Filter_128 : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TFunction_Block_RMS_Moving_Average_Filter_128();
    
    ~TFunction_Block_RMS_Moving_Average_Filter_128(); //!< Destructor method
 
    //!-------------------------------------------------------------------------
    //! @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_Averaging_Time; //!< Averaging time
    TBlock_Input_Connector object_f32_Sample_Time;  //!< Sample time parameter
          
    //--------------------------------------------------------------------------
    // Function block input connectors
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_f32_Input; //!< Input signal
 
    //--------------------------------------------------------------------------
    // Function block output connectors
    //--------------------------------------------------------------------------
 
    TBlock_Output_Connector object_f32_Output; //!< Moving average block output
    
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
 
  private:
 
    U32 u32_Averaging_Buffer_Size;
    F32 f32_1_Div_Averaging_Buffer_Size;
    U32 u32_Buffer_Index;
    F32 f32_Buffer[ 128 ];
 
};
*/
//------------------------------------------------------------------------------
/*
class TFunction_Block_RMS_Moving_Average_Filter_256 : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TFunction_Block_RMS_Moving_Average_Filter_256();
 
    ~TFunction_Block_RMS_Moving_Average_Filter_256(); //!< Destructor method
 
    //!-------------------------------------------------------------------------
    //! @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_Averaging_Time; //!< Averaging time
    TBlock_Input_Connector object_f32_Sample_Time;  //!< Sample time parameter
          
    //--------------------------------------------------------------------------
    // Function block input connectors
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_f32_Input; //!< Input signal
 
    //--------------------------------------------------------------------------
    // Function block output connectors
    //--------------------------------------------------------------------------
 
    TBlock_Output_Connector object_f32_Output; //!< Moving average block output
    
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
 
  private:
 
    U32 u32_Averaging_Buffer_Size;
    F32 f32_1_Div_Averaging_Buffer_Size;
    U32 u32_Buffer_Index;
    F32 f32_Buffer[ 256 ];
 
};
*/
//------------------------------------------------------------------------------
//! @brief Class declaration description
//------------------------------------------------------------------------------
/*
class TFunction_Block_RMS_Moving_Average_Filter_128_FAST : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TFunction_Block_RMS_Moving_Average_Filter_128_FAST();
 
    ~TFunction_Block_RMS_Moving_Average_Filter_128_FAST(); //!< Destructor method
 
    //!-------------------------------------------------------------------------
    //! @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_Averaging_Time; //!< Averaging time
    TBlock_Input_Connector object_f32_Sample_Time; //!< Sample time parameter
          
    //--------------------------------------------------------------------------
    // Function block input connectors
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_f32_Input; //!< Input signal
 
    //--------------------------------------------------------------------------
    // Function block output connectors
    //--------------------------------------------------------------------------
 
    TBlock_Output_Connector object_f32_Output; //!< Moving average block output
    
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
 
  private:
 
    U32 u32_Averaging_Buffer_Size;
    F32 f32_1_Div_Averaging_Buffer_Size;
    U32 u32_Buffer_Index;
    F32 f32_Buffer[ 128 ];
    F32 f32_Sector[ 8 ];
 
};
*/
//------------------------------------------------------------------------------
// Class declaration description
//------------------------------------------------------------------------------
/*
class TFunction_Block_RMS_Moving_Average_Filter_128_2 : 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_RMS_Moving_Average_Filter_128_2();
 
    ~TFunction_Block_RMS_Moving_Average_Filter_128_2(); //!< Destructor methods
 
    //!-------------------------------------------------------------------------
    //! @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_Averaging_Time; //!< Averaging time
    TBlock_Input_Connector object_f32_Sample_Time;  //!< Sample time parameter
          
    //--------------------------------------------------------------------------
    // Function block input connectors
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_f32_Input_1; //!< Input signal
    TBlock_Input_Connector object_f32_Input_2; //!< Input signal
 
    //--------------------------------------------------------------------------
    // Function block output connectors
    //--------------------------------------------------------------------------
 
    TBlock_Output_Connector object_f32_Output_1; //!< Moving average block output
    TBlock_Output_Connector object_f32_Output_2; //!< Moving average block output
    
  //----------------------------------------------------------------------------
  // Protected methods and variables
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
  // Private methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    U32 u32_Averaging_Buffer_Size;
    F32 f32_1_Div_Averaging_Buffer_Size;
    U32 u32_Buffer_Index;
    F32 f32_Buffer_1[ 128 ];
    F32 f32_Buffer_2[ 128 ];
 
};
*/
//------------------------------------------------------------------------------
//! @brief 128 points, 3 channel, root mean squere (RMS) moving average filter class
//------------------------------------------------------------------------------
 
class TFunction_Block_RMS_Moving_Average_Filter_128_3C : 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_RMS_Moving_Average_Filter_128_3C();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFunction_Block_RMS_Moving_Average_Filter_128_3C();
 
    //!-------------------------------------------------------------------------
    //! @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 in seconds
    TBlock_Input_Connector object_f32_Sample_Time; 
    
    //! @brief Averaging time in seconds
    TBlock_Input_Connector object_f32_Averaging_Time;
              
    //--------------------------------------------------------------------------
    // Function block input connectors
    //--------------------------------------------------------------------------
 
    //! @brief Moving avarage filter input signal of channel 1
    TBlock_Input_Connector object_f32_Input_1;
    
    //! @brief Moving avarage filter input signal of channel 2
    TBlock_Input_Connector object_f32_Input_2; 
    
    //! @brief Moving avarage filter input signal of channel 3
    TBlock_Input_Connector object_f32_Input_3; 
 
    //--------------------------------------------------------------------------
    // Function block output connectors
    //--------------------------------------------------------------------------
 
    //! @brief Moving average filter block output of channel 1
    TBlock_Output_Connector object_f32_Output_1; 
    
    //! @brief Moving average filter block output of channel 2
    TBlock_Output_Connector object_f32_Output_2; 
    
    //! @brief Moving average filter block output of channel 3
    TBlock_Output_Connector object_f32_Output_3; 
    
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief Sampling ratio
    F32 f32_Sampling_Ratio = (F32)1.0f;
  
    //! @brief Requered averaging buffer size in samples
    U32 u32_Averaging_Buffer_Size = (U32)1;
 
    //! @brief Inversed value of requered averaging buffer size 
    F32 f32_1_Div_Averaging_Buffer_Size = (F32)1.0f;
    U32 u32_Buffer_Index = (U32)0;
  
    //! @brief Data buffer of the channel 1
    F32 f32_Buffer_1[ 128 ] = { (F32)0.0f }; 
  
    //! @brief Data buffer of the channel 2
    F32 f32_Buffer_2[ 128 ] = { (F32)0.0f }; 
  
    //! @brief Data buffer of the channel 3
    F32 f32_Buffer_3[ 128 ] = { (F32)0.0f }; 
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------