|
Data
|
Represents a data gap recovery module.
Inheritance Hierarchy
Namespace: GSF.TimeSeries.Transport
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.181-beta
Syntaxpublic class DataGapRecoverer : ISupportLifecycle, IDisposable, IProvideStatus
The DataGapRecoverer type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DataGapRecoverer | Creates a new DataGapRecoverer. |
Properties| Name | Description | |
|---|---|---|
 | ConnectionString | Gets or sets connection string that will be used to make a temporal subscription when recovering data for an Outage. |
| ConstraintParameters | Gets or sets any additional constraint parameters that will be supplied to adapters in temporal subscription used when recovering data for an Outage. |
 | DataGapLog | Gets reference to the data gap OutageLog for this DataGapRecoverer. |
| DataGapLogProcessor | Gets reference to the data gap OutageLogProcessor for this DataGapRecoverer. |
| DataMonitoringInterval | Gets or sets the interval, in seconds, over which the data monitor will check for new data. |
| DataSource | Gets or sets DataSet based data source available to this DataGapRecoverer. |
| Enabled | Gets or sets a boolean value that indicates whether the DataGapRecoverer is enabled. |
| EndRecoveryBuffer | Gets or sets end buffer time, in seconds, to add to end of outage window to ensure all missing data is recovered. |
| FilterExpression | Gets or sets the filter expression used to define which measurements are being requested for data recovery during an Outage. |
| IsDisposed | Gets a flag that indicates whether the object has been disposed. |
| Log | Log messages generated by an adapter. |
| LoggingPath | Gets or sets logging path to be used to be runtime and outage logs of the subscriber which are required for automated data recovery. |
| MaximumRecoverySpan | Gets to sets the maximum time span, in seconds, for which a data recovery will be attempted. Set to MaxValue for no maximum. |
| MinimumRecoverySpan | Gets to sets the minimum time span, in seconds, for which a data recovery will be attempted. Set to zero for no minimum. |
| RecoveryProcessingInterval |
Gets or sets the data recovery processing interval, in whole milliseconds, to use in the temporal data
subscription when recovering data for an Outage. A value of -1 indicates the default processing interval will be requested. A value of 0 indicates data will be processed as fast as possible. |
| RecoveryStartDelay | Gets or sets the minimum time delay, in seconds, to wait before starting the data recovery for an Outage. |
| SourceConnectionName | Gets or sets name of source connection device (e.g., a data subscriber). |
| StartRecoveryBuffer | Gets or sets start buffer time, in seconds, to add to start of outage window to ensure all missing data is recovered. |
| Status | Gets the status of this DataGapRecoverer. |
| TemporalSubscriptionStatus | Gets the status of the temporal DataSubscriber used to query historical data. |
| UseMillisecondResolution | Gets or sets the flag that determines whether measurement timestamps use millisecond resolution. If false, time will be of Ticks resolution. |
Methods| Name | Description | |
|---|---|---|
| Dispose | Releases all the resources used by the DataGapRecoverer object. |
 | Dispose(Boolean) | Releases the unmanaged resources used by the DataGapRecoverer object and optionally releases the managed resources. |
| DumpOutageLog | Produces a dump of the contents of the outage log. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize |
Releases the unmanaged resources before the DataGapRecoverer object is reclaimed by GC.
(Overrides ObjectFinalize) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize | Initializes the DataGapRecoverer. |
| LogDataGap | Logs a new data gap for processing. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnProcessException | Raises the ProcessException event. |
| OnRecoveredMeasurements | Raises the RecoveredMeasurements event. |
| OnStatusMessage | Raises the StatusMessage event and sends this data to the Logger. |
| RemoveDataGap | Removes a data gap from the outage log so that it will not be processed. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events| Name | Description | |
|---|---|---|
 | Disposed | Raised after the DataGapRecoverer has been properly disposed. |
| ProcessException | Event is raised when there is an exception encountered during DataGapRecoverer processing. |
| RecoveredMeasurements | Provides recovered measurements from temporal subscription. |
| StatusMessage | Provides status messages to consumer. |
Fields| Name | Description | |
|---|---|---|
  | DefaultDataMonitoringInterval | Default value for DataMonitoringInterval. |
| DefaultEndRecoveryBuffer | Default value for EndRecoveryBuffer. |
| DefaultFilterExpression | Default value for FilterExpression. |
| DefaultMaximumRecoverySpan | Default value for MaximumRecoverySpan. |
| DefaultMinimumRecoverySpan | Default value for MinimumRecoverySpan. |
| DefaultRecoveryProcessingInterval | Default value for RecoveryProcessingInterval. |
| DefaultRecoveryStartDelay | Default value for RecoveryStartDelay. |
| DefaultStartRecoveryBuffer | Default value for StartRecoveryBuffer. |
| DefaultUseMillisecondResolution | Default value for UseMillisecondResolution. |
Extension Methods| Name | Description | |
|---|---|---|
 | GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| GetEnumValueOrDefaultT |
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
RemarksData gaps will be recovered using an unsynchronized temporal subscription.
This class expects that source historian that feeds temporal subscription will recover data in time-sorted order.
See Also