MODBUS_Response_PDU.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       MODBUS_Response_PDU.h
//! @brief      MODBUS response PDU 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/MODBUS_Response_PDU.h $
//!             $Revision: 2732 $
//!             $Date: 2021-06-22 11:38:01 +0500 (Di, 22 Jun 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 "MODBUS_PDU.h"
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief MODBUS responce PDU class
class TMODBUS_Response_PDU : public TMODBUS_PDU_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TMODBUS_Response_PDU();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TMODBUS_Response_PDU();
 
    //!-------------------------------------------------------------------------
    //! @brief     Initialisation PDU with specified slave address abd function code
    //! @note      None
    //! @param     [in] u8_Slave_Address - Slave address
    //! @param     [in] u8_Function_Code - Function code
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Init( U8 u8_Slave_Address, U8 u8_Function_Code );
 
    //!-------------------------------------------------------------------------
    //! @brief     Initialisation PDU with specified slave address abd function code
    //! @note      None
    //! @param     [in] u8_Slave_Address - Slave address
    //! @param     [in] u8_Function_Code - Function code
    //! @param     [in] u8_Response_Code - Response code
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Init( U8 u8_Slave_Address, U8 u8_Function_Code, U8 u8_Response_Code );
 
    //!-------------------------------------------------------------------------
    //! @brief     Finalise responce composition
    //! @note      This method finalised responce composition by adding CRC to the PDU buffer.
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Done();
    
    //!-------------------------------------------------------------------------
    //! @brief     Write U8 value into responce PDU buffer at specified address
    //! @note      None
    //! @param     [in] u32_Address - PDU buffer address
    //! @param     [in] u8_Value - U8 value to write
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Write_U8_Value( U32 u32_Address, U8 u8_Value );
 
    //!-------------------------------------------------------------------------
    //! @brief     Write U16 value into responce PDU buffer at specified address
    //! @note      None
    //! @param     [in] u32_Address - PDU buffer address
    //! @param     [in] u16_Value - U16 value to write
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Write_U16_Value( U32 u32_Address, U16 u16_Value );
 
    //!-------------------------------------------------------------------------
    //! @brief     Write U32 value into responce PDU buffer at specified address
    //! @note      None
    //! @param     [in] u32_Address - PDU buffer address
    //! @param     [in] u32_Value - U32 value to write
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Write_U32_Value( U32 u32_Address, U32 u32_Value );
 
    //!-------------------------------------------------------------------------
    //! @brief     Write F32 value into responce PDU buffer at specified address
    //! @note      None
    //! @param     [in] u32_Address - PDU buffer address
    //! @param     [in] f32_Value - F32 value to write
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Write_F32_Value( U32 u32_Address, F32 f32_Value );
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------