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

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

#include <uaoptionset.h>

Public Member Functions

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

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

See also
UaOptionSet for information about the encapsulated structure.

Constructor & Destructor Documentation

UaOptionSets::UaOptionSets ( const UaOptionSets other)

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

Parameters
otherthe other UaOptionSets used to initialize the object
UaOptionSets::UaOptionSets ( OpcUa_Int32  length,
OpcUa_OptionSet data 
)

Constructs an instance of the class UaOptionSets using a raw OpcUa_OptionSet array.

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

Member Function Documentation

void UaOptionSets::attach ( OpcUa_UInt32  length,
OpcUa_OptionSet data 
)

Attach to a raw OpcUa_OptionSet array.

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

Attach to a raw OpcUa_OptionSet array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_OptionSet * UaOptionSets::detach ( )

Detach from the internal OpcUa_OptionSet 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_OptionSet array
bool UaOptionSets::operator!= ( const UaOptionSets other) const

Compare two UaOptionSets.

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

Assignment operator.

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

Compare two UaOptionSets.

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

Index operator.

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

Index operator.

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