C# Class GSF.TimeSeries.Configuration.ConfigurationLoaderBase

Represents a base class for IConfigurationLoader implementations.
Inheritance: IConfigurationLoader
Show file Open project: GridProtectionAlliance/gsf

Public Methods

Method Description
Augment ( DataSet configuration ) : void

Augments the given configuration data set with the changes tracked since the version of the given configuration data set.
Load ( ) : DataSet

Loads the entire configuration data set from scratch.

Protected Methods

Method Description
ConfigurationLoaderBase ( ) : System

Creates a new ConfigurationLoaderBase instance.
OnProcessException ( MessageLevel level, Exception exception, string eventName = null, MessageFlags flags = MessageFlags.None ) : void

Raises the ProcessException event.

should be a constant string value associated with what type of message is being generated. In general, there should only be a few dozen distinct event names per class. Exceeding this threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.

OnStatusMessage ( MessageLevel level, string status, string eventName = null, MessageFlags flags = MessageFlags.None ) : void

Raises the StatusMessage event and sends this data to the Logger.

should be a constant string value associated with what type of message is being generated. In general, there should only be a few dozen distinct event names per class. Exceeding this threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.

Method Details

Augment() public abstract method

Augments the given configuration data set with the changes tracked since the version of the given configuration data set.
public abstract Augment ( DataSet configuration ) : void
configuration System.Data.DataSet The configuration data set to be augmented.
return void

ConfigurationLoaderBase() protected method

Creates a new ConfigurationLoaderBase instance.
protected ConfigurationLoaderBase ( ) : System
return System

Load() public abstract method

Loads the entire configuration data set from scratch.
public abstract Load ( ) : DataSet
return System.Data.DataSet

OnProcessException() protected method

Raises the ProcessException event.
should be a constant string value associated with what type of message is being generated. In general, there should only be a few dozen distinct event names per class. Exceeding this threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.
protected OnProcessException ( MessageLevel level, Exception exception, string eventName = null, MessageFlags flags = MessageFlags.None ) : void
level MessageLevel The to assign to this message
exception System.Exception Processing .
eventName string A fixed string to classify this event; defaults to null.
flags MessageFlags to use, if any; defaults to .
return void

OnStatusMessage() protected method

Raises the StatusMessage event and sends this data to the Logger.
should be a constant string value associated with what type of message is being generated. In general, there should only be a few dozen distinct event names per class. Exceeding this threshold will cause the EventName to be replaced with a general warning that a usage issue has occurred.
protected OnStatusMessage ( MessageLevel level, string status, string eventName = null, MessageFlags flags = MessageFlags.None ) : void
level MessageLevel The to assign to this message
status string New status message.
eventName string A fixed string to classify this event; defaults to null.
flags MessageFlags to use, if any; defaults to .
return void