Gemstone Timeseries Library
Action
Defines a temporal processing constraint for the adapter.
Definition
Namespace: Gemstone.Timeseries.Adapters
Assembly: Gemstone.Timeseries (in Gemstone.Timeseries.dll) Version: 1.0.136 -- Release Build+045677775a56d15698be6ced5ce5213063e47102
Assembly: Gemstone.Timeseries (in Gemstone.Timeseries.dll) Version: 1.0.136 -- Release Build+045677775a56d15698be6ced5ce5213063e47102
C#
[AdapterCommandAttribute("Defines a temporal processing constraint for the adapter.",
new ResourceAccessLevel[] { ... })]
[LabelAttribute("Set Temporal Constraint")]
[ParameterAttribute("startTime", "Start Time", "Defines a relative or exact start time for the temporal constraint, defaults to DateTime.MinValue if blank.")]
[ParameterAttribute("stopTime", "Stop Time", "Defines a relative or exact stop time for the temporal constraint, defaults to DateTime.MaxValue if blank.")]
[ParameterAttribute("constraintParameters", "Constraint Parameters",
"Defines any temporal parameters related to the constraint.")]
public virtual void SetTemporalConstraint(
string? startTime,
string? stopTime,
string? constraintParameters
)VB
<AdapterCommandAttribute("Defines a temporal processing constraint for the adapter.",
New ResourceAccessLevel() { ... })>
<LabelAttribute("Set Temporal Constraint")>
<ParameterAttribute("startTime", "Start Time", "Defines a relative or exact start time for the temporal constraint, defaults to DateTime.MinValue if blank.")>
<ParameterAttribute("stopTime", "Stop Time", "Defines a relative or exact stop time for the temporal constraint, defaults to DateTime.MaxValue if blank.")>
<ParameterAttribute("constraintParameters", "Constraint Parameters",
"Defines any temporal parameters related to the constraint.")>
Public Overridable Sub SetTemporalConstraint (
startTime As String,
stopTime As String,
constraintParameters As String
)C++
public:
[AdapterCommandAttribute(L"Defines a temporal processing constraint for the adapter.",
__gc new array<ResourceAccessLevel>^ { ... })]
[LabelAttribute(L"Set Temporal Constraint")]
[ParameterAttribute(L"startTime", L"Start Time", L"Defines a relative or exact start time for the temporal constraint, defaults to DateTime.MinValue if blank.")]
[ParameterAttribute(L"stopTime", L"Stop Time", L"Defines a relative or exact stop time for the temporal constraint, defaults to DateTime.MaxValue if blank.")]
[ParameterAttribute(L"constraintParameters", L"Constraint Parameters",
L"Defines any temporal parameters related to the constraint.")]
virtual void SetTemporalConstraint(
String^ startTime,
String^ stopTime,
String^ constraintParameters
)JavaScript
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.
Implements
IAdapterSetTemporalConstraint(String, String, String)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. |