TicksLocalTimeIsValid(Double, Double) Method

Determines if time, represented by Ticks value in local time, is valid by comparing it to the system clock.

Namespace: GSF
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.300-beta+b2186e2cd1f968c931b0e151fdd7c839f3d1e9cf

Syntax

C++

JavaScript

Copy

public bool LocalTimeIsValid(
	double lagTime,
	double leadTime
)

Public Function LocalTimeIsValid ( 
	lagTime As Double,
	leadTime As Double
) As Boolean

public:
bool LocalTimeIsValid(
	double lagTime, 
	double leadTime
)

member LocalTimeIsValid : 
        lagTime : float * 
        leadTime : float -> bool

function LocalTimeIsValid(lagTime, leadTime);

View Source

Parameters

lagTime Double: The allowed lag time, in seconds, before assuming time is too old to be valid.
leadTime Double: The allowed lead time, in seconds, before assuming time is too advanced to be valid.

Return Value

Boolean
True, if local time represented by Ticks value, is within the specified range.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	lagTime and leadTime must be greater than zero, but can be less than one.

Remarks

Time, represented by Ticks value, is considered valid if it exists within the specified lagTime and leadTime range of local system clock time. Note that lagTime and leadTime must be greater than zero, but can be set to sub-second intervals.

Reference

Ticks Structure

LocalTimeIsValid Overload

GSF Namespace