MODBUS_Request_FIFO.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       MODBUS_Request_FIFO.h
//! @brief      MODBUS request FIFO 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_FIFO.h $
//!             $Revision: 2765 $
//!             $Date: 2021-07-04 04:32:25 +0500 (So, 04 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 MODBUS request FIFO class
class TMODBUS_Request_FIFO
{
 
  //----------------------------------------------------------------------------
  // 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_FIFO();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TMODBUS_Request_FIFO();
 
    //!-------------------------------------------------------------------------
    //! @brief     Returns empty buffer status
    //! @note      None
    //! @return    BOOL - Buffer status
    //! @retval    false - Buffer is not empty
    //! @retval    true - Buffer is empty
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_Empty();
 
    //!-------------------------------------------------------------------------
    //! @brief     Push data into buffer
    //! @note      None
    //! @param     [in] u8_Value - U8 value to push into buffer
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Push( U8 u8_Value );
 
    //!-------------------------------------------------------------------------
    //! @brief     Pop data from buffer
    //! @note      None
    //! @param     [out] *u8_Value - Poped value from the buffer
    //! @param     [out] *f32_Interval - Time interval value
    //! @return    BOOL - Execution status
    //! @retval    false - Buffer is empty, no data poped
    //! @retval    true - Data successfull poped
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Pop( U8 *u8_Value, F32 *f32_Interval );
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    //! @brief Data buffer
    U8 u8_Data[ 16 ] = { (U8)0x00 };
 
    //! @brief Timestamp buffer
    U64 u64_Timestamp[ 16 ] = { (U64)0 };
 
    //! @brief Status code buffer
    BOOL bool_Status[ 16 ] = { (BOOL)false };
 
    //! @brief Push end index
    U32 u32_Push_Index = (U32)0;
 
    //! @brief Pop end index
    U32 u32_Pop_Index = (U32)0;
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //! @brief Last pop operation timestamp
    U64 u64_Last_Pop_Timestamp = (U64)0;
 
    //! @brief Overflow flag
    BOOL bool_Overflow = (BOOL)false;
 
};
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------