A structure for storing Time values. More...

#include <xstimeinfo.h>

Public Attributes
uint8_t	m_day
	The day of the month (if date is valid) More...

uint8_t	m_hour
	The hour (if time is valid) More...

uint8_t	m_minute
	The minute (if time is valid) More...

uint8_t	m_month
	The month (if date is valid) More...

uint32_t	m_nano
	Nanosecond part of the time. More...

uint8_t	m_second
	The second (if time is valid) More...

int16_t	m_utcOffset
	Offset to UTC time in minutes. This value can be added to the stored time to get UTC time. More...

uint8_t	m_valid
	Validity indicator. More...

uint16_t	m_year
	The year (if date is valid) More...

Related Functions
(Note that these are not member functions.)
void	XsTimeInfo_currentLocalTime (struct XsTimeInfo *thisPtr)
	Returns the current local time. More...

void	XsTimeInfo_currentTime (struct XsTimeInfo *thisPtr)
	Returns the current UTC time. More...

void	XsTimeInfo_makeUtc (struct XsTimeInfo *thisPtr)
	Removes the local time information, making the object pure UTC. More...

void	XsUtcTime_currentTime (struct XsTimeInfo *thisPtr)
	Returns the current time in UTC date time format. More...

Detailed Description

A structure for storing Time values.

This class can contain UTC time information.

Definition at line 87 of file xstimeinfo.h.

Member Data Documentation

◆ m_day

uint8_t XsTimeInfo::m_day

The day of the month (if date is valid)

Definition at line 92 of file xstimeinfo.h.

◆ m_hour

uint8_t XsTimeInfo::m_hour

The hour (if time is valid)

Definition at line 93 of file xstimeinfo.h.

◆ m_minute

uint8_t XsTimeInfo::m_minute

The minute (if time is valid)

Definition at line 94 of file xstimeinfo.h.

◆ m_month

uint8_t XsTimeInfo::m_month

The month (if date is valid)

Definition at line 91 of file xstimeinfo.h.

◆ m_nano

uint32_t XsTimeInfo::m_nano

Nanosecond part of the time.

Definition at line 89 of file xstimeinfo.h.

◆ m_second

uint8_t XsTimeInfo::m_second

The second (if time is valid)

Definition at line 95 of file xstimeinfo.h.

◆ m_utcOffset

int16_t XsTimeInfo::m_utcOffset

Offset to UTC time in minutes. This value can be added to the stored time to get UTC time.

Definition at line 97 of file xstimeinfo.h.

◆ m_valid

uint8_t XsTimeInfo::m_valid

Validity indicator.

When received: bit (0) - UTC Date is valid; bit (1) - UTC Time of Day is valid; bit (2) - UTC Time of Day has been fully resolved (i.e. no seconds uncertainty).

Definition at line 96 of file xstimeinfo.h.

◆ m_year

uint16_t XsTimeInfo::m_year

The year (if date is valid)

Definition at line 90 of file xstimeinfo.h.

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

Public Attributes

Related Functions