C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537

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

#include <uaarraytemplates.h>

Public Member Functions

 UaBrowsePathResults ()
 Constructs an empty instance of the class UaBrowsePathResults.
 
 UaBrowsePathResults (const UaBrowsePathResults &other)
 Constructs an instance of the class BrowsePathResults with values from another BrowsePathResults object. More...
 
 UaBrowsePathResults (OpcUa_Int32 length, OpcUa_BrowsePathResult *data)
 Constructs an instance of the class UaBrowsePathResult using a raw OpcUa_BrowsePathResult array. More...
 
virtual ~UaBrowsePathResults ()
 Destroys the UaBrowsePathResults object.
 
UaBrowsePathResultsoperator= (const UaBrowsePathResults &other)
 Assignment operator. More...
 
const OpcUa_BrowsePathResultoperator[] (OpcUa_UInt32 index) const
 Index operator. More...
 
OpcUa_BrowsePathResultoperator[] (OpcUa_UInt32 index)
 Index operator. More...
 
bool operator== (const UaBrowsePathResults &other) const
 Compare two UaBrowsePathResults. More...
 
bool operator!= (const UaBrowsePathResults &other) const
 Compare two UaBrowsePathResults. More...
 
void attach (OpcUa_UInt32 length, OpcUa_BrowsePathResult *data)
 Attach to a raw OpcUa_BrowsePathResult array. More...
 
void attach (OpcUa_Int32 length, OpcUa_BrowsePathResult *data)
 Attach to a raw OpcUa_BrowsePathResult array. More...
 
OpcUa_BrowsePathResultdetach ()
 Detach from the internal OpcUa_BrowsePathResult 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_BrowsePathResult.

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

Constructor & Destructor Documentation

UaBrowsePathResults::UaBrowsePathResults ( const UaBrowsePathResults other)

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

Parameters
otherthe other BrowsePathResults used to initialize the object
UaBrowsePathResults::UaBrowsePathResults ( OpcUa_Int32  length,
OpcUa_BrowsePathResult data 
)

Constructs an instance of the class UaBrowsePathResult using a raw OpcUa_BrowsePathResult array.

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

Member Function Documentation

void UaBrowsePathResults::attach ( OpcUa_UInt32  length,
OpcUa_BrowsePathResult data 
)

Attach to a raw OpcUa_BrowsePathResult array.

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

Attach to a raw OpcUa_BrowsePathResult array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_BrowsePathResult * UaBrowsePathResults::detach ( )

Detach from the internal OpcUa_BrowsePathResult 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_BrowsePathResult array
bool UaBrowsePathResults::operator!= ( const UaBrowsePathResults other) const

Compare two UaBrowsePathResults.

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

Assignment operator.

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

Compare two UaBrowsePathResults.

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

Index operator.

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

Index operator.

Parameters
indexthe index of the structure to return.
void UaBrowsePathResults::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: