Defines the Range for a value. More...

#include <range.h>

Data Fields
double	low
	Lowest value in the range.

double	high
	Highest value in the range.

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

void	ua_range_clear (struct ua_range *t)
	Clear all resources alloctated in an ua_range struct. More...

int	ua_range_compare (const struct ua_range a, const struct ua_range b)
	Compare two ua_range structs. More...

int	ua_range_copy (struct ua_range dst, const struct ua_range src)
	Create a copy of a ua_range struct. More...

Detailed Description

Defines the Range for a value.

Friends And Related Function Documentation

void ua_range_clear ( struct ua_range * t )

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

int ua_range_compare	(	const struct ua_range *	a,
		const struct ua_range *	b
	)

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

int ua_range_copy	(	struct ua_range *	dst,
		const struct ua_range *	src
	)

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

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

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

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation