PrecisionTimer Class

Represents a high-resolution timer and timestamp class.

Inheritance Hierarchy

SystemObject
GSFPrecisionTimer

Namespace: GSF
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta

Syntax

C++

JavaScript

Copy

public class PrecisionTimer : IDisposable

Public Class PrecisionTimer
	Implements IDisposable

public ref class PrecisionTimer : IDisposable

type PrecisionTimer = 
    class
        interface IDisposable
    end

GSF.PrecisionTimer = function();

Type.createClass(
	'GSF.PrecisionTimer',
	null,
	IDisposable);

View Source

The PrecisionTimer type exposes the following members.

Constructors

	Name	Description
	PrecisionTimer	Initializes a new instance of the PrecisionTimer class.

Top

Properties

	Name	Description
	AutoReset	Gets or sets a value indicating whether the PrecisionTimer should raise the Tick event each time the specified period elapses or only after the first time it elapses.
	Capabilities	Gets the system multimedia timer capabilities.
	EventArgs	Gets EventArgs specified in Start(EventArgs) used to pass into Tick event.
	IsRunning	Gets a value indicating whether the PrecisionTimer is running.
	Period	Gets or sets the time between Tick events, in milliseconds.
	Resolution	Gets or sets the PrecisionTimer resolution, in milliseconds.

Top

Methods

	Name	Description
	ClearMinimumTimerResolution	Clears a previously set minimum timer resolution established using SetMinimumTimerResolution(Int32).
	Dispose	Releases all the resources used by the PrecisionTimer object.
	Dispose(Boolean)	Releases the unmanaged resources used by the PrecisionTimer object and optionally releases the managed resources.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Releases the unmanaged resources before the PrecisionTimer object is reclaimed by GC. (Overrides ObjectFinalize)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	SetMinimumTimerResolution	Requests a minimum resolution for periodic timers such as the PrecisionTimer.
	Start	Starts the PrecisionTimer.
	Start(EventArgs)	Starts the PrecisionTimer with the specified EventArgs.
	Stop	Stops PrecisionTimer.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Events

	Name	Description
	Started	Occurs when the PrecisionTimer has started.
	Stopped	Occurs when the PrecisionTimer has stopped.
	Tick	Occurs when the PrecisionTimer period has elapsed.

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Remarks

For Windows deployments, implementation is based on the Windows multimedia timer. For other deployments, e.g., POSIX, implementation uses a basic timer for compatibility - this should have ~10ms of resolution when used on standard Linux systems.

Reference

GSF Namespace