C# Class GSF.Adapters.Adapter

Inheritance: System.MarshalByRefObject, IAdapter
Mostrar archivo Open project: GridProtectionAlliance/gsf Class Usage Examples

Private Properties

Property Type Description

Public Methods

Method Description
Adapter ( ) : System

Initializes a new instance of the Adapter.
Dispose ( ) : void

Releases all the resources used by the Adapter.
Initialize ( ) : void

Initializes the Adapter.
LoadSettings ( ) : void

Loads saved Adapter settings from the config file if the PersistSettings property is set to true.
SaveSettings ( ) : void

Saves Adapter settings to the config file if the PersistSettings property is set to true.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Releases the unmanaged resources used by the Adapter and optionally releases the managed resources.
OnDisposed ( ) : void

Raises the Disposed event.
OnExecutionException ( string activityDescription, Exception encounteredException ) : void

Raises the ExecutionException event.
OnStatusUpdate ( UpdateType updateType, string updateMessage ) : void

Raises the StatusUpdate event.

Method Details

Adapter() public method

Initializes a new instance of the Adapter.
public Adapter ( ) : System
return System

Dispose() public method

Releases all the resources used by the Adapter.
public Dispose ( ) : void
return void

Dispose() protected method

Releases the unmanaged resources used by the Adapter 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

Initialize() public method

Initializes the Adapter.
public Initialize ( ) : void
return void

LoadSettings() public method

Loads saved Adapter settings from the config file if the PersistSettings property is set to true.
has a value of null or empty string.
public LoadSettings ( ) : void
return void

OnDisposed() protected method

Raises the Disposed event.
protected OnDisposed ( ) : void
return void

OnExecutionException() protected method

Raises the ExecutionException event.
protected OnExecutionException ( string activityDescription, Exception encounteredException ) : void
activityDescription string Activity description to send to event.
encounteredException System.Exception Encountered to send to event.
return void

OnStatusUpdate() protected method

Raises the StatusUpdate event.
protected OnStatusUpdate ( UpdateType updateType, string updateMessage ) : void
updateType UpdateType to send to event.
updateMessage string Update message to send to event.
return void

SaveSettings() public method

Saves Adapter settings to the config file if the PersistSettings property is set to true.
has a value of null or empty string.
public SaveSettings ( ) : void
return void