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

#include <uahistoryevent.h>

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

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

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

virtual	~UaHistoryEvents ()
	Destroys the UaHistoryEvents object.

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

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

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

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

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

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

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

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

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

See also: UaHistoryEvent for information about the encapsulated structure.

Constructor & Destructor Documentation

UaHistoryEvents::UaHistoryEvents ( const UaHistoryEvents & other )

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

Parameters

other the other UaHistoryEvents used to initialize the object

UaHistoryEvents::UaHistoryEvents	(	OpcUa_Int32	length,
		OpcUa_HistoryEvent *	data
	)

Constructs an instance of the class UaHistoryEvents using a raw OpcUa_HistoryEvent array.

Parameters

length	the length of the raw OpcUa_HistoryEvent array
data	the raw OpcUa_HistoryEvent array

Member Function Documentation

void UaHistoryEvents::attach	(	OpcUa_UInt32	length,
		OpcUa_HistoryEvent *	data
	)

Attach to a raw OpcUa_HistoryEvent array.

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

Parameters

length	the length of the raw OpcUa_HistoryEvent array
data	the raw OpcUa_HistoryEvent array

void UaHistoryEvents::attach	(	OpcUa_Int32	length,
		OpcUa_HistoryEvent *	data
	)

Attach to a raw OpcUa_HistoryEvent array.

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

Parameters

length	the length of the raw OpcUa_HistoryEvent array
data	the raw OpcUa_HistoryEvent array

void UaHistoryEvents::create ( OpcUa_UInt32 length )

Clears the array and resizes to the given length.

Parameters

length the new length of the array

OpcUa_HistoryEvent * UaHistoryEvents::detach ( )

Detach from the internal OpcUa_HistoryEvent 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_HistoryEvent array

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

Compare two UaHistoryEvents.

See also: operator==

Parameters

other the UaHistoryEvents to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaHistoryEvents to assign.

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

Compare two UaHistoryEvents.

Parameters

other the UaHistoryEvents to compare with.

Returns: true if equal, false if not.

const OpcUa_HistoryEvent & UaHistoryEvents::operator[] ( OpcUa_UInt32 index ) const

Index operator.

Parameters

index the index of the structure to return.

OpcUa_HistoryEvent & UaHistoryEvents::operator[] ( OpcUa_UInt32 index )

Index operator.

Parameters

index the index of the structure to return.

void UaHistoryEvents::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/uahistoryevent.h
C:/work/uasdkcpp/src/uabase/uabasecpp/uahistoryevent.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation