C# Class Hourglass.Timing.Timer

A countdown timer.

Inheritance: Hourglass.Timing.TimerBase

Show file Open project: Dziemborowicz/Hourglass Class Usage Examples

Public Methods

Method	Description
FromTimerInfo ( Hourglass.Serialization.TimerInfo timerInfo ) : Timer	Returns a Timer for a TimerInfo.
Start ( TimerStart newTimerStart ) : bool	Starts the timer.
Timer ( ) : System	Initializes a new instance of the Timer class.
Timer ( Hourglass.Serialization.TimerInfo timerInfo ) : System	Initializes a new instance of the Timer class.
Timer ( TimerOptions options ) : System	Initializes a new instance of the Timer class.
ToString ( ) : string	Returns a string that represents the current object.
ToTimerInfo ( ) : Hourglass.Serialization.TimerInfo	Returns the representation of the TimerInfo used for XML serialization.

Protected Methods

Method	Description
OnExpired ( ) : void	Invoked before the TimerBase.Expired event is raised
OnPaused ( ) : void	Invoked before the TimerBase.Paused event is raised
OnResumed ( ) : void	Invoked before the TimerBase.Resumed event is raised
OnStarted ( ) : void	Invoked before the TimerBase.Started event is raised
OnStopped ( ) : void	Invoked before the TimerBase.Stopped event is raised
OnTick ( ) : void	Invoked before the TimerBase.Tick event is raised

Private Methods

Method	Description
GetTimeElapsedAsPercentage ( ) : double?	Returns the percentage of time elapsed since the timer was started.
GetTimeElapsedAsString ( ) : string	Returns the string representation of the time elapsed since the timer was started.
GetTimeExpiredAsString ( ) : string	Returns the string representation of the time since the timer expired.
GetTimeLeftAsPercentage ( ) : double?	Returns the percentage of time left until the timer expires.
GetTimeLeftAsString ( ) : string	Returns the string representation of the time left until the timer expires.
Loop ( ) : void	Restarts the timer with the current TimerStart.
UpdateHourglassTimer ( ) : void	Updates the Timer state.

Method Details

FromTimerInfo() public static method

Returns a Timer for a TimerInfo.

public static FromTimerInfo ( Hourglass.Serialization.TimerInfo timerInfo ) : Timer
timerInfo	Hourglass.Serialization.TimerInfo	A .
return	Timer

OnExpired() protected method

Invoked before the TimerBase.Expired event is raised

protected OnExpired ( ) : void
return	void

OnPaused() protected method

Invoked before the TimerBase.Paused event is raised

protected OnPaused ( ) : void
return	void

OnResumed() protected method

Invoked before the TimerBase.Resumed event is raised

protected OnResumed ( ) : void
return	void

OnStarted() protected method

Invoked before the TimerBase.Started event is raised

protected OnStarted ( ) : void
return	void

OnStopped() protected method

Invoked before the TimerBase.Stopped event is raised

protected OnStopped ( ) : void
return	void

OnTick() protected method

Invoked before the TimerBase.Tick event is raised

protected OnTick ( ) : void
return	void

Start() public method

Starts the timer.

If the timer has been disposed.

public Start ( TimerStart newTimerStart ) : bool
newTimerStart	TimerStart	A .
return	bool

Timer() public method

Initializes a new instance of the Timer class.

public Timer ( ) : System
return	System

Timer() public method

Initializes a new instance of the Timer class.

public Timer ( Hourglass.Serialization.TimerInfo timerInfo ) : System
timerInfo	Hourglass.Serialization.TimerInfo	A representing the state of the .
return	System

Timer() public method

Initializes a new instance of the Timer class.

public Timer ( TimerOptions options ) : System
options	TimerOptions	Configuration data for this timer.
return	System

ToString() public method

Returns a string that represents the current object.

public ToString ( ) : string
return	string

ToTimerInfo() public method

Returns the representation of the TimerInfo used for XML serialization.

public ToTimerInfo ( ) : Hourglass.Serialization.TimerInfo
return	Hourglass.Serialization.TimerInfo