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

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

#include <uapubsubconfigurationdatatype.h>

Public Member Functions

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

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

See also
UaPubSubConfigurationDataType for information about the encapsulated structure.

Constructor & Destructor Documentation

UaPubSubConfigurationDataTypes::UaPubSubConfigurationDataTypes ( const UaPubSubConfigurationDataTypes other)

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

Parameters
otherthe other UaPubSubConfigurationDataTypes used to initialize the object
UaPubSubConfigurationDataTypes::UaPubSubConfigurationDataTypes ( OpcUa_Int32  length,
OpcUa_PubSubConfigurationDataType *  data 
)

Constructs an instance of the class UaPubSubConfigurationDataTypes using a raw OpcUa_PubSubConfigurationDataType array.

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

Member Function Documentation

void UaPubSubConfigurationDataTypes::attach ( OpcUa_UInt32  length,
OpcUa_PubSubConfigurationDataType *  data 
)

Attach to a raw OpcUa_PubSubConfigurationDataType array.

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

Attach to a raw OpcUa_PubSubConfigurationDataType array.

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

Clears the array and resizes to the given length.

Parameters
lengththe new length of the array
OpcUa_PubSubConfigurationDataType * UaPubSubConfigurationDataTypes::detach ( )

Detach from the internal OpcUa_PubSubConfigurationDataType 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_PubSubConfigurationDataType array
bool UaPubSubConfigurationDataTypes::operator!= ( const UaPubSubConfigurationDataTypes other) const

Compare two UaPubSubConfigurationDataTypes.

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

Assignment operator.

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

Compare two UaPubSubConfigurationDataTypes.

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

Index operator.

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

Index operator.

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