Protocol_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Protocol_Base.h
//! @brief      Communication protocol base 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/Protocol_Base.h $
//!             $Revision: 2944 $
//!             $Date: 2022-02-26 10:45:42 +0500 (Sa, 26 Feb 2022) $
//!             $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.
//
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include system files
//------------------------------------------------------------------------------
 
#include "System_Date.h"
#include "Communication_Data_Link.h"
#include "Block_Input_Connector.h"
#include "Block_Output_Connector.h"
#include "Execution_Profile.h"
 
//------------------------------------------------------------------------------
// Protocol base class
//------------------------------------------------------------------------------
 
class TProtocol_Base : public TCommunication_Data_Link
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method
    //! @note      The method create application object.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TProtocol_Base();
  
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TProtocol_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Initialisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Finalisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     Clear communication statistic
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Clear_Communication_Statistic();
 
    //!-------------------------------------------------------------------------
    //! @brief     System task 1ms cyclic execution method
    //! @note      Override this method to implement protocol specific functionality.
    //! @return    None
    //! \par       Override
    //!            Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute_1ms();
 
    //!-------------------------------------------------------------------------
    //! @brief     Background cyclic execution method
    //! @note      Override this method to implement protocol specific functionality.
    //! @return    None
    //! \par       Override
    //!            Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Send information about protocol method
    //! @note      None
    //! @param     [in] *object_Protocol - Pointer to the communication protocol
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Send_Information( TProtocol_Base *object_Protocol ) = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Enter terminal mode method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Enter_Terminal_Mode() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Enter protocol mode method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Enter_Protocol_Mode() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Terminal mode operation status method
    //! @note      None
    //! @return    BOOL - Terminal mode operation status
    //! @retval    false - Communication protocol operates not in terminal mode
    //! @retval    true - Communication protocol operates in terminal mode
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Is_Terminal_Mode() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Protocol mode operation status method
    //! @note      None
    //! @return    BOOL - Protocol mode operation status
    //! @retval    false - Communication protocol operates not in protocol mode
    //! @retval    true - Communication protocol operates in protocol mode
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Is_Protocol_Mode() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Enable parameter mapping method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Enable_Parameter_Mapping();
 
    //!-------------------------------------------------------------------------
    //! @brief     Disable parameter mapping method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Disable_Parameter_Mapping();
 
    //!-------------------------------------------------------------------------
    //! @brief     Enable show system welcome message method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Show_System_Welcome_Message_Enable() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Disable show system welcome message method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Show_System_Welcome_Message_Disable() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Enable system ready message method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Show_System_Ready_Message_Enable() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Disable system ready message method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Show_System_Ready_Message_Disable() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Transmit boot welcome message method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Transmit_Boot_Welcome_Message() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Transmit system ready message method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Transmit_System_Ready_Message() = 0;
/*
    //!-------------------------------------------------------------------------
    //! @brief     Receive character
    //! @note      None
    //! @param     [in] c8_Character - Received character
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Receive_Char( C8 c8_Character ) = 0;
*/
    //!-------------------------------------------------------------------------
    //! @brief     Receive string
    //! @note      None
    //! @param     [in] *c8_String - Pointer to the null terminated string of characters
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Receive_String( C8 *c8_String ) = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Receive string
    //! @note      None
    //! @param     [in] *c8_String - Pointer to the string of characters
    //! @param     [in] *u32_Length - Length of the string
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Receive_String( C8 *c8_String, U32 u32_Length ) = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Receive character
    //! @note      None
    //! @param     [in] c8_Character - Character to transmit
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Transmit_Char( C8 c8_Character );
 
    VOID Transmit_String_Of_Char( C8 c8_Character, U32 u32_Count );
    VOID Transmit_String_Of_Char( C8 c8_Character, U32 u32_Count, U32 u32_End_New_Line_Count );
    VOID Transmit_String( C8 *c8_String );
    VOID Transmit_String( U32 u32_Begin_New_Lines_Count, C8 *c8_String );
    VOID Transmit_String( C8 *c8_String, U32 u32_End_New_Line_Count );
    VOID Transmit_String( U32 u32_Begin_New_Lines_Count, C8 *c8_String, U32 u32_End_New_Line_Count );
 
//    VOID Transmit_String_As_Hex( C8 *c8_String );
 
    VOID Transmit_New_Line(); //!< Transmit new line
    VOID Transmit_New_Line( U32 u32_Count ); //!< Transmit new lines
 
    // Connector value transmition related methods
    VOID Transmit_Connector_Value_As_Boolean( TBlock_Input_Connector *object_Connector );
    VOID Transmit_Connector_Value_As_Boolean( TBlock_Input_Connector *object_Connector, U32 u32_End_New_Line_Count );
    VOID Transmit_Connector_Value_As_Decimal( TBlock_Input_Connector *object_Connector );
    VOID Transmit_Connector_Value_As_Decimal( TBlock_Input_Connector *object_Connector, U32 u32_End_New_Line_Count );
    VOID Transmit_Connector_Value_As_Hex( TBlock_Input_Connector *object_Connector );
    VOID Transmit_Connector_Value_As_Hex( TBlock_Input_Connector *object_Connector, U32 u32_End_New_Line_Count );
    VOID Transmit_Connector_Value_As_Boolean( TBlock_Output_Connector *object_Connector );
    VOID Transmit_Connector_Value_As_Boolean( TBlock_Output_Connector *object_Connector, U32 u32_End_New_Line_Count );
    VOID Transmit_Connector_Value_As_Decimal( TBlock_Output_Connector *object_Connector );
    VOID Transmit_Connector_Value_As_Decimal( TBlock_Output_Connector *object_Connector, U32 u32_End_New_Line_Count );
    VOID Transmit_Connector_Value_As_Hex( TBlock_Output_Connector *object_Connector );
    VOID Transmit_Connector_Value_As_Hex( TBlock_Output_Connector *object_Connector, U32 u32_End_New_Line_Count );
 
//    VOID Transmit_Parameter_As_Hex( TParameter_Pase *object_Parameter );
 
    // Variant transmision related methods
    VOID Transmit_Variant_As_Hex( TConOpSys_Variant *object_Value );
    VOID Transmit_Variant_As_Hex( TConOpSys_Variant *object_Value, U32 u32_End_New_Line_Count );
 
    VOID Transmit_BOOL_Value_As_Decimal( BOOL bool_Value );
    VOID Transmit_BOOL_Value_As_Decimal( BOOL bool_Value, U32 u32_End_New_Line_Count );
    VOID Transmit_BOOL_Value_As_Hex( BOOL bool_Value );
    VOID Transmit_BOOL_Value_As_Hex( BOOL bool_Value, U32 u32_End_New_Line_Count );
 
    VOID Transmit_TRIL_Value_As_Decimal( TRIL tril_Value );
    VOID Transmit_TRIL_Value_As_Decimal( TRIL tril_Value, U32 u32_End_New_Line_Count );
// ANVILEX: To implement
//    VOID Transmit_TRIL_Value_As_Hex( TRIL tril_Value );
//    VOID Transmit_TRIL_Value_As_Hex( TRIL tril_Value, U32 u32_End_New_Line_Count );
 
    VOID Transmit_U8_Value_As_Decimal( U8 u8_Value );
    VOID Transmit_U8_Value_As_Decimal( U8 u8_Value, U32 u32_End_New_Line_Count );
    VOID Transmit_U8_Value_As_Hex( U8 u8_Value );
    VOID Transmit_U8_Value_As_Hex( U8 u8_Value, U32 u32_End_New_Line_Count );
 
    VOID Transmit_U8_Buffer( U8 *u8_Data_Buffer, U32 u32_Length );
 
    VOID Transmit_I8_Value_As_Decimal( I8 i8_Value );
    VOID Transmit_I8_Value_As_Decimal( I8 i8_Value, U32 u32_End_New_Line_Count );
    VOID Transmit_I8_Value_As_Hex( I8 i8_Value );
    VOID Transmit_I8_Value_As_Hex( I8 i8_Value, U32 u32_End_New_Line_Count );
 
    VOID Transmit_U16_Value_As_Decimal( U16 u16_Value );
    VOID Transmit_U16_Value_As_Decimal( U16 u16_Value, U32 u32_End_New_Line_Count );
    VOID Transmit_U16_Value_As_Hex( U16 u16_Value );
    VOID Transmit_U16_Value_As_Hex( U16 u16_Value, U32 u32_End_New_Line_Count );
 
    VOID Transmit_I16_Value_As_Decimal( I16 i16_Value );
    VOID Transmit_I16_Value_As_Decimal( I16 i16_Value, U32 u32_End_New_Line_Count );
    VOID Transmit_I16_Value_As_Hex( I16 i16_Value );
    VOID Transmit_I16_Value_As_Hex( I16 i16_Value, U32 u32_End_New_Line_Count );
 
    VOID Transmit_U32_Value_As_Decimal( U32 u32_Value );
    VOID Transmit_U32_Value_As_Decimal( U32 u32_Value, U32 u32_End_New_Line_Count );
    VOID Transmit_U32_Value_As_Hex( U32 u32_Value );
    VOID Transmit_U32_Value_As_Hex( U32 u32_Value, U32 u32_End_New_Line_Count );
 
    VOID Transmit_I32_Value_As_Decimal( I32 i32_Value );
    VOID Transmit_I32_Value_As_Decimal( I32 i32_Value, U32 u32_End_New_Line_Count );
    VOID Transmit_I32_Value_As_Hex( I32 i32_Value );
    VOID Transmit_I32_Value_As_Hex( I32 i32_Value, U32 u32_End_New_Line_Count );
 
    VOID Transmit_U64_Value_As_Decimal( U64 u64_Value );
    VOID Transmit_U64_Value_As_Decimal( U64 u64_Value, U32 u32_End_New_Line_Count );
    VOID Transmit_U64_Value_As_Hex( U64 u64_Value );
    VOID Transmit_U64_Value_As_Hex( U64 u64_Value, U32 u32_End_New_Line_Count );
 
    VOID Transmit_I64_Value_As_Decimal( I64 i64_Value );
    VOID Transmit_I64_Value_As_Decimal( I64 i64_Value, U32 u32_End_New_Line_Count );
    VOID Transmit_I64_Value_As_Hex( I64 i64_Value );
    VOID Transmit_I64_Value_As_Hex( I64 i64_Value, U32 u32_End_New_Line_Count );
 
    VOID Transmit_F32_Value_As_Decimal( F32 f32_Value );
    VOID Transmit_F32_Value_As_Decimal( F32 f32_Value, U32 u32_End_New_Line_Count );
    VOID Transmit_F32_Value_As_Hex( F32 f32_Value );
    VOID Transmit_F32_Value_As_Hex( F32 f32_Value, U32 u32_End_New_Line_Count );
 
    VOID Transmit_F64_Value_As_Decimal( F64 f64_Value );
    VOID Transmit_F64_Value_As_Decimal( F64 f64_Value, U32 u32_End_New_Line_Count );
    VOID Transmit_F64_Value_As_Hex( F64 f64_Value );
    VOID Transmit_F64_Value_As_Hex( F64 f64_Value, U32 u32_End_New_Line_Count );
 
    VOID Transmit_DateTime_Structure_Value_As_String( TDate_Time::TDate_Time_Structure struct_DateTime_Structure );
    VOID Transmit_DateTime_Structure_Value_As_String( TDate_Time::TDate_Time_Structure struct_DateTime_Structure, U32 u32_End_New_Line_Count );
 
    VOID Transmit_Buffer_As_U8_Dump( U32 u32_Address, U32 u32_Size, U8 *u8_Buffer, BOOL bool_Align );
 
    //!-------------------------------------------------------------------------
    //! @brief     Set node address
    //! @note      None
    //! @param     [in] u8_Address - New node address
    //! @return    BOOL - Status of the method execution
    //! @retval    false - Error occures during method execution
    //! @retval    true - No error detected
    //! \par       Override
    //!            Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Set_Address( U8 u8_Address );
    
    //--------------------------------------------------------------------------
    // Communication statistic related methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Log message event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Log_Bus_Message();
    
    //!-------------------------------------------------------------------------
    //! @brief     Log communication error event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Log_Bus_Communication_Error();
    
    //!-------------------------------------------------------------------------
    //! @brief     Log character overrun error event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Log_Bus_Character_Overrun();
    
    //!-------------------------------------------------------------------------
    //! @brief     Log frame size error event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Log_Bus_Frame_Size_Error();
    
    //!-------------------------------------------------------------------------
    //! @brief     Log CRC error event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Log_Bus_CRC_Error();
    
    //!-------------------------------------------------------------------------
    //! @brief     Log slave exception error event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Log_Slave_Exception_Error();
    
    //!-------------------------------------------------------------------------
    //! @brief     Log slave messege event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Log_Slave_Message();
    
    //!-------------------------------------------------------------------------
    //! @brief     Log slave broadcast messege event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Log_Slave_Broadcast_Message();
    
    //!-------------------------------------------------------------------------
    //! @brief     Log slave unknown request event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Log_Slave_Unknown_Request_Error();
    
    //!-------------------------------------------------------------------------
    //! @brief     Log slave no responce event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Log_Slave_No_Response();
    
    //!-------------------------------------------------------------------------
    //! @brief     Log slave no acknowledge event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Log_Slave_No_Acknowledge();
    
    //!-------------------------------------------------------------------------
    //! @brief     Log slave busy event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Log_Slave_Busy();
    
    //!-------------------------------------------------------------------------
    //! @brief     Log parameter information request event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Log_Parameter_Information_Request();
    
    //!-------------------------------------------------------------------------
    //! @brief     Log parameter information request error event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Log_Parameter_Information_Request_Error();
 
    //!-------------------------------------------------------------------------
    //! @brief     Log parameter read event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Log_Parameter_Read_Request();
 
    //!-------------------------------------------------------------------------
    //! @brief     Log parameter read error event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Log_Parameter_Read_Request_Error();
 
    //!-------------------------------------------------------------------------
    //! @brief     Log parameter write event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Log_Parameter_Write_Request();
 
    //!-------------------------------------------------------------------------
    //! @brief     Log parameter write error event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Log_Parameter_Write_Request_Error();
 
    //!-------------------------------------------------------------------------
    //! @brief     Log system event information request event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Log_Event_Information_Request();
    
    //!-------------------------------------------------------------------------
    //! @brief     Log system event information request error event for statistics purpouses
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    VOID Log_Event_Information_Request_Error();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
    //!-------------------------------------------------------------------------
    //! @brief     Indicate new data for processing arrived
    //! @note      Calling this method indicates that new data arrived and can be processed.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
  
    VOID New_Data_Arrived();
 
    //!-------------------------------------------------------------------------
    //! @brief     Indicate new data processed
    //! @note      Calling this method indicates that new data processed.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
  
    VOID New_Data_Processed();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return new data presentse status
    //! @note      None
    //! @return    BOOL - New data presentse status
    //! @retval    false - No new data present
    //! @retval    true - New data present
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_New_Data_Present();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return new data processed status
    //! @note      None
    //! @return    BOOL - New data processed status
    //! @retval    false - New data not processed
    //! @retval    true - New data processed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_New_Data_Processed();
 
    //--------------------------------------------------------------------------
    // Protected variables
    //--------------------------------------------------------------------------
  
    //! @brief Parameter mapping enable flag
    BOOL bool_Parameter_Mapping_Enable = (BOOL)false;
 
    //! @brief Total communication bus message counter. 
    //! @note MODBUS field: CPT 1
    U32 u32_Bus_Message_Counter = (U32)0;
    
    //! @brief Communication bus error counter.
    //! @note MODBUS field: CPT 2
    U32 u32_Bus_Communication_Error_Counter = (U32)0;
    
    //! @brief Communication bus character overrun error counter.
    //! @note MODBUS field: CPT 8
    U32 u32_Bus_Character_Overrun_Counter = (U32)0;
    
    //! @brief Communication bus CRC error counter.
    U32 u32_Bus_CRC_Error_Counter = (U32)0;
    
    //! @brief Communication bus frame size error counter.
    U32 u32_Bus_Frame_Size_Error_Counter = (U32)0;
    
    //! @brief Slave exception error counter.
    //! @note MODBUS field: CPT 3    
    U32 u32_Slave_Exception_Error_Counter = (U32)0;
    
    //! @brief Total slave message counter.
    //! @note MODBUS field: CPT 4
    U32 u32_Slave_Message_Counter = (U32)0;
    
    //! @brief Slave broadcast message counter.
    U32 u32_Slave_Broadcast_Message_Counter = (U32)0;
    
    //! @brief Slave unknown request counter.
    U32 u32_Slave_Unknown_Request_Counter = (U32)0;
    
    //! @brief Slave no responce counter.
    //! @note MODBUS field: CPT 5
    U32 u32_Slave_No_Response_Counter = (U32)0;
    
    //! @brief Slave no acknowledge counter.
    //! @note MODBUS field: CPT 6
    U32 u32_Slave_No_Acknowledge_Counter = (U32)0;
    
    //! @brief Slave busy counter.
    //! @note MODBUS field: CPT 7
    U32 u32_Slave_Busy_Counter = (U32)0;
 
    //! @brief Parameter information request counter.
    U32 u32_Parameter_Information_Request_Counter = (U32)0;
 
    //! @brief Parameter information request error counter.
    U32 u32_Parameter_Information_Request_Error_Counter = (U32)0;
    
    //! @brief Parameter read request counter.
    U32 u32_Parameter_Read_Request_Counter = (U32)0;
    
    //! @brief Parameter read request error counter.
    U32 u32_Parameter_Read_Request_Error_Counter = (U32)0;
    
    //! @brief Parameter write request counter.
    U32 u32_Parameter_Write_Request_Counter = (U32)0;
    
    //! @brief Parameter write request error counter.
    U32 u32_Parameter_Write_Request_Error_Counter = (U32)0;
    
    //! @brief Event information request counter.
    U32 u32_Event_Information_Request_Counter = (U32)0;
 
    //! @brief Event information request error counter.
    U32 u32_Event_Information_Request_Error_Counter = (U32)0;
 
    //! @brief Execution profile object 
    TExecution_Profile object_Execution_Profile;
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // private variables
    //--------------------------------------------------------------------------
 
    //! @brief New data present flag
    BOOL bool_New_Data_Present = (BOOL)false;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------