TicksUtcTimeIsValid(Double, Double) Method

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

Namespace: GSF
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta

Syntax

C++

JavaScript

Copy

public bool UtcTimeIsValid(
	double lagTime,
	double leadTime
)

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

public:
bool UtcTimeIsValid(
	double lagTime, 
	double leadTime
)

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

function UtcTimeIsValid(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 UTC 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 system clock time in UTC. Note that lagTime and leadTime must be greater than zero, but can be set to sub-second intervals.

Reference

Ticks Structure

UtcTimeIsValid Overload

GSF Namespace