Click or drag to resize
Grid Solutions Framework

AlarmAdapter Class

Action adapter that generates alarm measurements based on alarm definitions from the database.
Inheritance Hierarchy
SystemObject
  GSF.TimeSeries.AdaptersAdapterBase
    GSF.TimeSeries.AdaptersFacileActionAdapterBase
      DataQualityMonitoringAlarmAdapter

Namespace: DataQualityMonitoring
Assembly: DataQualityMonitoring (in DataQualityMonitoring.dll) Version: 2.4.207-beta
Syntax
public class AlarmAdapter : FacileActionAdapterBase
View Source

The AlarmAdapter type exposes the following members.

Constructors
 NameDescription
Public methodAlarmAdapter Creates a new instance of the AlarmAdapter class.
Top
Properties
 NameDescription
Public propertyAlarmRetention Gets or sets the amount of time, in hours, an Alarm change will be kept n the database.
Public propertyAutoStart Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
(Inherited from AdapterBase)
Public propertyBulkInsertLimit Gets or sets the maximum number of alarm state changes to pack into one alarm log insert query.
Public propertyConnectionInfo Gets connection info for adapter, if any.
(Inherited from AdapterBase)
Public propertyConnectionString Gets or sets key/value pair connection information specific to this AdapterBase.
(Inherited from AdapterBase)
Public propertyDataSource Gets or sets DataSet based data source available to this AdapterBase.
(Overrides AdapterBaseDataSource)
Public propertyStatic memberDefault The default (most recently created) instance of the alarm adapter.
Public propertyEnabled Gets or sets enabled state of this AdapterBase.
(Inherited from AdapterBase)
Public propertyFallBackOnLocalClock Gets or sets flag that determines whether to fall back on local clock time as real time when time is unreasonable.
(Inherited from FacileActionAdapterBase)
Public propertyFramesPerSecond Gets or sets the frames per second to be used by the FacileActionAdapterBase.
(Inherited from FacileActionAdapterBase)
Public propertyID Gets or sets numeric ID associated with this AdapterBase.
(Inherited from AdapterBase)
Public propertyInitializationTimeout Gets or sets maximum time system will wait during Start for initialization.
(Inherited from AdapterBase)
Public propertyInitialized Gets or sets flag indicating if the adapter has been initialized successfully.
(Inherited from AdapterBase)
Public propertyInputMeasurementKeys Gets or sets primary keys of input measurements the FacileActionAdapterBase expects, if any.
(Inherited from FacileActionAdapterBase)
Public propertyInputSourceIDs Gets or sets Source values used to filter input measurement keys.
(Inherited from FacileActionAdapterBase)
Public propertyIsDisposed Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterBase)
Public propertyLagTime Gets or sets the allowed past time deviation tolerance, in seconds (can be sub-second).
(Inherited from FacileActionAdapterBase)
Public propertyLatestMeasurements Gets reference to the collection of absolute latest received measurement values.
(Inherited from FacileActionAdapterBase)
Public propertyLeadTime Gets or sets the allowed future time deviation tolerance, in seconds (can be sub-second).
(Inherited from FacileActionAdapterBase)
Protected propertyLog Log messages generated by an adapter.
(Inherited from AdapterBase)
Public propertyLogProcessingDelay Gets or sets the amount of time, in seconds, to wait for alarm log state changes between bulk inserts.
Public propertyMeasurementReportingInterval Gets or sets the measurement reporting interval.
(Inherited from AdapterBase)
Public propertyName Gets or sets the name of this AdapterBase.
(Inherited from AdapterBase)
Public propertyOutputMeasurements Gets or sets output measurements that the AdapterBase will produce, if any.
(Inherited from AdapterBase)
Public propertyOutputSourceIDs Gets or sets Source values used to filter output measurements.
(Inherited from FacileActionAdapterBase)
Public propertyProcessedMeasurements Gets the total number of measurements handled thus far by the AdapterBase.
(Inherited from AdapterBase)
Public propertyProcessingInterval Gets or sets the desired processing interval, in milliseconds, for the adapter.
(Inherited from AdapterBase)
Public propertyRealTime Gets the most accurate time value that is available. If UseLocalClockAsRealTime = true, then this function will return UtcNow. Otherwise, this function will return the timestamp of the most recent measurement.
(Inherited from FacileActionAdapterBase)
Public propertyRequestedInputMeasurementKeys Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from FacileActionAdapterBase)
Public propertyRequestedOutputMeasurementKeys Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from FacileActionAdapterBase)
Public propertyRespectInputDemands Gets or sets flag indicating if action adapter should respect auto-start requests based on input demands.
(Inherited from FacileActionAdapterBase)
Public propertyRespectOutputDemands Gets or sets flag indicating if action adapter should respect auto-start requests based on output demands.
(Inherited from FacileActionAdapterBase)
Public propertyRunTime Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterBase)
Public propertySettings Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from AdapterBase)
Public propertyStartTime Gets the UTC time this AdapterBase was started.
(Inherited from AdapterBase)
Public propertyStartTimeConstraint Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterBase)
Public propertyStatus Returns the detailed status of the data input source.
(Overrides FacileActionAdapterBaseStatus)
Public propertyStopTime Gets the UTC time this AdapterBase was stopped.
(Inherited from AdapterBase)
Public propertyStopTimeConstraint Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterBase)
Public propertySupportsTemporalProcessing Gets the flag indicating if this adapter supports temporal processing.
(Overrides AdapterBaseSupportsTemporalProcessing)
Public propertyTrackLatestMeasurements Gets or sets flag to start tracking the absolute latest received measurement values.
(Inherited from FacileActionAdapterBase)
Public propertyUseAlarmLog Gets or sets the flag indicating whether the alarm adapter should use the alarm log to track recently modified alarm states.
Public propertyUseLocalClockAsRealTime Gets or sets flag that determines whether or not to use the local clock time as real time.
(Inherited from FacileActionAdapterBase)
Top
Methods
 NameDescription
Public methodDispose Releases all the resources used by the AdapterBase object.
(Inherited from AdapterBase)
Protected methodDispose(Boolean) Releases the unmanaged resources used by the AlarmAdapter object and optionally releases the managed resources.
(Overrides AdapterBaseDispose(Boolean))
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Releases the unmanaged resources before the AdapterBase object is reclaimed by GC.
(Inherited from AdapterBase)
Public methodGetAlarmStatus Gets Status of an Alarm Based on PointID.
Public methodGetHashCode Serves as a hash function for the current AdapterBase.
(Inherited from AdapterBase)
Public methodGetHighestSeverityAlarms Gets a collection containing raised alarms with the highest severity for each signal in the system.
Public methodGetRaisedAlarms Gets a collection containing all the raised alarms in the system.
Public methodGetShortStatus Gets a short one-line status of this AdapterBase.
(Overrides AdapterBaseGetShortStatus(Int32))
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodIncrementProcessedMeasurements Safely increments the total processed measurements.
(Inherited from AdapterBase)
Public methodInitialize Initializes the AlarmAdapter.
(Overrides FacileActionAdapterBaseInitialize)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnConfigurationChanged Raises ConfigurationChanged event.
(Inherited from AdapterBase)
Protected methodOnDiscardingMeasurements Raises the DiscardingMeasurements event.
(Inherited from FacileActionAdapterBase)
Protected methodOnInputMeasurementKeysUpdated Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterBase)
Protected methodOnNewMeasurements Raises the NewMeasurements event.
(Inherited from FacileActionAdapterBase)
Protected methodOnOutputMeasurementsUpdated Raises OutputMeasurementsUpdated event.
(Inherited from AdapterBase)
Protected methodOnProcessException(Exception)Obsolete.
Raises the ProcessException event.
(Inherited from AdapterBase)
Protected methodOnProcessException(MessageLevel, Exception, String, MessageFlags) Raises the ProcessException event.
(Inherited from AdapterBase)
Protected methodOnStatusMessage(String)Obsolete.
Raises the StatusMessage event.
(Inherited from AdapterBase)
Protected methodOnStatusMessage(String, Object)Obsolete.
Raises the StatusMessage event with a formatted status message.
(Inherited from AdapterBase)
Protected methodOnStatusMessage(MessageLevel, String, String, MessageFlags) Raises the StatusMessage event and sends this data to the Logger.
(Inherited from AdapterBase)
Protected methodOnUnpublishedSamples Raises the UnpublishedSamples event.
(Inherited from FacileActionAdapterBase)
Public methodQueueMeasurementForProcessing Queues a single measurement for processing.
(Inherited from FacileActionAdapterBase)
Public methodQueueMeasurementsForProcessing Queues a collection of measurements for processing.
(Overrides FacileActionAdapterBaseQueueMeasurementsForProcessing(IEnumerableIMeasurement))
Public methodSetInitializedState Manually sets the initialized state of the AdapterBase.
(Inherited from AdapterBase)
Public methodSetTemporalConstraint Defines a temporal processing constraint for the adapter.
(Inherited from AdapterBase)
Public methodStart Starts the AlarmAdapter, or restarts it if it is already running.
(Overrides AdapterBaseStart)
Public methodStop Stops the AdapterBase.
(Inherited from AdapterBase)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventConfigurationChanged Event is raised when adapter is aware of a configuration change.
(Inherited from AdapterBase)
Public eventDiscardingMeasurements This event is raised if there are any measurements being discarded during the sorting process.
(Inherited from FacileActionAdapterBase)
Public eventDisposed Event is raised when AdapterBase is disposed.
(Inherited from AdapterBase)
Public eventInputMeasurementKeysUpdated Event is raised when InputMeasurementKeys are updated.
(Inherited from AdapterBase)
Public eventNewMeasurements Provides new measurements from action adapter.
(Inherited from FacileActionAdapterBase)
Public eventOutputMeasurementsUpdated Event is raised when OutputMeasurements are updated.
(Inherited from AdapterBase)
Public eventProcessException Event is raised when there is an exception encountered while processing.
(Inherited from AdapterBase)
Public eventStatusMessage Provides status messages to consumer.
(Inherited from AdapterBase)
Public eventUnpublishedSamples This event is raised by derived class, if needed, to track current number of unpublished seconds of data in the queue.
(Inherited from FacileActionAdapterBase)
Top
See Also