The local time that may or may not take daylight saving time into account. More...

#include <timezonedatatype.h>

Data Fields
int16_t	offset
	The offset in minutes from UtcTime.

bool	daylight_saving_in_offset
	If TRUE, daylight saving time (DST) is in effect and offset includes the DST correction. More...

Related Functions
void	ua_timezonedatatype_init (struct ua_timezonedatatype *t)
	Initialize an ua_timezonedatatype struct with a valid value. More...

void	ua_timezonedatatype_clear (struct ua_timezonedatatype *t)
	Clear all resources alloctated in an ua_timezonedatatype struct. More...

int	ua_timezonedatatype_compare (const struct ua_timezonedatatype a, const struct ua_timezonedatatype b)
	Compare two ua_timezonedatatype structs. More...

int	ua_timezonedatatype_copy (struct ua_timezonedatatype dst, const struct ua_timezonedatatype src)
	Create a copy of a ua_timezonedatatype struct. More...

Detailed Description

The local time that may or may not take daylight saving time into account.

Friends And Related Function Documentation

void ua_timezonedatatype_clear ( struct ua_timezonedatatype * t )

Frees allocated memory like arrays and resets numeric values. The ua_timezonedatatype struct itself is not freed and must be freed by the caller if required. This function always succeeds for a valid ua_timezonedatatype struct, that was validly decoded, initilized by ua_timezonedatatype_init or created with ua_timezonedatatype_copy.

int ua_timezonedatatype_compare	(	const struct ua_timezonedatatype *	a,
		const struct ua_timezonedatatype *	b
	)

Compares the content of the ua_timezonedatatype struct a to the content of the ua_timezonedatatype struct b. If a is smaller than b, an integer less than zero is returned, if a is bigger than b, an integer greater than zero is returned. If both structs are equal zero is returned.

This function creates a total order on ua_timezonedatatype structs, so it is well suited to not only determine equality, but also sort multiple instances of this struct.

int ua_timezonedatatype_copy	(	struct ua_timezonedatatype *	dst,
		const struct ua_timezonedatatype *	src
	)

Copy all fields from struct ua_timezonedatatype src to dst. Creates a deep copy so all content is recusively copied and both src and dst can be used and must be freed separately.

dst is not cleared before the copy operation, so it must not have any allocated data. It may or may not be initilized by the caller before copy.

Returns: Zero on success or ua_statuscode on failure.

void ua_timezonedatatype_init ( struct ua_timezonedatatype * t )

After initialization the fields of the struct are set to valid and consistent values and can safley be accessed. An initialized ua_timezonedatatype struct can also be passed to ua_timezonedatatype_compare, ua_timezonedatatype_copy and ua_timezonedatatype_clear. This function will always succeed as long as an ua_timezonedatatype struct is passed to it.

Field Documentation

daylight_saving_in_offset

If TRUE, daylight saving time (DST) is in effect and offset includes the DST correction.

If FALSE, the offset does not include the DST correction and DST may or may not have been in effect.

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

C:/work/embeddedstack/src/uabase/structure/timezonedatatype.h
C:/work/embeddedstack/src/uabase/structure/timezonedatatype.c

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation