High_Precision_Timer_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       High_Precision_Timer_Base.h
//! @brief      High precision timer 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/System_Timer_Base.h $
//!             $Revision: 2759 $
//!             $Date: 2021-07-02 21:28:53 +0500 (Fr, 02 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.
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Timer_Base.h"
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief High precision timer base class
class THigh_Precision_Timer_Base : public TTimer_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
/*
    //!-------------------------------------------------------------------------
    //! @brief     Get actual system time in timer counts as U32.
    //! @note      None
    //! @param     None
    //! @return    U32 - Actual time in timer counts as U32.
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
  
    virtual U32 Get_Actual_Time() = 0;
*/
    //!-------------------------------------------------------------------------
    //! @brief     Get actual system time in timer counts as U64.
    //! @note      None
    //! @param     None
    //! @return    U64 - Actual time in timer counts as U64.
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual U64 Get_Actual_Time_U64() = 0;
  
    //!-------------------------------------------------------------------------
    //! @brief     Perform blocked delay given in s.
    //! @note      None
    //! @param     [in] f32_Delay_Value - Blocked delay time in seconds.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Delay( F32 f32_Delay_Value );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get delta time in seconds.
    //! @note      None
    //! @param     [in] u64_Start_Timestamp - Timer start timestamp.
    //! @param     [in] u64_End_Timestamp - Timer end timestamp.
    //! @return    F32 - Time span in seconds.
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    F32 Get_Delta_Time( U64 u64_Start_Timestamp, U64 u64_End_Timestamp );
 
    //!-------------------------------------------------------------------------
    //! @brief     Return statis of the timeout.
    //! @note      This function is not work correctly
    //! @param     [in] u64_Start_Timestamp - Timer start timestamp.
    //! @param     [in] f32_Timeout - Timeout value in seconds.
    //! @return    BOOL - Timeout status
    //! @retval    false - Timeout elapsed
    //! @retval    true - Timeout in progress
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_Timeout( U64 u64_Start_Timestamp, F32 f32_Timeout );
 
    //!-------------------------------------------------------------------------
    //! @brief     High precision timer interrupt method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Interrupt();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
    //! @brief Extended counter
    U32 u32_Extended_Counter = (U32)0;                
 
  private:
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------