Communication_Data_Link.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Communication_Data_Link.h
//! @brief      Communication data link 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/Communication_Data_Link.h $
//!             $Revision: 2822 $
//!             $Date: 2021-07-26 18:21:27 +0500 (Mo, 26 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.
//
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include system files
//------------------------------------------------------------------------------
 
#include "Defines.h"
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief Communication data link class
//! @details This class implements interlink capability between physical and protocol communication layers.
class TCommunication_Data_Link
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TCommunication_Data_Link();
 
    //!-------------------------------------------------------------------------
    //! @brief     Connect data link method.
    //! @note      None
    //! @param     [in] *object_New_Data_Link - Type of the connection
    //! @return    None
    //! \par       Override
    //!            Not requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Connect_Data_Link( TCommunication_Data_Link* object_New_Data_Link );
 
    //!-------------------------------------------------------------------------
    //! @brief     Disconnect data link method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Disconnect_Data_Link();
 
    //!-------------------------------------------------------------------------
    //! @brief     1 ms cyclic execution method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute_1ms();
 
    //!-------------------------------------------------------------------------
    //! @brief     Background cyclic execution method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
 
//! @todo Anvilex GG: Remove after tests
 
//    //!-------------------------------------------------------------------------
//    //! @brief     Set transmit mode method
//    //! @note      None
//    //! @return    None
//    //! \par       Override
//    //!            Requered
//    //! @attention None
//    //--------------------------------------------------------------------------
 
//    virtual VOID Set_Transmit_Mode();
 
//    //!-------------------------------------------------------------------------
//    //! @brief     Set receive mode method
//    //! @note      None
//    //! @return    None
//    //! \par       Override
//    //!            Requered
//    //! @attention None
//    //--------------------------------------------------------------------------
 
//    virtual VOID Set_Receive_Mode();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
    //!-------------------------------------------------------------------------
    //! @brief     Communication data transmit method
    //! @note      None
    //! @param     [in] u8_Transmit_Value - Value to transmit
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Communication_Data_Transmit( U8 u8_Transmit_Value );
 
    //!-------------------------------------------------------------------------
    //! @brief     Communication data receive method
    //! @note      None
    //! @param     [in] u8_Receive_Value - Received value
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Communication_Data_Receive( U8 u8_Receive_Value );
    
    //!-------------------------------------------------------------------------
    //! @brief     Communication data receive method
    //! @note      None
    //! @param     [in] void_Receive_Data - Pointer to received data block
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Communication_Block_Data_Receive( VOID *void_Receive_Data );
    
    //!-------------------------------------------------------------------------
    //! @brief     Communication data transmit method
    //! @note      None
    //! @param     [in] void_Receive_Data - Pointer to transmit data block
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Communication_Block_Data_Transmit( VOID *void_Receive_Data );
 
    //--------------------------------------------------------------------------
    // Protected variables
    //--------------------------------------------------------------------------
 
    //! @brief Pointer to the data link object
    TCommunication_Data_Link *object_Data_Link = (TCommunication_Data_Link*)NULL;
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------