C# Class GSF.TimeSeries.Adapters.FacileActionAdapterBase

Represents the base class for simple, non-time-aligned, action adapters.

This base class acts on incoming measurements, in a non-time-aligned fashion, for general processing. If derived class needs time-aligned data for processing, the ActionAdapterBase class should be used instead. Derived classes are expected call OnNewMeasurements for any new measurements that may get created.

Inheritance: AdapterBase, IActionAdapter

Show file Open project: GridProtectionAlliance/gsf

Private Properties

Property	Type	Description

Public Methods

Method	Description
Initialize ( ) : void	Initializes FacileActionAdapterBase.
QueueMeasurementForProcessing ( IMeasurement measurement ) : void	Queues a single measurement for processing.
QueueMeasurementsForProcessing ( IEnumerable measurements ) : void	Queues a collection of measurements for processing.

Protected Methods

Method	Description
FacileActionAdapterBase ( ) : System	Creates a new instance of the FacileActionAdapterBase class.
OnDiscardingMeasurements ( IEnumerable measurements ) : void	Raises the DiscardingMeasurements event.
OnNewMeasurements ( ICollection measurements ) : void	Raises the NewMeasurements event.
OnUnpublishedSamples ( int seconds ) : void	Raises the UnpublishedSamples event.

Method Details

FacileActionAdapterBase() protected method

Creates a new instance of the FacileActionAdapterBase class.

protected FacileActionAdapterBase ( ) : System
return	System

Initialize() public method

Initializes FacileActionAdapterBase.

public Initialize ( ) : void
return	void

OnDiscardingMeasurements() protected method

Raises the DiscardingMeasurements event.

protected OnDiscardingMeasurements ( IEnumerable measurements ) : void
measurements	IEnumerable	Enumeration of values being discarded.
return	void

OnNewMeasurements() protected method

Raises the NewMeasurements event.

protected OnNewMeasurements ( ICollection measurements ) : void
measurements	ICollection
return	void

OnUnpublishedSamples() protected method

Raises the UnpublishedSamples event.

protected OnUnpublishedSamples ( int seconds ) : void
seconds	int	Total number of unpublished seconds of data.
return	void

QueueMeasurementForProcessing() public method

Queues a single measurement for processing.

public QueueMeasurementForProcessing ( IMeasurement measurement ) : void
measurement	IMeasurement	Measurement to queue for processing.
return	void

QueueMeasurementsForProcessing() public method

Queues a collection of measurements for processing.

public QueueMeasurementsForProcessing ( IEnumerable measurements ) : void
measurements	IEnumerable	Measurements to queue for processing.
return	void