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

#include <uaenumdescription.h>

Public Member Functions
	UaEnumDescriptions ()
	Constructs an empty instance of the class UaEnumDescriptions.

	UaEnumDescriptions (const UaEnumDescriptions &other)
	Constructs an instance of the class UaEnumDescriptions with values from another UaEnumDescriptions object. More...

	UaEnumDescriptions (OpcUa_Int32 length, OpcUa_EnumDescription *data)
	Constructs an instance of the class UaEnumDescriptions using a raw OpcUa_EnumDescription array. More...

virtual	~UaEnumDescriptions ()
	Destroys the UaEnumDescriptions object.

UaEnumDescriptions &	operator= (const UaEnumDescriptions &other)
	Assignment operator. More...

const OpcUa_EnumDescription &	operator[] (OpcUa_UInt32 index) const
	Index operator. More...

OpcUa_EnumDescription &	operator[] (OpcUa_UInt32 index)
	Index operator. More...

bool	operator== (const UaEnumDescriptions &other) const
	Compare two UaEnumDescriptions. More...

bool	operator!= (const UaEnumDescriptions &other) const
	Compare two UaEnumDescriptions. More...

void	attach (OpcUa_UInt32 length, OpcUa_EnumDescription *data)
	Attach to a raw OpcUa_EnumDescription array. More...

void	attach (OpcUa_Int32 length, OpcUa_EnumDescription *data)
	Attach to a raw OpcUa_EnumDescription array. More...

OpcUa_EnumDescription *	detach ()
	Detach from the internal OpcUa_EnumDescription 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_EnumDescription.

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

See also: UaEnumDescription for information about the encapsulated structure.

Constructor & Destructor Documentation

UaEnumDescriptions::UaEnumDescriptions ( const UaEnumDescriptions & other )

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

Parameters

other the other UaEnumDescriptions used to initialize the object

UaEnumDescriptions::UaEnumDescriptions	(	OpcUa_Int32	length,
		OpcUa_EnumDescription *	data
	)

Constructs an instance of the class UaEnumDescriptions using a raw OpcUa_EnumDescription array.

Parameters

length	the length of the raw OpcUa_EnumDescription array
data	the raw OpcUa_EnumDescription array

Member Function Documentation

void UaEnumDescriptions::attach	(	OpcUa_UInt32	length,
		OpcUa_EnumDescription *	data
	)

Attach to a raw OpcUa_EnumDescription array.

Note: Don't manually free the attached data afterwards, because UaEnumDescriptions is responsible for it now.

Parameters

length	the length of the raw OpcUa_EnumDescription array
data	the raw OpcUa_EnumDescription array

void UaEnumDescriptions::attach	(	OpcUa_Int32	length,
		OpcUa_EnumDescription *	data
	)

Attach to a raw OpcUa_EnumDescription array.

Note: Don't manually free the attached data afterwards, because UaEnumDescriptions is responsible for it now.

Parameters

length	the length of the raw OpcUa_EnumDescription array
data	the raw OpcUa_EnumDescription array

void UaEnumDescriptions::create ( OpcUa_UInt32 length )

Clears the array and resizes to the given length.

Parameters

length the new length of the array

OpcUa_EnumDescription * UaEnumDescriptions::detach ( )

Detach from the internal OpcUa_EnumDescription 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_EnumDescription array

bool UaEnumDescriptions::operator!= ( const UaEnumDescriptions & other ) const

Compare two UaEnumDescriptions.

See also: operator==

Parameters

other the UaEnumDescriptions to compare with.

Returns: true if not equal, false otherwise.

UaEnumDescriptions & UaEnumDescriptions::operator= ( const UaEnumDescriptions & other )

Assignment operator.

Parameters

other the UaEnumDescriptions to assign.

bool UaEnumDescriptions::operator== ( const UaEnumDescriptions & other ) const

Compare two UaEnumDescriptions.

Parameters

other the UaEnumDescriptions to compare with.

Returns: true if equal, false if not.

const OpcUa_EnumDescription & UaEnumDescriptions::operator[] ( OpcUa_UInt32 index ) const

Index operator.

Parameters

index the index of the structure to return.

OpcUa_EnumDescription & UaEnumDescriptions::operator[] ( OpcUa_UInt32 index )

Index operator.

Parameters

index the index of the structure to return.

void UaEnumDescriptions::resize ( OpcUa_UInt32 length )

Resizes the array to a given length.

Parameters

length the new length of the array

The documentation for this class was generated from the following files:

C:/work/uasdkcpp/src/uabase/uabasecpp/uaenumdescription.h
C:/work/uasdkcpp/src/uabase/uabasecpp/uaenumdescription.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation