The details for delete raw and delete modified history updates. More...

#include <deleterawmodifieddetails.h>

Data Fields
struct ua_nodeid	node_id
	NodeId of the object for which history values are to be deleted.

bool	is_delete_modified
	TRUE for MODIFIED, FALSE for RAW. More...

ua_datetime	start_time
	The beginning of the period to be deleted.

ua_datetime	end_time
	The end of the period to be deleted.

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

void	ua_deleterawmodifieddetails_clear (struct ua_deleterawmodifieddetails *t)
	Clear all resources alloctated in an ua_deleterawmodifieddetails struct. More...

int	ua_deleterawmodifieddetails_compare (const struct ua_deleterawmodifieddetails a, const struct ua_deleterawmodifieddetails b)
	Compare two ua_deleterawmodifieddetails structs. More...

int	ua_deleterawmodifieddetails_copy (struct ua_deleterawmodifieddetails dst, const struct ua_deleterawmodifieddetails src)
	Create a copy of a ua_deleterawmodifieddetails struct. More...

Detailed Description

The details for delete raw and delete modified history updates.

These functions are intended to be used to delete data that has been accidentally entered into the history database, e.g. deletion of data from a source with incorrect timestamps. Both startTime and endTime must be defined. The startTime must be less than the endTime, and values up to but not including the endTime are deleted. It is permissible for startTime = endTime, in which case the value at the startTime is deleted.

Delete raw functionality
Setting isDeleteModified = FALSE deletes all raw entries from the history database for the specified time domain for one more HistoricalDataNodes.

If no data is found in the time range for a particular HistoricalDataNode, the StatusCode for that item is Bad_NoData.

Delete modified functionality
Setting isDeleteModified = TRUE deletes all modified entries from the history database for the specified time domain for one or more HistoricalDataNodes. If no data is found in the time range for a particular HistoricalDataNode, the StatusCode for that item is Bad_NoData.

Friends And Related Function Documentation

void ua_deleterawmodifieddetails_clear ( struct ua_deleterawmodifieddetails * t )

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

int ua_deleterawmodifieddetails_compare	(	const struct ua_deleterawmodifieddetails *	a,
		const struct ua_deleterawmodifieddetails *	b
	)

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

int ua_deleterawmodifieddetails_copy	(	struct ua_deleterawmodifieddetails *	dst,
		const struct ua_deleterawmodifieddetails *	src
	)

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

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

Field Documentation

is_delete_modified

TRUE for MODIFIED, FALSE for RAW.

Default value is FALSE.

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

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation