A structure that is defined as the type of the aggregateConfiguration parameter of the AggregateFilter structure. More...

#include <aggregateconfiguration.h>

Data Fields
bool	use_server_capabilities_defaults
	A Boolean parameter indicating whether to use default aggregate configuration settings. More...

bool	treat_uncertain_as_bad
	Indicates how the server treats data returned with a StatusCode severity Uncertain with respect to Aggregate calculations. More...

uint8_t	percent_data_bad
	Indicates the minimum percentage of bad data in a given interval required for the StatusCode for the given interval for processed data request to be set to Bad. More...

uint8_t	percent_data_good
	Indicates the minimum percentage of Good data in a given interval required for the StatusCode for the given interval for the processed data requests to be set to Good. More...

bool	use_sloped_extrapolation
	Indicates how the server interpolates data when no boundary value exists (i.e. More...

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

void	ua_aggregateconfiguration_clear (struct ua_aggregateconfiguration *t)
	Clear all resources alloctated in an ua_aggregateconfiguration struct. More...

int	ua_aggregateconfiguration_compare (const struct ua_aggregateconfiguration a, const struct ua_aggregateconfiguration b)
	Compare two ua_aggregateconfiguration structs. More...

int	ua_aggregateconfiguration_copy (struct ua_aggregateconfiguration dst, const struct ua_aggregateconfiguration src)
	Create a copy of a ua_aggregateconfiguration struct. More...

Detailed Description

A structure that is defined as the type of the aggregateConfiguration parameter of the AggregateFilter structure.

Friends And Related Function Documentation

void ua_aggregateconfiguration_clear ( struct ua_aggregateconfiguration * t )

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

int ua_aggregateconfiguration_compare	(	const struct ua_aggregateconfiguration *	a,
		const struct ua_aggregateconfiguration *	b
	)

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

int ua_aggregateconfiguration_copy	(	struct ua_aggregateconfiguration *	dst,
		const struct ua_aggregateconfiguration *	src
	)

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

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

Field Documentation

percent_data_bad

Indicates the minimum percentage of bad data in a given interval required for the StatusCode for the given interval for processed data request to be set to Bad.

Uncertain is treated as defined in ua_AggregateConfiguration::treat_uncertain_as_bad. For details on which Aggregates use the PercentDataBad Variable, see the definition of each Aggregate. The default value is 100.

The PercentDataGood and PercentDataBad must follow the following relationship
PercentDataGood >= (100 – PercentDataBad).
If they are equal, the result of the PercentDataGood calculation is used.

percent_data_good

Indicates the minimum percentage of Good data in a given interval required for the StatusCode for the given interval for the processed data requests to be set to Good.

For details on which Aggregates use the PercentDataGood Variable, see the definition of each Aggregate. The default value is 100.

The PercentDataGood and PercentDataBad must follow the following relationship
PercentDataGood >= (100 – PercentDataBad).
If they are equal, the result of the PercentDataGood calculation is used.

treat_uncertain_as_bad

Indicates how the server treats data returned with a StatusCode severity Uncertain with respect to Aggregate calculations.

It has the following values:

True: the server considers the severity equivalent to Bad,
False: indicates the server considers the severity equivalent to Good, unless the aggregate definition says otherwise.

A value of True indicates the server

The default value is True. Note that the value is still treated as Uncertain when the StatusCode for the result is calculated.

use_server_capabilities_defaults

A Boolean parameter indicating whether to use default aggregate configuration settings.

TRUE: use aggregate configuration settings as outlined by the AggregateConfiguration object.
FALSE: use configuration settings as outlined in the following aggregate configuration parameters.

use_sloped_extrapolation

Indicates how the server interpolates data when no boundary value exists (i.e.

extrapolating into the future from the last known value).

False: the server will use a SteppedExtrapolation format and hold the last known value constant.
True: the server will project the value using UseSlopedExtrapolation mode.

The default value is False. For SimpleBounds this value is ignored.

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

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation