Mezzanine::AlarmTimer Class Reference

This is a timer class that increments normally to a specified time. More...

#include <timer.h>

Inheritance diagram for Mezzanine::AlarmTimer:

Collaboration diagram for Mezzanine::AlarmTimer:

Public Member Functions
	AlarmTimer ()
	Class constructor.
virtual	~AlarmTimer ()
	Class destructor.
virtual Timer::TimerType	GetType () const
	Gets the type of timer this is. More...
Public Member Functions inherited from Mezzanine::GoalTimer
	GoalTimer ()
	Class constructor.
virtual	~GoalTimer ()
	Class destructor.
virtual Boolean	GetAutoReset () const
	Gets whether or not this Timer will reset when it reaches it's goal. More...
virtual Whole	GetGoalTime () const
	Gets the Goal time in Microseconds. More...
virtual Whole	GetGoalTimeInMilliseconds () const
	Gets the Goal time in Milliseconds. More...
virtual void	SetAutoReset (const bool AutoReset)
	Sets whether or not this Timer should reset if it reaches it's goal. More...
virtual void	SetGoalTime (const Whole Goal)
	Sets the goal time in Microseconds. More...
virtual void	SetGoalTimeInMilliseconds (const Whole Goal)
	Sets the goal time in Milliseconds. More...
Public Member Functions inherited from Mezzanine::Timer
	Timer ()
	Standard Constructor. More...
virtual	~Timer ()
	Class Destructor.
virtual Whole	GetCurrentTime ()
	Gets the Current time in Microseconds. More...
virtual Whole	GetCurrentTimeInMilliseconds ()
	Gets the Current time in Milliseconds. More...
virtual Whole	GetInitialTime () const
	Gets the Initial time in Microseconds. More...
virtual Whole	GetInitialTimeInMilliseconds () const
	Gets the Initial time in Milliseconds. More...
virtual Boolean	IsStopped ()
	Gets Whether or not this timer is currently running. More...
virtual void	Reset ()
	Sets the current values to their initial values.
virtual void	SetCurrentTime (const Whole Current)
	Sets the current time in Microseconds. More...
virtual void	SetCurrentTimeInMilliseconds (const Whole Current)
	Sets the current time in Milliseconds. The time that resetting sets the timer to. More...
virtual void	SetInitialTime (const Whole Initial)
	Sets the initial time in Microseconds. The time that resetting sets the timer to. More...
virtual void	SetInitialTimeInMilliseconds (const Whole Initial)
	Sets the initial time in Milliseconds. The time that resetting sets the timer to. More...
virtual void	Start ()
	Activates the Timer.
virtual void	Stop ()
	Deactivates the Timer.

Protected Member Functions
virtual Boolean	GoalReached ()
	Checks to see if the goal has been attained as dictated by the type of timer this is. More...
virtual void	Update ()
	Updates all the timings in this timer. More...

Additional Inherited Members
Public Types inherited from Mezzanine::Timer
enum	TimerType { Normal, StopWatch, Alarm }
	The style of timer to be used. More...
Protected Attributes inherited from Mezzanine::GoalTimer
MaxInt	GoalTime
	The time this timer should stop at. More...
Boolean	ResetAtGoal
	Wether or not this timer will reset itself when it reaches it's goal. More...

Detailed Description

This is a timer class that increments normally to a specified time.

Definition at line 203 of file timer.h.

Member Function Documentation

Timer::TimerType Mezzanine::AlarmTimer::GetType ( ) const

virtual

Gets the type of timer this is.

Returns

Returns an enum value representing the type of timer this is.

Reimplemented from Mezzanine::Timer.

Definition at line 220 of file timer.cpp.

Boolean Mezzanine::AlarmTimer::GoalReached ( )

protectedvirtual

Checks to see if the goal has been attained as dictated by the type of timer this is.

Implements Mezzanine::GoalTimer.

Definition at line 214 of file timer.cpp.

void Mezzanine::AlarmTimer::Update ( )

protectedvirtual

Updates all the timings in this timer.

Reimplemented from Mezzanine::Timer.

Definition at line 203 of file timer.cpp.

---

The documentation for this class was generated from the following files:

• /home/sqeaky/Code/Mezzanine/Mezzanine/src/timer.h
• /home/sqeaky/Code/Mezzanine/Mezzanine/src/timer.cpp