Interval_Timer.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Interval_Timer.h
//! @brief      Interval timer 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/Interval_Timer.h $
//!             $Revision: 2076 $
//!             $Date: 2020-09-12 20:30:44 +0500 (Sa, 12 Sep 2020) $
//!             $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 "Defines.h"
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief Interval timer clase
class TInterval_Timer
{
 
  //----------------------------------------------------------------------------
  // Public methods, variables and defines
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TInterval_Timer();
 
    //!-------------------------------------------------------------------------
    //! @brief     Set interval timer value
    //! @note      None
    //! @param     [in] u32_New_Interval - Interval value in timer ticks
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Set_Interval( U32 u32_New_Interval );
 
    //!-------------------------------------------------------------------------
    //! @brief     Enable timer operation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Enable();
 
    //!-------------------------------------------------------------------------
    //! @brief     Disable timer operation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Disable();
 
    //!-------------------------------------------------------------------------
    //! @brief     Execute timer core method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Execute();
 
  //----------------------------------------------------------------------------
  // Protected methods, variables and defines
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // private methods, variables and defines
  //----------------------------------------------------------------------------
 
  private:
 
    //! @brief Timer enabled flag
    TRIL tril_Enabled;
 
    //! @brief Interval value in counts
    U32 u32_Interval;
 
    //! @brief Timer interval counter
    U32 u32_Counter;
 
};
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------