UaBrowseDescriptions Class Reference

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

#include <uaarraytemplates.h>

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

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

Constructor & Destructor Documentation

UaBrowseDescriptions::UaBrowseDescriptions

(

const UaBrowseDescriptions &

other

)

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

Parameters

other

the other BrowseDescriptions used to initialize the object

UaBrowseDescriptions::UaBrowseDescriptions	(	OpcUa_Int32	length,
		OpcUa_BrowseDescription *	data
	)

Constructs an instance of the class UaBrowseDescription using a raw OpcUa_BrowseDescription array.

Parameters

length	the length of the raw OpcUa_BrowseDescription array
data	the raw OpcUa_BrowseDescription array

Member Function Documentation

void UaBrowseDescriptions::attach	(	OpcUa_UInt32	length,
		OpcUa_BrowseDescription *	data
	)

Attach to a raw OpcUa_BrowseDescription array.

Note

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

Parameters

length	the length of the raw OpcUa_BrowseDescription array
data	the raw OpcUa_BrowseDescription array

void UaBrowseDescriptions::attach	(	OpcUa_Int32	length,
		OpcUa_BrowseDescription *	data
	)

Attach to a raw OpcUa_BrowseDescription array.

Note

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

Parameters

length	the length of the raw OpcUa_BrowseDescription array
data	the raw OpcUa_BrowseDescription array

void UaBrowseDescriptions::create

(

OpcUa_UInt32

length

)

Clears the array and resizes to the given length.

Parameters

length

the new length of the array

OpcUa_BrowseDescription * UaBrowseDescriptions::detach

(

)

Detach from the internal OpcUa_BrowseDescription 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_BrowseDescription array

bool UaBrowseDescriptions::operator!=

(

const UaBrowseDescriptions &

other

)

const

Compare two UaBrowseDescriptions.

See also

operator==

Parameters

other

the UaBrowseDescriptions to compare with.

Returns

true if not equal, false otherwise.

UaBrowseDescriptions & UaBrowseDescriptions::operator=

(

const UaBrowseDescriptions &

other

)

Assignment operator.

Parameters

other

the UaBrowseDescriptions to assign.

bool UaBrowseDescriptions::operator==

(

const UaBrowseDescriptions &

other

)

const

Compare two UaBrowseDescriptions.

Parameters

other

the UaBrowseDescriptions to compare with.

Returns

true if equal, false if not.

const OpcUa_BrowseDescription & UaBrowseDescriptions::operator[]

(

OpcUa_UInt32

index

)

const

Index operator.

Parameters

index

the index of the structure to return.

OpcUa_BrowseDescription & UaBrowseDescriptions::operator[]

(

OpcUa_UInt32

index

)

Index operator.

Parameters

index

the index of the structure to return.

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