UaLocalizedTextArray Class Reference

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

#include <uaarraytemplates.h>

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

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

See also

UaLocalizedText for information about the encapsulated structure.

Constructor & Destructor Documentation

UaLocalizedTextArray::UaLocalizedTextArray

(

const UaLocalizedTextArray &

other

)

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

Parameters

other

the other LocalizedTextArray used to initialize the object

UaLocalizedTextArray::UaLocalizedTextArray	(	OpcUa_Int32	length,
		OpcUa_LocalizedText *	data
	)

Constructs an instance of the class UaLocalizedText using a raw OpcUa_LocalizedText array.

Parameters

length	the length of the raw OpcUa_LocalizedText array
data	the raw OpcUa_LocalizedText array

Member Function Documentation

void UaLocalizedTextArray::attach	(	OpcUa_UInt32	length,
		OpcUa_LocalizedText *	data
	)

Attach to a raw OpcUa_LocalizedText array.

Note

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

Parameters

length	the length of the raw OpcUa_LocalizedText array
data	the raw OpcUa_LocalizedText array

void UaLocalizedTextArray::attach	(	OpcUa_Int32	length,
		OpcUa_LocalizedText *	data
	)

Attach to a raw OpcUa_LocalizedText array.

Note

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

Parameters

length	the length of the raw OpcUa_LocalizedText array
data	the raw OpcUa_LocalizedText array

void UaLocalizedTextArray::create

(

OpcUa_UInt32

length

)

Clears the array and resizes to the given length.

Parameters

length

the new length of the array

OpcUa_LocalizedText * UaLocalizedTextArray::detach

(

)

Detach from the internal OpcUa_LocalizedText 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_LocalizedText array

bool UaLocalizedTextArray::operator!=

(

const UaLocalizedTextArray &

other

)

const

Compare two UaLocalizedTextArray.

See also

operator==

Parameters

other

the UaLocalizedTextArray to compare with.

Returns

true if not equal, false otherwise.

UaLocalizedTextArray & UaLocalizedTextArray::operator=

(

const UaLocalizedTextArray &

other

)

Assignment operator.

Parameters

other

the UaLocalizedTextArray to assign.

bool UaLocalizedTextArray::operator==

(

const UaLocalizedTextArray &

other

)

const

Compare two UaLocalizedTextArray.

Parameters

other

the UaLocalizedTextArray to compare with.

Returns

true if equal, false if not.

const OpcUa_LocalizedText & UaLocalizedTextArray::operator[]

(

OpcUa_UInt32

index

)

const

Index operator.

Parameters

index

the index of the structure to return.

OpcUa_LocalizedText & UaLocalizedTextArray::operator[]

(

OpcUa_UInt32

index

)

Index operator.

Parameters

index

the index of the structure to return.

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