dnp3  0.9.0
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
dnp3.TimestampUtc Class Reference

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

Public Member Functions

 TimestampUtc (ulong value, bool isValid)
 Initialize TimestampUtc to default values More...
 

Static Public Member Functions

static TimestampUtc Valid (ulong value)
 Create a valid timestamp value More...
 
static TimestampUtc Invalid ()
 Create an invalid timestamp value 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.

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

Constructor & Destructor Documentation

◆ TimestampUtc()

dnp3.TimestampUtc.TimestampUtc ( ulong  value,
bool  isValid 
)
inline

Initialize TimestampUtc to default values

Parameters
valueValue of the timestamp (in milliseconds from UNIX Epoch).
isValidTrue if the timestamp is valid, false otherwise.

Member Function Documentation

◆ Invalid()

static TimestampUtc dnp3.TimestampUtc.Invalid ( )
inlinestatic

Create an invalid timestamp value

Returns
Timestamp

◆ Valid()

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

Create a valid timestamp value

Returns
Timestamp

Member Data Documentation

◆ IsValid

bool dnp3.TimestampUtc.IsValid

True if the timestamp is valid, false otherwise.

◆ Value

ulong dnp3.TimestampUtc.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: