C# Class GSF.TimeSeries.Adapters.IaonSession

Represents a new Input, Action, Output interface session.

Inheritance: IProvideStatus, IDisposable

Mostrar archivo Open project: GridProtectionAlliance/gsf Class Usage Examples

Public Methods

Method	Description
ConfigurationChangedHandler ( object sender, EventArgs e ) : void	Event handler for adapter notifications about configuration changes.
Dispose ( ) : void	Releases all the resources used by the IaonSession object.
DisposedHandler ( object sender, EventArgs e ) : void	Event handler for disposed events from all adapters.
GetDerivedName ( object sender ) : string	Gets derived name of specified object.
IaonSession ( ) : System	Creates a new IaonSession.
Initialize ( bool autoStart = true ) : void	Initialize and start adapters.
InputMeasurementKeysUpdatedHandler ( object sender, EventArgs e ) : void	Event handler for updates to adapter input measurement key definitions.
OutputMeasurementsUpdatedHandler ( object sender, EventArgs e ) : void	Event handler for updates to adapter output measurement definitions.
ProcessExceptionHandler ( object sender, EventArgs e ) : void	Event handler for processing reported exceptions.
ProcessingCompleteHandler ( object sender, EventArgs e ) : void	Event handler for processing complete notifications from input adapters.
RecalculateRoutingTables ( ) : void	Recalculates routing tables as long as all adapters have been initialized.
RequestTemporalSupportHandler ( object sender, EventArgs e ) : void	Event handler for requesting temporal support. Action adapter collections use this handler to make sure temporal support is initialized before setting up temporal sessions.
StatusMessageHandler ( object sender, EventArgs e ) : void	Event handler for reporting status messages.
TemporalProcessingSupportExists ( string collection = null ) : bool	Gets flag that determines if temporal processing is supported in this IaonSession.
UnprocessedMeasurementsHandler ( object sender, EventArgs e ) : void	Event handler for monitoring unprocessed measurements. Time-series framework uses this handler to monitor the number of unprocessed measurements in output adapters. This method is typically called once every five seconds.
UnpublishedSamplesHandler ( object sender, EventArgs e ) : void	Event handler for monitoring unpublished samples. Time-series framework uses this handler to monitor the number of unpublished samples, in seconds of data, in action adapters. This method is typically called once every five seconds.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Releases the unmanaged resources used by the IaonSession object and optionally releases the managed resources.
OnConfigurationChanged ( object sender ) : void	Raises ConfigurationChanged event.
OnDisposed ( object sender ) : void	Raises the Disposed event.
OnInputMeasurementKeysUpdated ( object sender ) : void	Raises InputMeasurementKeysUpdated event.
OnOutputMeasurementsUpdated ( object sender ) : void	Raises OutputMeasurementsUpdated event.
OnProcessException ( object sender, Exception ex ) : void	Raises ProcessException event.
OnProcessingComplete ( object sender, EventArgs e = null ) : void	Raises the ProcessingComplete event.
OnStatusMessage ( object sender, string status, UpdateType type = UpdateType.Information ) : void	Raises the StatusMessage event.
OnUnprocessedMeasurements ( object sender, int unprocessedMeasurements ) : void	Raises the UnprocessedMeasurements event.
OnUnpublishedSamples ( object sender, int seconds ) : void	Raises the UnpublishedSamples event.

Private Methods

Method	Description
ExtractTemporalConfiguration ( DataSet realtimeConfiguration ) : DataSet
m_routingTables_ProcessException ( object sender, EventArgs e ) : void
m_routingTables_StatusMessage ( object sender, EventArgs e ) : void

Method Details

ConfigurationChangedHandler() public method

Event handler for adapter notifications about configuration changes.

public ConfigurationChangedHandler ( object sender, EventArgs e ) : void
sender	object	Sending object.
e	System.EventArgs	Event arguments, if any.
return	void

Dispose() public method

Releases all the resources used by the IaonSession object.

public Dispose ( ) : void
return	void

Dispose() protected method

Releases the unmanaged resources used by the IaonSession 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.
return	void

DisposedHandler() public method

Event handler for disposed events from all adapters.

public DisposedHandler ( object sender, EventArgs e ) : void
sender	object	Sending object.
e	System.EventArgs	Event arguments, if any.
return	void

GetDerivedName() public method

Gets derived name of specified object.

public GetDerivedName ( object sender ) : string
sender	object	Sending object from which to derive name.
return	string

IaonSession() public method

Creates a new IaonSession.

public IaonSession ( ) : System
return	System

Initialize() public method

Initialize and start adapters.

public Initialize ( bool autoStart = true ) : void
autoStart	bool	Sets flag that determines if adapters should be automatically started.
return	void

InputMeasurementKeysUpdatedHandler() public method

Event handler for updates to adapter input measurement key definitions.

public InputMeasurementKeysUpdatedHandler ( object sender, EventArgs e ) : void
sender	object	Sending object.
e	System.EventArgs	Event arguments, if any.
return	void

OnConfigurationChanged() protected method

Raises ConfigurationChanged event.

protected OnConfigurationChanged ( object sender ) : void
sender	object	Object source raising the event.
return	void

OnDisposed() protected method

Raises the Disposed event.

protected OnDisposed ( object sender ) : void
sender	object	Object source raising the event.
return	void

OnInputMeasurementKeysUpdated() protected method

Raises InputMeasurementKeysUpdated event.

protected OnInputMeasurementKeysUpdated ( object sender ) : void
sender	object	Object source raising the event.
return	void

OnOutputMeasurementsUpdated() protected method

Raises OutputMeasurementsUpdated event.

protected OnOutputMeasurementsUpdated ( object sender ) : void
sender	object	Object source raising the event.
return	void

OnProcessException() protected method

Raises ProcessException event.

protected OnProcessException ( object sender, Exception ex ) : void
sender	object	Object source raising the event.
ex	System.Exception	Processing .
return	void

OnProcessingComplete() protected method

Raises the ProcessingComplete event.

protected OnProcessingComplete ( object sender, EventArgs e = null ) : void
sender	object	Object source raising the event.
e	System.EventArgs	, if any.
return	void

OnStatusMessage() protected method

Raises the StatusMessage event.

protected OnStatusMessage ( object sender, string status, UpdateType type = UpdateType.Information ) : void
sender	object	Object source raising the event.
status	string	New status message.
type	UpdateType	of status message.
return	void

OnUnprocessedMeasurements() protected method

Raises the UnprocessedMeasurements event.

protected OnUnprocessedMeasurements ( object sender, int unprocessedMeasurements ) : void
sender	object	Object source raising the event.
unprocessedMeasurements	int	Total measurements in the queue that have not been processed.
return	void

OnUnpublishedSamples() protected method

Raises the UnpublishedSamples event.

protected OnUnpublishedSamples ( object sender, int seconds ) : void
sender	object	Object source raising the event.
seconds	int	Total number of unpublished seconds of data.
return	void

OutputMeasurementsUpdatedHandler() public method

Event handler for updates to adapter output measurement definitions.

public OutputMeasurementsUpdatedHandler ( object sender, EventArgs e ) : void
sender	object	Sending object.
e	System.EventArgs	Event arguments, if any.
return	void

ProcessExceptionHandler() public method

Event handler for processing reported exceptions.

public ProcessExceptionHandler ( object sender, EventArgs e ) : void
sender	object	Event source of the exception.
e	EventArgs	Event arguments containing the exception to report.
return	void

ProcessingCompleteHandler() public method

Event handler for processing complete notifications from input adapters.

public ProcessingCompleteHandler ( object sender, EventArgs e ) : void
sender	object	Event source reference to input adapter that is reporting processing completion.
e	System.EventArgs	Event arguments for event, if any; otherwise .
return	void

RecalculateRoutingTables() public method

Recalculates routing tables as long as all adapters have been initialized.

public RecalculateRoutingTables ( ) : void
return	void

RequestTemporalSupportHandler() public method

Event handler for requesting temporal support.

Action adapter collections use this handler to make sure temporal support is initialized before setting up temporal sessions.

public RequestTemporalSupportHandler ( object sender, EventArgs e ) : void
sender	object	Event source reference to adapter collection, typically an action adapter collection, that is requesting temporal support.
e	System.EventArgs	Event arguments are not used.
return	void

StatusMessageHandler() public method

Event handler for reporting status messages.

public StatusMessageHandler ( object sender, EventArgs e ) : void
sender	object	Event source of the status message.
e	EventArgs	Event arguments containing the status message to report.
return	void

TemporalProcessingSupportExists() public method

Gets flag that determines if temporal processing is supported in this IaonSession.

public TemporalProcessingSupportExists ( string collection = null ) : bool
collection	string	Name of collection over which to check support (e.g., "InputAdapters"); or null for all collections.
return	bool

UnprocessedMeasurementsHandler() public method

Event handler for monitoring unprocessed measurements.

Time-series framework uses this handler to monitor the number of unprocessed measurements in output adapters.
This method is typically called once every five seconds.

public UnprocessedMeasurementsHandler ( object sender, EventArgs e ) : void
sender	object	Event source reference to adapter, typically an output adapter, that is reporting the number of unprocessed measurements.
e	EventArgs	Event arguments containing number of queued (i.e., unprocessed) measurements in the source adapter.
return	void

UnpublishedSamplesHandler() public method

Event handler for monitoring unpublished samples.

Time-series framework uses this handler to monitor the number of unpublished samples, in seconds of data, in action adapters.
This method is typically called once every five seconds.

public UnpublishedSamplesHandler ( object sender, EventArgs e ) : void
sender	object	Event source reference to adapter, typically an action adapter, that is reporting the number of unpublished data samples.
e	EventArgs	Event arguments containing number of samples, in seconds of data, of unpublished data in the source adapter.
return	void