AdapterCollectionBaseTSetTemporalConstraint Method

Defines a temporal processing constraint for the adapter collection and applies this constraint to each adapter.

Definition

Namespace: Gemstone.Timeseries.Adapters
Assembly: Gemstone.Timeseries (in Gemstone.Timeseries.dll) Version: 1.0.128 -- Release Build+e2476c52e94864f123f37e60764c948e49eb89eb
[AdapterCommandAttribute("Defines a temporal processing constraint for each adapter in the collection.", 
	new string[] { ... })]
public virtual void SetTemporalConstraint(
	string startTime,
	string stopTime,
	string 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 FormatFormat Description
12-30-2000 23:59:59.033Absolute date and time.
*Evaluates to UtcNow.
*-20sEvaluates to 20 seconds before UtcNow.
*-10mEvaluates to 10 minutes before UtcNow.
*-1hEvaluates to 1 hour before UtcNow.
*-1dEvaluates to 1 day before UtcNow.

See Also