C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
UaAggregateConfigurations Class Reference

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

#include <uaaggregateconfiguration.h>

Public Member Functions

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

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

See also
UaAggregateConfiguration for information about the encapsulated structure.

Constructor & Destructor Documentation

UaAggregateConfigurations::UaAggregateConfigurations ( const UaAggregateConfigurations other)

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

Parameters
otherthe other UaAggregateConfigurations used to initialize the object
UaAggregateConfigurations::UaAggregateConfigurations ( OpcUa_Int32  length,
OpcUa_AggregateConfiguration data 
)

Constructs an instance of the class UaAggregateConfigurations using a raw OpcUa_AggregateConfiguration array.

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

Member Function Documentation

void UaAggregateConfigurations::attach ( OpcUa_UInt32  length,
OpcUa_AggregateConfiguration data 
)

Attach to a raw OpcUa_AggregateConfiguration array.

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

Attach to a raw OpcUa_AggregateConfiguration array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_AggregateConfiguration * UaAggregateConfigurations::detach ( )

Detach from the internal OpcUa_AggregateConfiguration 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_AggregateConfiguration array
bool UaAggregateConfigurations::operator!= ( const UaAggregateConfigurations other) const

Compare two UaAggregateConfigurations.

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

Assignment operator.

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

Compare two UaAggregateConfigurations.

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

Index operator.

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

Index operator.

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