|
ConcentratorBase(Int32, Double, Double) Constructor
|
Namespace: GSF.TimeSeriesAssembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.246-beta
Syntaxprotected ConcentratorBase(
int framesPerSecond,
double lagTime,
double leadTime
)
Protected Sub New (
framesPerSecond As Integer,
lagTime As Double,
leadTime As Double
)
protected:
ConcentratorBase(
int framesPerSecond,
double lagTime,
double leadTime
)
new :
framesPerSecond : int *
lagTime : float *
leadTime : float -> ConcentratorBase
GSF.TimeSeries.ConcentratorBase = function(framesPerSecond, lagTime, leadTime);
View SourceParameters
- framesPerSecond Int32
- Number of frames to publish per second.
- lagTime Double
- Past time deviation tolerance, in seconds - this becomes the amount of time to wait before publishing begins.
- leadTime Double
- Future time deviation tolerance, in seconds - this becomes the tolerated +/- accuracy of the local clock to real-time.
ExceptionsException | Condition |
---|
ArgumentOutOfRangeException | Specified argument is outside of allowed value range (see remarks). |
RemarksframesPerSecond must be greater then 0.
lagTime must be greater than zero, but can be specified in sub-second intervals (e.g., set to .25 for a quarter-second lag time).
Note that this defines time sensitivity to past timestamps.
leadTime must be greater than zero, but can be specified in sub-second intervals (e.g., set to .5 for a half-second lead time).
Note that this defines time sensitivity to future timestamps.
Concentration will not begin until consumer "Starts" concentrator (i.e., calling Start method or setting
Enabled = true).
See Also