UaBrowseResults Class Reference

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

#include <uaarraytemplates.h>

Public Member Functions
	UaBrowseResults ()
	Constructs an empty instance of the class UaBrowseResults.
	UaBrowseResults (const UaBrowseResults &other)
	Constructs an instance of the class BrowseResults with values from another BrowseResults object. More...
	UaBrowseResults (OpcUa_Int32 length, OpcUa_BrowseResult *data)
	Constructs an instance of the class UaBrowseResult using a raw OpcUa_BrowseResult array. More...
virtual	~UaBrowseResults ()
	Destroys the UaBrowseResults object.
UaBrowseResults &	operator= (const UaBrowseResults &other)
	Assignment operator. More...
const OpcUa_BrowseResult &	operator[] (OpcUa_UInt32 index) const
	Index operator. More...
OpcUa_BrowseResult &	operator[] (OpcUa_UInt32 index)
	Index operator. More...
bool	operator== (const UaBrowseResults &other) const
	Compare two UaBrowseResults. More...
bool	operator!= (const UaBrowseResults &other) const
	Compare two UaBrowseResults. More...
void	attach (OpcUa_UInt32 length, OpcUa_BrowseResult *data)
	Attach to a raw OpcUa_BrowseResult array. More...
void	attach (OpcUa_Int32 length, OpcUa_BrowseResult *data)
	Attach to a raw OpcUa_BrowseResult array. More...
OpcUa_BrowseResult *	detach ()
	Detach from the internal OpcUa_BrowseResult 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_BrowseResult.

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

Constructor & Destructor Documentation

UaBrowseResults::UaBrowseResults

(

const UaBrowseResults &

other

)

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

Parameters

other

the other BrowseResults used to initialize the object

UaBrowseResults::UaBrowseResults	(	OpcUa_Int32	length,
		OpcUa_BrowseResult *	data
	)

Constructs an instance of the class UaBrowseResult using a raw OpcUa_BrowseResult array.

Parameters

length	the length of the raw OpcUa_BrowseResult array
data	the raw OpcUa_BrowseResult array

Member Function Documentation

void UaBrowseResults::attach	(	OpcUa_UInt32	length,
		OpcUa_BrowseResult *	data
	)

Attach to a raw OpcUa_BrowseResult array.

Note

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

Parameters

length	the length of the raw OpcUa_BrowseResult array
data	the raw OpcUa_BrowseResult array

void UaBrowseResults::attach	(	OpcUa_Int32	length,
		OpcUa_BrowseResult *	data
	)

Attach to a raw OpcUa_BrowseResult array.

Note

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

Parameters

length	the length of the raw OpcUa_BrowseResult array
data	the raw OpcUa_BrowseResult array

void UaBrowseResults::create

(

OpcUa_UInt32

length

)

Clears the array and resizes to the given length.

Parameters

length

the new length of the array

OpcUa_BrowseResult * UaBrowseResults::detach

(

)

Detach from the internal OpcUa_BrowseResult 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_BrowseResult array

bool UaBrowseResults::operator!=

(

const UaBrowseResults &

other

)

const

Compare two UaBrowseResults.

See also

operator==

Parameters

other

the UaBrowseResults to compare with.

Returns

true if not equal, false otherwise.

UaBrowseResults & UaBrowseResults::operator=

(

const UaBrowseResults &

other

)

Assignment operator.

Parameters

other

the UaBrowseResults to assign.

bool UaBrowseResults::operator==

(

const UaBrowseResults &

other

)

const

Compare two UaBrowseResults.

Parameters

other

the UaBrowseResults to compare with.

Returns

true if equal, false if not.

const OpcUa_BrowseResult & UaBrowseResults::operator[]

(

OpcUa_UInt32

index

)

const

Index operator.

Parameters

index

the index of the structure to return.

OpcUa_BrowseResult & UaBrowseResults::operator[]

(

OpcUa_UInt32

index

)

Index operator.

Parameters

index

the index of the structure to return.

void UaBrowseResults::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