UaRelativePaths Class Reference

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

#include <uaarraytemplates.h>

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

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

See also

UaRelativePath for information about the encapsulated structure.

Constructor & Destructor Documentation

UaRelativePaths::UaRelativePaths

(

const UaRelativePaths &

other

)

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

Parameters

other

the other RelativePaths used to initialize the object

UaRelativePaths::UaRelativePaths	(	OpcUa_Int32	length,
		OpcUa_RelativePath *	data
	)

Constructs an instance of the class UaRelativePath using a raw OpcUa_RelativePath array.

Parameters

length	the length of the raw OpcUa_RelativePath array
data	the raw OpcUa_RelativePath array

Member Function Documentation

void UaRelativePaths::attach	(	OpcUa_UInt32	length,
		OpcUa_RelativePath *	data
	)

Attach to a raw OpcUa_RelativePath array.

Note

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

Parameters

length	the length of the raw OpcUa_RelativePath array
data	the raw OpcUa_RelativePath array

void UaRelativePaths::attach	(	OpcUa_Int32	length,
		OpcUa_RelativePath *	data
	)

Attach to a raw OpcUa_RelativePath array.

Note

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

Parameters

length	the length of the raw OpcUa_RelativePath array
data	the raw OpcUa_RelativePath array

void UaRelativePaths::create

(

OpcUa_UInt32

length

)

Clears the array and resizes to the given length.

Parameters

length

the new length of the array

OpcUa_RelativePath * UaRelativePaths::detach

(

)

Detach from the internal OpcUa_RelativePath 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_RelativePath array

bool UaRelativePaths::operator!=

(

const UaRelativePaths &

other

)

const

Compare two UaRelativePaths.

See also

operator==

Parameters

other

the UaRelativePaths to compare with.

Returns

true if not equal, false otherwise.

UaRelativePaths & UaRelativePaths::operator=

(

const UaRelativePaths &

other

)

Assignment operator.

Parameters

other

the UaRelativePaths to assign.

bool UaRelativePaths::operator==

(

const UaRelativePaths &

other

)

const

Compare two UaRelativePaths.

Parameters

other

the UaRelativePaths to compare with.

Returns

true if equal, false if not.

const OpcUa_RelativePath & UaRelativePaths::operator[]

(

OpcUa_UInt32

index

)

const

Index operator.

Parameters

index

the index of the structure to return.

OpcUa_RelativePath & UaRelativePaths::operator[]

(

OpcUa_UInt32

index

)

Index operator.

Parameters

index

the index of the structure to return.

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