dnp3::UtcTimestamp Struct Reference

Timestamp value returned by AssociationHandler::get_current_time(). More...

#include <dnp3.hpp>

Static Public Member Functions
static UtcTimestamp	valid (uint64_t value)
	Construct a valid UtcTimestamp. More...
static UtcTimestamp	invalid ()
	Construct an invalid UtcTimestamp. More...

Public Attributes
uint64_t	value
	Value of the timestamp (in milliseconds from UNIX Epoch). More...
bool	is_valid
	True if the timestamp is valid, false otherwise. More...

Friends
class	CppUtcTimestampFriend

Detailed Description

Timestamp value returned by AssociationHandler::get_current_time().

UtcTimestamp::value is only valid if UtcTimestamp::is_valid is true.

Member Function Documentation

invalid()

static UtcTimestamp dnp3::UtcTimestamp::invalid ( )

static

Construct an invalid UtcTimestamp.

Note

Values are initialized to:

• UtcTimestamp::is_valid : false
• UtcTimestamp::value : 0

Returns

New instance of UtcTimestamp

valid()

static UtcTimestamp dnp3::UtcTimestamp::valid ( uint64_t  value )

static

Construct a valid UtcTimestamp.

Note

Values are initialized to:

• UtcTimestamp::is_valid : true

Parameters

value

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

Returns

New instance of UtcTimestamp

Member Data Documentation

is_valid

bool dnp3::UtcTimestamp::is_valid

True if the timestamp is valid, false otherwise.

value

uint64_t dnp3::UtcTimestamp::value

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

Warning

Only 48 bits are available for timestamps.

---

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

• dnp3.hpp