C++ Based OPC UA Client/Server SDK  1.5.5.355

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

#include <uaarraytemplates.h>

Public Member Functions

 UaBrowsePaths ()
 Constructs an empty instance of the class UaBrowsePaths.
 
 UaBrowsePaths (const UaBrowsePaths &other)
 Constructs an instance of the class BrowsePaths with values from another BrowsePaths object. More...
 
 UaBrowsePaths (OpcUa_Int32 length, OpcUa_BrowsePath *data)
 Constructs an instance of the class UaBrowsePath using a raw OpcUa_BrowsePath array. More...
 
virtual ~UaBrowsePaths ()
 Destroys the UaBrowsePaths object.
 
UaBrowsePathsoperator= (const UaBrowsePaths &other)
 Assignment operator. More...
 
const OpcUa_BrowsePathoperator[] (OpcUa_UInt32 index) const
 Index operator. More...
 
OpcUa_BrowsePathoperator[] (OpcUa_UInt32 index)
 Index operator. More...
 
bool operator== (const UaBrowsePaths &other) const
 Compare two UaBrowsePaths. More...
 
bool operator!= (const UaBrowsePaths &other) const
 Compare two UaBrowsePaths. More...
 
void attach (OpcUa_UInt32 length, OpcUa_BrowsePath *data)
 Attach to a raw OpcUa_BrowsePath array. More...
 
void attach (OpcUa_Int32 length, OpcUa_BrowsePath *data)
 Attach to a raw OpcUa_BrowsePath array. More...
 
OpcUa_BrowsePathdetach ()
 Detach from the internal OpcUa_BrowsePath 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_BrowsePath.

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

Constructor & Destructor Documentation

UaBrowsePaths::UaBrowsePaths ( const UaBrowsePaths other)

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

Parameters
otherthe other BrowsePaths used to initialize the object
UaBrowsePaths::UaBrowsePaths ( OpcUa_Int32  length,
OpcUa_BrowsePath data 
)

Constructs an instance of the class UaBrowsePath using a raw OpcUa_BrowsePath array.

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

Member Function Documentation

void UaBrowsePaths::attach ( OpcUa_UInt32  length,
OpcUa_BrowsePath data 
)

Attach to a raw OpcUa_BrowsePath array.

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

Attach to a raw OpcUa_BrowsePath array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_BrowsePath * UaBrowsePaths::detach ( )

Detach from the internal OpcUa_BrowsePath 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_BrowsePath array
bool UaBrowsePaths::operator!= ( const UaBrowsePaths other) const

Compare two UaBrowsePaths.

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

Assignment operator.

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

Compare two UaBrowsePaths.

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

Index operator.

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

Index operator.

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