C++ Based OPC UA Client/Server SDK  1.5.5.355

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

#include <uaarraytemplates.h>

Public Member Functions

 UaRelativePathElements ()
 Constructs an empty instance of the class UaRelativePathElements.
 
 UaRelativePathElements (const UaRelativePathElements &other)
 Constructs an instance of the class RelativePathElements with values from another RelativePathElements object. More...
 
 UaRelativePathElements (OpcUa_Int32 length, OpcUa_RelativePathElement *data)
 Constructs an instance of the class UaRelativePathElement using a raw OpcUa_RelativePathElement array. More...
 
virtual ~UaRelativePathElements ()
 Destroys the UaRelativePathElements object.
 
UaRelativePathElementsoperator= (const UaRelativePathElements &other)
 Assignment operator. More...
 
const OpcUa_RelativePathElementoperator[] (OpcUa_UInt32 index) const
 Index operator. More...
 
OpcUa_RelativePathElementoperator[] (OpcUa_UInt32 index)
 Index operator. More...
 
bool operator== (const UaRelativePathElements &other) const
 Compare two UaRelativePathElements. More...
 
bool operator!= (const UaRelativePathElements &other) const
 Compare two UaRelativePathElements. More...
 
void attach (OpcUa_UInt32 length, OpcUa_RelativePathElement *data)
 Attach to a raw OpcUa_RelativePathElement array. More...
 
void attach (OpcUa_Int32 length, OpcUa_RelativePathElement *data)
 Attach to a raw OpcUa_RelativePathElement array. More...
 
OpcUa_RelativePathElementdetach ()
 Detach from the internal OpcUa_RelativePathElement 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_RelativePathElement.

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

Constructor & Destructor Documentation

UaRelativePathElements::UaRelativePathElements ( const UaRelativePathElements other)

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

Parameters
otherthe other RelativePathElements used to initialize the object
UaRelativePathElements::UaRelativePathElements ( OpcUa_Int32  length,
OpcUa_RelativePathElement data 
)

Constructs an instance of the class UaRelativePathElement using a raw OpcUa_RelativePathElement array.

Parameters
lengththe length of the raw OpcUa_RelativePathElement array
datathe raw OpcUa_RelativePathElement array

Member Function Documentation

void UaRelativePathElements::attach ( OpcUa_UInt32  length,
OpcUa_RelativePathElement data 
)

Attach to a raw OpcUa_RelativePathElement array.

Note
Don't manually free the attached data afterwards, because UaRelativePathElements is responsible for it now.
Parameters
lengththe length of the raw OpcUa_RelativePathElement array
datathe raw OpcUa_RelativePathElement array
void UaRelativePathElements::attach ( OpcUa_Int32  length,
OpcUa_RelativePathElement data 
)

Attach to a raw OpcUa_RelativePathElement array.

Note
Don't manually free the attached data afterwards, because UaRelativePathElements is responsible for it now.
Parameters
lengththe length of the raw OpcUa_RelativePathElement array
datathe raw OpcUa_RelativePathElement array
void UaRelativePathElements::create ( OpcUa_UInt32  length)

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_RelativePathElement * UaRelativePathElements::detach ( )

Detach from the internal OpcUa_RelativePathElement 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_RelativePathElement array
bool UaRelativePathElements::operator!= ( const UaRelativePathElements other) const

Compare two UaRelativePathElements.

See also
operator==
Parameters
otherthe UaRelativePathElements to compare with.
Returns
true if not equal, false otherwise.
UaRelativePathElements & UaRelativePathElements::operator= ( const UaRelativePathElements other)

Assignment operator.

Parameters
otherthe UaRelativePathElements to assign.
bool UaRelativePathElements::operator== ( const UaRelativePathElements other) const

Compare two UaRelativePathElements.

Parameters
otherthe UaRelativePathElements to compare with.
Returns
true if equal, false if not.
const OpcUa_RelativePathElement & UaRelativePathElements::operator[] ( OpcUa_UInt32  index) const

Index operator.

Parameters
indexthe index of the structure to return.
OpcUa_RelativePathElement & UaRelativePathElements::operator[] ( OpcUa_UInt32  index)

Index operator.

Parameters
indexthe index of the structure to return.
void UaRelativePathElements::resize ( OpcUa_UInt32  length)

Resizes the array to a given length.

Parameters
lengththe new length of the array

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