DateTimeExtensionsLocalTimeIsValid Method

Determines if the specified local time is valid, by comparing it to the system clock.

Namespace: GSF
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.205-beta+5ef4169f3b1079d8b163dd363614f656bd140924

Syntax

public static bool LocalTimeIsValid(
	this DateTime localTime,
	double lagTime,
	double leadTime
)

<ExtensionAttribute>
Public Shared Function LocalTimeIsValid ( 
	localTime As DateTime,
	lagTime As Double,
	leadTime As Double
) As Boolean

public:
[ExtensionAttribute]
static bool LocalTimeIsValid(
	DateTime localTime, 
	double lagTime, 
	double leadTime
)

[<ExtensionAttribute>]
static member LocalTimeIsValid : 
        localTime : DateTime * 
        lagTime : float * 
        leadTime : float -> bool

GSF.DateTimeExtensions.LocalTimeIsValid = function(localTime, lagTime, leadTime);

localTime DateTime: Time to test for validity.
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.

Boolean
True, if time is within the specified range.

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.