C++ Based OPC UA Client/Server SDK  1.5.5.355

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

#include <uaarraytemplates.h>

Public Member Functions

 UaGuidArray ()
 Constructs an empty instance of the class UaGuidArray.
 
 UaGuidArray (const UaGuidArray &other)
 Constructs an instance of the class GuidArray with values from another GuidArray object. More...
 
 UaGuidArray (OpcUa_Int32 length, OpcUa_Guid *data)
 Constructs an instance of the class UaGuid using a raw OpcUa_Guid array. More...
 
virtual ~UaGuidArray ()
 Destroys the UaGuidArray object.
 
UaGuidArrayoperator= (const UaGuidArray &other)
 Assignment operator. More...
 
const OpcUa_Guidoperator[] (OpcUa_UInt32 index) const
 Index operator. More...
 
OpcUa_Guidoperator[] (OpcUa_UInt32 index)
 Index operator. More...
 
bool operator== (const UaGuidArray &other) const
 Compare two UaGuidArray. More...
 
bool operator!= (const UaGuidArray &other) const
 Compare two UaGuidArray. More...
 
void attach (OpcUa_UInt32 length, OpcUa_Guid *data)
 Attach to a raw OpcUa_Guid array. More...
 
void attach (OpcUa_Int32 length, OpcUa_Guid *data)
 Attach to a raw OpcUa_Guid array. More...
 
OpcUa_Guiddetach ()
 Detach from the internal OpcUa_Guid 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_Guid.

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

See also
UaGuid for information about the encapsulated structure.

Constructor & Destructor Documentation

UaGuidArray::UaGuidArray ( const UaGuidArray other)

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

Parameters
otherthe other GuidArray used to initialize the object
UaGuidArray::UaGuidArray ( OpcUa_Int32  length,
OpcUa_Guid data 
)

Constructs an instance of the class UaGuid using a raw OpcUa_Guid array.

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

Member Function Documentation

void UaGuidArray::attach ( OpcUa_UInt32  length,
OpcUa_Guid data 
)

Attach to a raw OpcUa_Guid array.

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

Attach to a raw OpcUa_Guid array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_Guid * UaGuidArray::detach ( )

Detach from the internal OpcUa_Guid 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_Guid array
bool UaGuidArray::operator!= ( const UaGuidArray other) const

Compare two UaGuidArray.

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

Assignment operator.

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

Compare two UaGuidArray.

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

Index operator.

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

Index operator.

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