|
IAdapterSetTemporalConstraint Method
|
Defines a temporal processing constraint for the adapter.
Namespace: GSF.TimeSeries.AdaptersAssembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.207-beta
Syntax void SetTemporalConstraint(
string startTime,
string stopTime,
string constraintParameters
)
Sub SetTemporalConstraint (
startTime As String,
stopTime As String,
constraintParameters As String
)
void SetTemporalConstraint(
String^ startTime,
String^ stopTime,
String^ constraintParameters
)
abstract SetTemporalConstraint :
startTime : string *
stopTime : string *
constraintParameters : string -> unit
function SetTemporalConstraint(startTime, stopTime, constraintParameters);
Parameters
- startTime String
- Defines a relative or exact start time for the temporal constraint.
- stopTime String
- Defines a relative or exact stop time for the temporal constraint.
- constraintParameters String
- Defines any temporal parameters related to the constraint.
Remarks
This method defines a temporal processing constraint for an adapter, i.e., the start and stop time over which an
adapter will process data. Actual implementation of the constraint will be adapter specific. Implementations
should be able to dynamically handle multiple calls to this function with new constraints. Passing in null
for the startTime and stopTime should cancel the temporal constraint and
return the adapter to standard / real-time operation.
The startTime and stopTime parameters can be specified in one of the
following formats:
Time Format | Format Description |
---|
12-30-2000 23:59:59.033 | Absolute date and time. |
* | Evaluates to UtcNow. |
*-20s | Evaluates to 20 seconds before UtcNow. |
*-10m | Evaluates to 10 minutes before UtcNow. |
*-1h | Evaluates to 1 hour before UtcNow. |
*-1d | Evaluates to 1 day before UtcNow. |
See Also