C# Class GSF.TimeSeries.FrameQueue

Represents a real-time queue of TrackingFrame instances used by the ConcentratorBase class.

Inheritance: IDisposable

Afficher le fichier Open project: GridProtectionAlliance/gsf Class Usage Examples

Méthodes publiques

Méthode	Description
Clear ( ) : void	Clears the FrameQueue.
Dispose ( ) : void	Releases all the resources used by the FrameQueue object.
ExamineQueueState ( int expectedMeasurements ) : string	Examines and returns the status of the FrameQueue.
GetFrame ( long ticks ) : GSF.TimeSeries.TrackingFrame	Gets TrackingFrame from the queue with the specified timestamp, in ticks. If no frame exists for the specified timestamp, one will be created. Ticks can be any point in time so long time requested is greater than time of last published frame; this queue is used in a real-time scenario with time moving forward. If a frame is requested for an old timestamp, null will be returned. Note that frame returned will be "best-fit" for given timestamp based on FramesPerSecond.
Pop ( ) : void	Removes current Head frame from the FrameQueue after it has been processed and assigns a new Head.

Méthodes protégées

Méthode	Description
Dispose ( bool disposing ) : void	Releases the unmanaged resources used by the FrameQueue object and optionally releases the managed resources.

Private Methods

Méthode	Description
FrameQueue ( CreateNewFrameFunction createNewFrame ) : System	Creates a new FrameQueue.

Method Details

Clear() public méthode

Clears the FrameQueue.

public Clear ( ) : void
Résultat	void

Dispose() public méthode

Releases all the resources used by the FrameQueue object.

public Dispose ( ) : void
Résultat	void

Dispose() protected méthode

Releases the unmanaged resources used by the FrameQueue object and optionally releases the managed resources.

protected Dispose ( bool disposing ) : void
disposing	bool	true to release both managed and unmanaged resources; false to release only unmanaged resources.
Résultat	void

ExamineQueueState() public méthode

Examines and returns the status of the FrameQueue.

public ExamineQueueState ( int expectedMeasurements ) : string
expectedMeasurements	int	Number of expected measurements per frame.
Résultat	string

GetFrame() public méthode

Gets TrackingFrame from the queue with the specified timestamp, in ticks. If no frame exists for the specified timestamp, one will be created.

Ticks can be any point in time so long time requested is greater than time of last published frame; this queue is used in a real-time scenario with time moving forward. If a frame is requested for an old timestamp, null will be returned. Note that frame returned will be "best-fit" for given timestamp based on FramesPerSecond.

public GetFrame ( long ticks ) : GSF.TimeSeries.TrackingFrame
ticks	long	Timestamp, in ticks, for which to get or create .
Résultat	GSF.TimeSeries.TrackingFrame

Pop() public méthode

Removes current Head frame from the FrameQueue after it has been processed and assigns a new Head.

public Pop ( ) : void
Résultat	void