UaHistoryReadResults Class Reference

Array class for the UA stack structure OpcUa_HistoryReadResult. More...

#include <uaarraytemplates.h>

Public Member Functions
	UaHistoryReadResults ()
	Constructs an empty instance of the class UaHistoryReadResults.
	UaHistoryReadResults (const UaHistoryReadResults &other)
	Constructs an instance of the class HistoryReadResults with values from another HistoryReadResults object. More...
	UaHistoryReadResults (OpcUa_Int32 length, OpcUa_HistoryReadResult *data)
	Constructs an instance of the class UaHistoryReadResult using a raw OpcUa_HistoryReadResult array. More...
virtual	~UaHistoryReadResults ()
	Destroys the UaHistoryReadResults object.
UaHistoryReadResults &	operator= (const UaHistoryReadResults &other)
	Assignment operator. More...
const OpcUa_HistoryReadResult &	operator[] (OpcUa_UInt32 index) const
	Index operator. More...
OpcUa_HistoryReadResult &	operator[] (OpcUa_UInt32 index)
	Index operator. More...
bool	operator== (const UaHistoryReadResults &other) const
	Compare two UaHistoryReadResults. More...
bool	operator!= (const UaHistoryReadResults &other) const
	Compare two UaHistoryReadResults. More...
void	attach (OpcUa_UInt32 length, OpcUa_HistoryReadResult *data)
	Attach to a raw OpcUa_HistoryReadResult array. More...
void	attach (OpcUa_Int32 length, OpcUa_HistoryReadResult *data)
	Attach to a raw OpcUa_HistoryReadResult array. More...
OpcUa_HistoryReadResult *	detach ()
	Detach from the internal OpcUa_HistoryReadResult array. More...
void	create (OpcUa_UInt32 length)
	Clears the array and resizes to the given length. More...
void	resize (OpcUa_UInt32 length)
	Resizes the array to a given length. More...
void	clear ()
	Clears the array.

Detailed Description

Array class for the UA stack structure OpcUa_HistoryReadResult.

This class encapsulates an array of the native OpcUa_HistoryReadResult structure and handles memory allocation and cleanup for you.

Constructor & Destructor Documentation

UaHistoryReadResults::UaHistoryReadResults

(

const UaHistoryReadResults &

other

)

Constructs an instance of the class HistoryReadResults with values from another HistoryReadResults object.

Parameters

other

the other HistoryReadResults used to initialize the object

UaHistoryReadResults::UaHistoryReadResults	(	OpcUa_Int32	length,
		OpcUa_HistoryReadResult *	data
	)

Constructs an instance of the class UaHistoryReadResult using a raw OpcUa_HistoryReadResult array.

Parameters

length	the length of the raw OpcUa_HistoryReadResult array
data	the raw OpcUa_HistoryReadResult array

Member Function Documentation

void UaHistoryReadResults::attach	(	OpcUa_UInt32	length,
		OpcUa_HistoryReadResult *	data
	)

Attach to a raw OpcUa_HistoryReadResult array.

Note

Don't manually free the attached data afterwards, because UaHistoryReadResults is responsible for it now.

Parameters

length	the length of the raw OpcUa_HistoryReadResult array
data	the raw OpcUa_HistoryReadResult array

void UaHistoryReadResults::attach	(	OpcUa_Int32	length,
		OpcUa_HistoryReadResult *	data
	)

Attach to a raw OpcUa_HistoryReadResult array.

Note

Don't manually free the attached data afterwards, because UaHistoryReadResults is responsible for it now.

Parameters

length	the length of the raw OpcUa_HistoryReadResult array
data	the raw OpcUa_HistoryReadResult array

void UaHistoryReadResults::create

(

OpcUa_UInt32

length

)

Clears the array and resizes to the given length.

Parameters

length

the new length of the array

OpcUa_HistoryReadResult * UaHistoryReadResults::detach

(

)

Detach from the internal OpcUa_HistoryReadResult array.

After detaching, the detached array data will not be cleared automatically anymore.

Note

Remember to retrieve the length of the array before detaching.

Returns

the detached OpcUa_HistoryReadResult array

bool UaHistoryReadResults::operator!=

(

const UaHistoryReadResults &

other

)

const

Compare two UaHistoryReadResults.

See also

operator==

Parameters

other

the UaHistoryReadResults to compare with.

Returns

true if not equal, false otherwise.

UaHistoryReadResults & UaHistoryReadResults::operator=

(

const UaHistoryReadResults &

other

)

Assignment operator.

Parameters

other

the UaHistoryReadResults to assign.

bool UaHistoryReadResults::operator==

(

const UaHistoryReadResults &

other

)

const

Compare two UaHistoryReadResults.

Parameters

other

the UaHistoryReadResults to compare with.

Returns

true if equal, false if not.

const OpcUa_HistoryReadResult & UaHistoryReadResults::operator[]

(

OpcUa_UInt32

index

)

const

Index operator.

Parameters

index

the index of the structure to return.

OpcUa_HistoryReadResult & UaHistoryReadResults::operator[]

(

OpcUa_UInt32

index

)

Index operator.

Parameters

index

the index of the structure to return.

void UaHistoryReadResults::resize

(

OpcUa_UInt32

length

)

Resizes the array to a given length.

Parameters

length

the new length of the array

---

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

• C:/work/uasdkcpp/src/uabase/uabasecpp/uaarraytemplates.h
• C:/work/uasdkcpp/src/uabase/uabasecpp/uaarraytemplates.cpp