dnp3 (.NET API) 1.1.0
dnp3.UtcTimestamp Class Reference

Timestamp value returned by IAssociationHandler.GetCurrentTime. More...

Public Member Functions

UtcTimestamp WithValue (ulong value)
 Value of the timestamp (in milliseconds from UNIX Epoch). More...
 
UtcTimestamp WithIsValid (bool value)
 True if the timestamp is valid, false otherwise. More...
 

Static Public Member Functions

static UtcTimestamp Valid (ulong value)
 Construct a valid UtcTimestamp More...
 
static UtcTimestamp Invalid ()
 Construct an invalid UtcTimestamp More...
 

Public Attributes

ulong Value
 Value of the timestamp (in milliseconds from UNIX Epoch). More...
 
bool IsValid
 True if the timestamp is valid, false otherwise. More...
 

Detailed Description

Timestamp value returned by IAssociationHandler.GetCurrentTime.

UtcTimestamp.Value is only valid if UtcTimestamp.IsValid is true.

Member Function Documentation

◆ Invalid()

static UtcTimestamp dnp3.UtcTimestamp.Invalid ( )
inlinestatic

Construct an invalid UtcTimestamp

Default values:

Returns
Initialized UtcTimestamp instance

◆ Valid()

static UtcTimestamp dnp3.UtcTimestamp.Valid ( ulong  value)
inlinestatic

Construct a valid UtcTimestamp

Default values:

Parameters
valueValue of the timestamp (in milliseconds from UNIX Epoch).
Returns
Initialized UtcTimestamp instance

◆ WithIsValid()

UtcTimestamp dnp3.UtcTimestamp.WithIsValid ( bool  value)
inline

True if the timestamp is valid, false otherwise.

◆ WithValue()

UtcTimestamp dnp3.UtcTimestamp.WithValue ( ulong  value)
inline

Value of the timestamp (in milliseconds from UNIX Epoch).

Warning: Only 48 bits are available for timestamps.

Member Data Documentation

◆ IsValid

bool dnp3.UtcTimestamp.IsValid

True if the timestamp is valid, false otherwise.

◆ Value

ulong dnp3.UtcTimestamp.Value

Value of the timestamp (in milliseconds from UNIX Epoch).

Warning: Only 48 bits are available for timestamps.


The documentation for this class was generated from the following file: