Data Fields
struct ua_datavalue *	data_values

int32_t	num_data_values

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

void	ua_historydata_clear (struct ua_historydata *t)
	Clear all resources alloctated in an ua_historydata struct. More...

int	ua_historydata_compare (const struct ua_historydata a, const struct ua_historydata b)
	Compare two ua_historydata structs. More...

int	ua_historydata_copy (struct ua_historydata dst, const struct ua_historydata src)
	Create a copy of a ua_historydata struct. More...

static int	ua_historydata_resize_data_values_array (struct ua_historydata *val, int32_t new_len)
	Resize the data_values array of a ua_historydata struct. More...

Friends And Related Function Documentation

void ua_historydata_clear ( struct ua_historydata * t )

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

int ua_historydata_compare	(	const struct ua_historydata *	a,
		const struct ua_historydata *	b
	)

Compares the content of the ua_historydata struct a to the content of the ua_historydata 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_historydata structs, so it is well suited to not only determine equality, but also sort multiple instances of this struct.

int ua_historydata_copy	(	struct ua_historydata *	dst,
		const struct ua_historydata *	src
	)

Copy all fields from struct ua_historydata 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_historydata_init ( struct ua_historydata * t )

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

static int ua_historydata_resize_data_values_array	(	struct ua_historydata *	val,
		int32_t	new_len
	)

Depending on new_len and the current size of the array, the array will be created, increased, decreased or deleted. In case array members are removed these are cleared properly, new array members are initialized with zero.

Parameters

new_len New length of the data_values array in number of members.

Returns: Zero on success or ua_statuscode on failure.

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

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

Data Fields

Related Functions

Friends And Related Function Documentation