C# Class GSF.TimeSeries.PrecisionInputTimer

Precision input timer.

This class is used to create highly accurate simulated data inputs aligned to the local clock.
One static instance of this internal class is created per encountered frame rate.

Inheritance: IDisposable

Mostrar archivo Open project: GridProtectionAlliance/gsf Class Usage Examples

Public Methods

Method	Description
AddReference ( ) : void	Adds a reference to this PrecisionInputTimer.
Attach ( int framesPerSecond, Action exceptionHandler = null ) : PrecisionInputTimer	Attach to a PrecisionInputTimer for the specified framesPerSecond.
Detach ( PrecisionInputTimer &timer ) : void	Detach from the PrecisionInputTimer. Timer reference will be set to `null` after detach.
Dispose ( ) : void	Releases all the resources used by the PrecisionInputTimer object.
RemoveReference ( ) : void	Removes a reference to this PrecisionInputTimer.

Private Methods

Method	Description
Dispose ( bool disposing ) : void	Releases the unmanaged resources used by the PrecisionInputTimer object and optionally releases the managed resources.
PrecisionInputTimer ( int framesPerSecond ) : System	Create a new PrecisionInputTimer class.
SynchronizeInputTimer ( object state ) : void
m_timer_Tick ( object sender, EventArgs e ) : void

Method Details

AddReference() public method

Adds a reference to this PrecisionInputTimer.

public AddReference ( ) : void
return	void

Attach() public static method

Attach to a PrecisionInputTimer for the specified framesPerSecond.

public static Attach ( int framesPerSecond, Action exceptionHandler = null ) : PrecisionInputTimer
framesPerSecond	int	Desired frames per second for the input timer.
exceptionHandler	Action	Optional delegate to handle exception reporting from the timer.
return	PrecisionInputTimer

Detach() public static method

Detach from the PrecisionInputTimer.

Timer reference will be set to null after detach.

public static Detach ( PrecisionInputTimer &timer ) : void
timer	PrecisionInputTimer	Timer instance to detach from.
return	void

Dispose() public method

Releases all the resources used by the PrecisionInputTimer object.

public Dispose ( ) : void
return	void

RemoveReference() public method

Removes a reference to this PrecisionInputTimer.

public RemoveReference ( ) : void
return	void