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

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

#include <uaarraytemplates.h>

Public Member Functions

 UaBrowsePathTargets ()
 Constructs an empty instance of the class UaBrowsePathTargets.
 
 UaBrowsePathTargets (const UaBrowsePathTargets &other)
 Constructs an instance of the class BrowsePathTargets with values from another BrowsePathTargets object. More...
 
 UaBrowsePathTargets (OpcUa_Int32 length, OpcUa_BrowsePathTarget *data)
 Constructs an instance of the class UaBrowsePathTarget using a raw OpcUa_BrowsePathTarget array. More...
 
virtual ~UaBrowsePathTargets ()
 Destroys the UaBrowsePathTargets object.
 
UaBrowsePathTargetsoperator= (const UaBrowsePathTargets &other)
 Assignment operator. More...
 
const OpcUa_BrowsePathTargetoperator[] (OpcUa_UInt32 index) const
 Index operator. More...
 
OpcUa_BrowsePathTargetoperator[] (OpcUa_UInt32 index)
 Index operator. More...
 
bool operator== (const UaBrowsePathTargets &other) const
 Compare two UaBrowsePathTargets. More...
 
bool operator!= (const UaBrowsePathTargets &other) const
 Compare two UaBrowsePathTargets. More...
 
void attach (OpcUa_UInt32 length, OpcUa_BrowsePathTarget *data)
 Attach to a raw OpcUa_BrowsePathTarget array. More...
 
void attach (OpcUa_Int32 length, OpcUa_BrowsePathTarget *data)
 Attach to a raw OpcUa_BrowsePathTarget array. More...
 
OpcUa_BrowsePathTargetdetach ()
 Detach from the internal OpcUa_BrowsePathTarget 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_BrowsePathTarget.

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

Constructor & Destructor Documentation

UaBrowsePathTargets::UaBrowsePathTargets ( const UaBrowsePathTargets other)

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

Parameters
otherthe other BrowsePathTargets used to initialize the object
UaBrowsePathTargets::UaBrowsePathTargets ( OpcUa_Int32  length,
OpcUa_BrowsePathTarget data 
)

Constructs an instance of the class UaBrowsePathTarget using a raw OpcUa_BrowsePathTarget array.

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

Member Function Documentation

void UaBrowsePathTargets::attach ( OpcUa_UInt32  length,
OpcUa_BrowsePathTarget data 
)

Attach to a raw OpcUa_BrowsePathTarget array.

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

Attach to a raw OpcUa_BrowsePathTarget array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_BrowsePathTarget * UaBrowsePathTargets::detach ( )

Detach from the internal OpcUa_BrowsePathTarget 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_BrowsePathTarget array
bool UaBrowsePathTargets::operator!= ( const UaBrowsePathTargets other) const

Compare two UaBrowsePathTargets.

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

Assignment operator.

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

Compare two UaBrowsePathTargets.

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

Index operator.

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

Index operator.

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