Signal_Recorder.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Signal_Recorder.h
//! @brief      Signal recorder class header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Engine/Signal_Recorder/Signal_Recorder.h $
//!             $Revision: 2794 $
//!             $Date: 2021-07-11 04:06:01 +0500 (So, 11 Jul 2021) $
//!             $Author: minch $
//------------------------------------------------------------------------------
//
// 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 "Scope_Defines.h"
#include "Parameter_Base.h"
#include "ConOpSys_Variant.h"
#include "Block_Output_Connector.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Trigger mask
// ANVILEX: Change to TConOpSys_Variant
//------------------------------------------------------------------------------
/*
  // ANVILEX: Reserved for the functionality expansion
typedef union
{
 
  unsigned char Unsigned_8_Bit;         // Unsigned byte value of the object
  char Signed_8_Bit;                    // Byte value of the object
  unsigned int Unsigned_16_Bit;         // Unsigned integer value of the object
  int Signed_16_Bit;                    // Integer value of the object
  unsigned long Unsigned_32_Bit;        // Unsigned long integer value of the object
  long Signed_32_Bit;                   // Long integer value of the object
  unsigned long long Unsigned_64_Bit;   // Unsigned 64 bit integer value of the object
  long long Signed_64_Bit;              // 64 bit integer value of the object
 
} TSignal_Recorder_Trigger_Bit_Pattern_Mask;
*/
//------------------------------------------------------------------------------
// Sample data storage
// ANVILEX: Change to TConOpSys_Variant
//------------------------------------------------------------------------------
 
typedef struct
{
 
  union
  {
    
    BOOL bool_Value;      // Boolean value of the object
    U8 u8_Value;          // Unsigned byte value of the object
    C8 i8_Value;          // Byte value of the object
    U16 u16_Value;        // Unsigned integer value of the object
    I16 i16_Value;        // Integer value of the object
    U32 u32_Value;        // Unsigned long integer value of the object
    I32 i32_Value;        // Long integer value of the object
    U64 u64_Value;        // Unsigned 64 bit integer value of the object
    I64 i64_Value;        // 64 bit integer value of the object
    F32 f32_Value;        // Float value of the object
    F64 f64_Value;        // Double value of the object
 
    #if ( PARAMETER_DATATYPE_F80_SUPPORT == (true) )
 
    F80 f80_Value;        // Long double value of the object
 
    #endif
 
    // Raw data buffer
//    U8 u8_Buffer[ 10 ];
    U8 u8_Buffer[ CONOPSYS_VARIANT_DATA_SIZE ];
 
  } Data;
 
} TSignal_Recorder_Data_Line;
 
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief Signal recorder class
class TSignal_Recorder
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TSignal_Recorder();
    
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TSignal_Recorder();
 
    // General methods
    VOID Execute(); //!< Data processing method
    VOID Set_Sample_Time( F32 f32_New_Sample_Time ); //!< Set new sample time
    BOOL Is_Armed(); //!< Trigger armed status
    VOID Force(); //!< Force trigger method
 
    // Trigger related methods
    VOID Set_Trigger_State( TSignal_Recorder_Trigger_State enum_New_Trigger_State );
    VOID Get_Trigger_State( TSignal_Recorder_Trigger_State *enum_Actual_Trigger_State );
 
    BOOL Set_Trigger_Position( U32 u32_New_Trigger_Position );
    VOID Get_Trigger_Position( U32 *u32_Actual_Trigger_Position );
 
    BOOL Set_Trigger_Source( TParameter_Base *struct_Parameter );
    BOOL Set_Trigger_Source( TBlock_Output_Connector *object_Connector );
    BOOL Get_Trigger_Source( TParameter_Base **struct_Parameter );
 
    VOID Set_Trigger_Mode( TSignal_Recorder_Trigger_Mode enum_New_Trigger_Mode );
    VOID Get_Trigger_Mode( TSignal_Recorder_Trigger_Mode *enum_Actual_Trigger_Mode );
 
// Reserved for functionality expansion
//    VOID Set_Trigger_Bit_Pattern_Mask( TSignal_Recorder_Trigger_Bit_Pattern_Mask struct_New_Trigger_Bit_Pattern_Mask );
//    VOID Get_Trigger_Bit_Pattern_Mask( TSignal_Recorder_Trigger_Bit_Pattern_Mask *struct_Actual_Trigger_Bit_Pattern_Mask );
 
    // Data related methods
    U32 Get_Data_Channel_Count(); //!< Get scope channel count
    U32 Get_Data_Element_Per_Channel_Count();
    U32 Get_Data_Element_Size();
 
    BOOL Set_VDC_Channel_Index( U32 u32_VDC_Channel_Index );
    BOOL Get_VDC_Channel_Index( U32 *u32_VDC_Channel_Index );
    BOOL Set_VDC_Channel_Data_Index( U32 u32_VDC_Channel_Data_Index );
    BOOL Get_VDC_Channel_Data_Index( U32 *u32_VDC_Channel_Data_Index );
 
    BOOL Set_Channel_Data_Decimation( U32 u32_Channel_Data_Decimation );
    BOOL Get_Channel_Data_Decimation( U32 *u32_Channel_Data_Decimation );
 
    BOOL Get_Channel_Data_Timebase( F32 *f32_Channel_Data_Timebase );
 
    // Set data channel source methods
//    BOOL Set_Data_Channel_Source( TParameter_Base &object_Parameter );
    BOOL Set_Data_Channel_Source( TParameter_Base *object_Parameter );
//    BOOL Set_Data_Channel_Source( U32 u32_Data_Channel_Index, TParameter_Base &object_Parameter );
    BOOL Set_Data_Channel_Source( U32 u32_Data_Channel_Index, TParameter_Base *object_Parameter );
 
    // Second level methods, obsolete
//    BOOL Set_Data_Channel_Source( U32 u32_Data_Channel_Index, BOOL *bool_Variable );
//    BOOL Set_Data_Channel_Source( U32 u32_Data_Channel_Index, U8 *u8_Variable );
//    BOOL Set_Data_Channel_Source( U32 u32_Data_Channel_Index, I8 *i8_Variable );
//    BOOL Set_Data_Channel_Source( U32 u32_Data_Channel_Index, U16 *u16_Variable );
//    BOOL Set_Data_Channel_Source( U32 u32_Data_Channel_Index, I16 *i16_Variable );
//    BOOL Set_Data_Channel_Source( U32 u32_Data_Channel_Index, U32 *u32_Variable );
//    BOOL Set_Data_Channel_Source( U32 u32_Data_Channel_Index, I32 *i32_Variable );
//    BOOL Set_Data_Channel_Source( U32 u32_Data_Channel_Index, U64 *u64_Variable );
//    BOOL Set_Data_Channel_Source( U32 u32_Data_Channel_Index, I64 *i64_Variable );
//    BOOL Set_Data_Channel_Source( U32 u32_Data_Channel_Index, F32 *f32_Variable );
//    BOOL Set_Data_Channel_Source( U32 u32_Data_Channel_Index, F64 *f64_Variable );
//    BOOL Set_Data_Channel_Source( U32 u32_Data_Channel_Index, F80 *f80_Variable );
 
    // ANVILEX: Reserved for functionality expansion
//    BOOL Set_Data_Channel_Source( U32 u32_Data_Channel_Index, TBlock_Output_Connector *object_Connector );
 
    // Get data channel source methods
    BOOL Get_Data_Channel_Source( TParameter_Base **object_Parameter );
    BOOL Get_Data_Channel_Source( U32 u32_Data_Channel_Index, TParameter_Base **object_Parameter );
 
    // Get data element
    BOOL Get_Data_Channel_Element( TSignal_Recorder_Data_Line **struct_Data_Line );
    BOOL Get_Data_Channel_Element( U32 u32_Data_Channel_Index, U32 u32_Data_Channel_Element_Index, TSignal_Recorder_Data_Line **struct_Data_Line );
    
    //!-------------------------------------------------------------------------
    //! @brief     This method return OS status
    //! @note      None
    //! @return    U32 - OS status 
    //! \par       Override
    //!            Required
    //! @attention None
    //--------------------------------------------------------------------------
    
    U32 Get_OS_Status();
    
    //!-------------------------------------------------------------------------
    //! @brief     This method set module in operation mode
    //! @note      None
    //! @return    BOOL - Module status 
    //! @retval    false - Module in error mode
    //! @retval    true - Module ready to operations
    //! \par       Override
    //!            Required
    //! @attention None
    //--------------------------------------------------------------------------
    
    BOOL Start_Operation();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    // Channel data source parameter
    TParameter_Base *object_Data_Channel_Parameter[ SCOPE_CHANNEL_COUNT ];
 
    // Channel data source variable
    TConOpSys_Variant_Data object_Data_Channel_Variable[ SCOPE_CHANNEL_COUNT ];
 
    // Channel data storage
    TSignal_Recorder_Data_Line struct_Data_Channel[ SCOPE_CHANNEL_COUNT ][ SCOPE_CHANNEL_BUFFER_SIZE ];
 
    // Trigger level data parameter
    TParameter_Base *object_Trigger_Level_Data_Parameter;
 
    // Trigger related variables
//    TSignal_Recorder_Trigger_Bit_Pattern_Mask struct_Trigger_Bit_Pattern_Mask; //!< Reserved for the functionality expansion
 
    TSignal_Recorder_Trigger_State enum_Trigger_State;
    U32 u32_Trigger_Position;
    U32 u32_Trigger_Pretrigger_Count;
    TParameter_Base *object_Trigger_Parameter;
    TSignal_Recorder_Trigger_Mode enum_Trigger_Mode;
 
    // Data related parameters
    U32 u32_Data_Channel_Count;
    U32 u32_Data_Elements_Per_Channel_Count;
 
    U32 u32_Current_Buffer_Index;
    U32 u32_Start_Buffer_Index;
 
    U32 u32_Data_Decimation; //!< Time decimation factor
    U32 u32_Data_Decimation_Counter; //!< Time decimation factor counter
 
    F32 f32_Sample_Time; //!< Basic sample time
 
    U32 u32_VDC_Channel_Index; //!< VDC channel index
    U32 u32_VDC_Channel_Data_Index; //!< VDC channel element index
 
    U32 u32_Temp_Index;
 
    //--------------------------------------------------------------------------
    // General trigger methods
    //--------------------------------------------------------------------------
 
    VOID (TSignal_Recorder::*method_Process_Trigger)(); //!< Process trigger callback method pointer
 
    // Trigger related methods
    VOID Process_Dummy_Trigger();
 
    VOID Process_Match_BOOL_Trigger();
    VOID Process_Match_PBOOL_Trigger();
    VOID Process_Match_U8_Trigger();
    VOID Process_Match_PU8_Trigger();
    VOID Process_Match_I8_Trigger();
    VOID Process_Match_PI8_Trigger();
    VOID Process_Match_U16_Trigger();
    VOID Process_Match_PU16_Trigger();
    VOID Process_Match_I16_Trigger();
    VOID Process_Match_PI16_Trigger();
    VOID Process_Match_U32_Trigger();
    VOID Process_Match_PU32_Trigger();
    VOID Process_Match_I32_Trigger();
    VOID Process_Match_PI32_Trigger();
    VOID Process_Match_U64_Trigger();
    VOID Process_Match_PU64_Trigger();
    VOID Process_Match_I64_Trigger();
    VOID Process_Match_PI64_Trigger();
    VOID Process_Match_F32_Trigger();
    VOID Process_Match_PF32_Trigger();
    VOID Process_Match_F64_Trigger();
    VOID Process_Match_PF64_Trigger();
 
    #if ( PARAMETER_DATATYPE_F80_SUPPORT == (true) )
 
    VOID Process_Match_F80_Trigger();
 
    #endif
 
    #if ( PARAMETER_DATATYPE_F80_SUPPORT == (true) )
 
    VOID Process_Match_PF80_Trigger();
 
    #endif
 
    VOID Process_Rising_Edge_BOOL_Trigger();
    VOID Process_Rising_Edge_PBOOL_Trigger();
    VOID Process_Rising_Edge_U8_Trigger();
    VOID Process_Rising_Edge_PU8_Trigger();
    VOID Process_Rising_Edge_I8_Trigger();
    VOID Process_Rising_Edge_PI8_Trigger();
    VOID Process_Rising_Edge_U16_Trigger();
    VOID Process_Rising_Edge_PU16_Trigger();
    VOID Process_Rising_Edge_I16_Trigger();
    VOID Process_Rising_Edge_PI16_Trigger();
    VOID Process_Rising_Edge_U32_Trigger();
    VOID Process_Rising_Edge_PU32_Trigger();
    VOID Process_Rising_Edge_I32_Trigger();
    VOID Process_Rising_Edge_PI32_Trigger();
    VOID Process_Rising_Edge_U64_Trigger();
    VOID Process_Rising_Edge_PU64_Trigger();
    VOID Process_Rising_Edge_I64_Trigger();
    VOID Process_Rising_Edge_PI64_Trigger();
    VOID Process_Rising_Edge_F32_Trigger();
    VOID Process_Rising_Edge_PF32_Trigger();
    VOID Process_Rising_Edge_F64_Trigger();
    VOID Process_Rising_Edge_PF64_Trigger();
 
    #if ( PARAMETER_DATATYPE_F80_SUPPORT == (true) )
 
    VOID Process_Rising_Edge_F80_Trigger();
 
    #endif
 
    #if ( PARAMETER_DATATYPE_F80_SUPPORT == (true) )
 
    VOID Process_Rising_Edge_PF80_Trigger();
 
    #endif
 
    VOID Process_Falling_Edge_BOOL_Trigger();
    VOID Process_Falling_Edge_PBOOL_Trigger();
    VOID Process_Falling_Edge_U8_Trigger();
    VOID Process_Falling_Edge_PU8_Trigger();
    VOID Process_Falling_Edge_I8_Trigger();
    VOID Process_Falling_Edge_PI8_Trigger();
    VOID Process_Falling_Edge_U16_Trigger();
    VOID Process_Falling_Edge_PU16_Trigger();
    VOID Process_Falling_Edge_I16_Trigger();
    VOID Process_Falling_Edge_PI16_Trigger();
    VOID Process_Falling_Edge_U32_Trigger();
    VOID Process_Falling_Edge_PU32_Trigger();
    VOID Process_Falling_Edge_I32_Trigger();
    VOID Process_Falling_Edge_PI32_Trigger();
    VOID Process_Falling_Edge_U64_Trigger();
    VOID Process_Falling_Edge_PU64_Trigger();
    VOID Process_Falling_Edge_I64_Trigger();
    VOID Process_Falling_Edge_PI64_Trigger();
    VOID Process_Falling_Edge_F32_Trigger();
    VOID Process_Falling_Edge_PF32_Trigger();
    VOID Process_Falling_Edge_F64_Trigger();
    VOID Process_Falling_Edge_PF64_Trigger();
 
    #if ( PARAMETER_DATATYPE_F80_SUPPORT == (true) )
 
    VOID Process_Falling_Edge_F80_Trigger();
 
    #endif
 
    #if ( PARAMETER_DATATYPE_F80_SUPPORT == (true) )
 
    VOID Process_Falling_Edge_PF80_Trigger();
 
    #endif
 
// ANVILEX : Reserved for functionality expansion
//    VOID Process_Edge_BOOL_Trigger();
//    VOID Process_Edge_PBOOL_Trigger();
//    VOID Process_Edge_U8_Trigger();
//    VOID Process_Edge_PU8_Trigger();
//    VOID Process_Edge_I8_Trigger();
//    VOID Process_Edge_PI8_Trigger();
//    VOID Process_Edge_U16_Trigger();
//    VOID Process_Edge_PU16_Trigger();
//    VOID Process_Edge_I16_Trigger();
//    VOID Process_Edge_PI16_Trigger();
//    VOID Process_Edge_U32_Trigger();
//    VOID Process_Edge_PU32_Trigger();
//    VOID Process_Edge_I32_Trigger();
//    VOID Process_Edge_PI32_Trigger();
//    VOID Process_Edge_U64_Trigger();
//    VOID Process_Edge_PU64_Trigger();
//    VOID Process_Edge_I64_Trigger();
//    VOID Process_Edge_PI64_Trigger();
//    VOID Process_Edge_F32_Trigger();
//    VOID Process_Edge_PF32_Trigger();
//    VOID Process_Edge_F64_Trigger();
//    VOID Process_Edge_PF64_Trigger();
//    VOID Process_Edge_F80_Trigger();
//    VOID Process_Edge_PF80_Trigger();
 
//    VOID Process_Change_BOOL_Trigger();
//    VOID Process_Change_PBOOL_Trigger();
//    VOID Process_Change_U8_Trigger();
//    VOID Process_Change_PU8_Trigger();
//    VOID Process_Change_I8_Trigger();
//    VOID Process_Change_PI8_Trigger();
//    VOID Process_Change_U16_Trigger();
//    VOID Process_Change_PU16_Trigger();
//    VOID Process_Change_I16_Trigger();
//    VOID Process_Change_PI16_Trigger();
//    VOID Process_Change_U32_Trigger();
//    VOID Process_Change_PU32_Trigger();
//    VOID Process_Change_I32_Trigger();
//    VOID Process_Change_PI32_Trigger();
//    VOID Process_Change_U64_Trigger();
//    VOID Process_Change_PU64_Trigger();
//    VOID Process_Change_I64_Trigger();
//    VOID Process_Change_PI64_Trigger();
//    VOID Process_Change_F32_Trigger();
//    VOID Process_Change_PF32_Trigger();
//    VOID Process_Change_F64_Trigger();
//    VOID Process_Change_PF64_Trigger();
//    VOID Process_Change_F80_Trigger();
//    VOID Process_Change_PF80_Trigger();
 
    //--------------------------------------------------------------------------
    // Realtime data copy related methods
    //--------------------------------------------------------------------------
 
    // Data copy related methods
    VOID (TSignal_Recorder::*Set_Data_Channel_Element[ 2 * SCOPE_CHANNEL_COUNT ])( U32 u32_Data_Channel_Index );
 
    // Copy parameter value methods
    VOID Set_Data_Channel_Element_Dummy( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_BOOL( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_PBOOL( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_U8( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_PU8( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_I8( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_PI8( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_U16( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_PU16( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_I16( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_PI16( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_U32( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_PU32( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_I32( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_PI32( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_U64( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_PU64( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_I64( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_PI64( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_F32( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_PF32( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_F64( U32 u32_Data_Channel_Index );
    VOID Set_Data_Channel_Element_PF64( U32 u32_Data_Channel_Index );
 
    #if ( PARAMETER_DATATYPE_F80_SUPPORT == (true) )
 
    VOID Set_Data_Channel_Element_F80( U32 u32_Data_Channel_Index );
 
    #endif
 
    #if ( PARAMETER_DATATYPE_F80_SUPPORT == (true) )
 
    VOID Set_Data_Channel_Element_PF80( U32 u32_Data_Channel_Index );
 
    #endif
    
    //! @brief Container for OS status
    TOS_Status_Structure struct_OS_Status;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------