MODBUS_Request_PDU.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       MODBUS_Request_PDU.h
//! @brief      MODBUS request 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_Request_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 request PDU class
class TMODBUS_Request_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_Request_PDU();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TMODBUS_Request_PDU();
 
    //!-------------------------------------------------------------------------
    //! @brief     Finalise request
    //! @note      This method finalised request by checking CRC of the PDU buffer.
    //! @return    BOOL - Status of operation
    //! @retval    false - Operation failed
    //! @retval    true - Operation successed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     Test for PDU has a valid slave address
    //! @note      None
    //! @param     [in] u8_Slave_Address - Expected slave address
    //! @return    TRIL - Address validation result
    //! @retval    unset - Bad PDU format
    //! @retval    false - Specified and PDU slave adresses are not equal
    //! @retval    true - Specified and PDU slave adresses are equal
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    TRIL Is_Slave_Address_Valid( U8 u8_Slave_Address );
 
    //!-------------------------------------------------------------------------
    //! @brief     Test for broadcast PDU
    //! @note      None
    //! @return    TRIL - Broadcast PDU flag status
    //! @retval    unset - Bad PDU format
    //! @retval    false - Non broadcast PDU
    //! @retval    true - Broadcast PDU
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    TRIL Is_Broadcast();
 
    //!-------------------------------------------------------------------------
    //! @brief     Test for PDU has a valid CRC
    //! @note      None
    //! @return    TRIL - PDU CRC status
    //! @retval    unset - Bad PDU format
    //! @retval    false - CRC of PDU invalid
    //! @retval    true - CRC of PDU valid
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    TRIL Is_CRC_Valid();
 
    //!-------------------------------------------------------------------------
    //! @brief     Fills buffer with test data
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    VOID Test_Data();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
};
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------