DateTimeExtensionsTimeIsValid Method

Determines if time is valid, by comparing it to the specified current time.

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

Syntax

public static bool TimeIsValid(
	this DateTime testTime,
	DateTime currentTime,
	double lagTime,
	double leadTime
)

<ExtensionAttribute>
Public Shared Function TimeIsValid ( 
	testTime As DateTime,
	currentTime As DateTime,
	lagTime As Double,
	leadTime As Double
) As Boolean

public:
[ExtensionAttribute]
static bool TimeIsValid(
	DateTime testTime, 
	DateTime currentTime, 
	double lagTime, 
	double leadTime
)

[<ExtensionAttribute>]
static member TimeIsValid : 
        testTime : DateTime * 
        currentTime : DateTime * 
        lagTime : float * 
        leadTime : float -> bool

GSF.DateTimeExtensions.TimeIsValid = function(testTime, currentTime, lagTime, leadTime);

View Source

Parameters

testTime DateTime: Time to test for validity.
currentTime DateTime: Specified current time (e.g., could be Date.Now or Date.UtcNow).
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 time is within the specified range.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type DateTime. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentOutOfRangeException	LagTime and LeadTime must be greater than zero, but can be less than one.

Remarks

Time is considered valid if it exists within the specified lag time/lead time range of current time.

Note that lag time and lead time must be greater than zero, but can be set to sub-second intervals.

Reference

DateTimeExtensions Class

GSF Namespace