UaArgument Class Reference

Wrapper class for the UA stack structure OpcUa_Argument. More...

#include <uaargument.h>

Public Member Functions
	UaArgument ()
	construction
	UaArgument (const UaArgument &other)
	construction
	UaArgument (const OpcUa_Argument &other)
	construction
	UaArgument (const UaString &name, const UaNodeId &dataType, OpcUa_Int32 valueRank, const UaUInt32Array &arrayDimensions, const UaLocalizedText &description)
	construction
	~UaArgument ()
	destruction
void	clear ()
	Clear the data of the UaArgument.
UaArgument &	operator= (const UaArgument &other)
	Assignment operator.
	operator const OpcUa_Argument * () const
	Return internal OpcUa_Argument structure.
OpcUa_Argument *	copy () const
	Copy UaArgument data to a newly allocated OpcUa_Argument.
void	copyTo (OpcUa_Argument *pDst) const
	Copy UaArgument data to an existing OpcUa_Argument structure.
void	detach ()
	Reset OpcUa_Argument structure without clearing the data.
UaString	toString () const
	Converts the UaArgument into a UaString.
void	setArgument (const UaString &name, const UaNodeId &dataType, OpcUa_Int32 valueRank, const UaUInt32Array &arrayDimensions, const UaLocalizedText &description)
	Set an argument.
const OpcUa_String *	name () const
	Get the name as OpcUa_String.
const OpcUa_NodeId *	dataType () const
	Get the DataType for the DataVariable.
OpcUa_Int32	valueRank () const
	Get the ValueRank for the DataVariable.
const OpcUa_LocalizedText *	description () const
	Get the description of the OpcUa_LocalizedText.
UaUInt32Array *	arrayDimensions () const
	Get the array dimensions.

Static Public Member Functions
static OpcUa_Argument *	clone (const OpcUa_Argument &source)
	Copy OpcUa_Argument data to a newly allocated OpcUa_Argument.
static void	cloneTo (const OpcUa_Argument &source, OpcUa_Argument &copy)
	Copy OpcUa_Argument data to an existing OpcUa_Argument structure.

Detailed Description

Wrapper class for the UA stack structure OpcUa_Argument.

Derived from OpcUa_Argument.

Constructor & Destructor Documentation

UaArgument::UaArgument

(

const UaArgument &

other

)

construction

Parameters

other

the UaArgument to assign

UaArgument::UaArgument

(

const OpcUa_Argument &

other

)

construction

Parameters

other

the OpcUa_Argument to assign

UaArgument::UaArgument	(	const UaString &	name,
		const UaNodeId &	dataType,
		OpcUa_Int32	valueRank,
		const UaUInt32Array &	arrayDimensions,
		const UaLocalizedText &	description
	)

construction

Parameters

name	the name as UaString.
dataType	the data type of the actual used data variable.
valueRank	the ValueRank of the DataVariable.
arrayDimensions	the arrayDimensions value for the passed UaUInt32Array.
description	the description as UaLocalizedText.

Member Function Documentation

UaUInt32Array * UaArgument::arrayDimensions

(

)

const

Get the array dimensions.

Returns

Pointer to an UaUInt32Array with the array dimensions.

void UaArgument::clear

(

)

Clear the data of the UaArgument.

OpcUa_Argument * UaArgument::clone ( const OpcUa_Argument &  source )

static

Copy OpcUa_Argument data to a newly allocated OpcUa_Argument.

Parameters

source

the source of this operation.

Returns

a newly allocated OpcUa_Argument.

void UaArgument::cloneTo ( const OpcUa_Argument &  source, OpcUa_Argument &  copy  )

static

Copy OpcUa_Argument data to an existing OpcUa_Argument structure.

Parameters

source	the source of this operation.
copy	an existing OpcUa_Argument structure.

OpcUa_Argument * UaArgument::copy

(

)

const

Copy UaArgument data to a newly allocated OpcUa_Argument.

Returns

a newly allocated OpcUa_Argument.

void UaArgument::copyTo

(

OpcUa_Argument *

pDst

)

const

Copy UaArgument data to an existing OpcUa_Argument structure.

Parameters

pDst	the destination of this operation.

const OpcUa_NodeId* UaArgument::dataType ( ) const

inline

Get the DataType for the DataVariable.

Returns

the DataType for the DataVariable.

const OpcUa_LocalizedText* UaArgument::description ( ) const

inline

Get the description of the OpcUa_LocalizedText.

Returns

the description of the OpcUa_LocalizedText.

void UaArgument::detach

(

)

Reset OpcUa_Argument structure without clearing the data.

const OpcUa_String* UaArgument::name ( ) const

inline

Get the name as OpcUa_String.

Returns

the name as OpcUa_String.

UaArgument::operator const OpcUa_Argument *

(

)

const

Return internal OpcUa_Argument structure.

Returns

internal OpcUa_Argument structure.

UaArgument & UaArgument::operator=

(

const UaArgument &

other

)

Assignment operator.

Parameters

other

the UaArgument to assign.

Returns

Assignment operator.

void UaArgument::setArgument	(	const UaString &	name,
		const UaNodeId &	dataType,
		OpcUa_Int32	valueRank,
		const UaUInt32Array &	arrayDimensions,
		const UaLocalizedText &	description
	)

Set an argument.

Parameters

name	the name of the actual node.
dataType	the data type of the variable.
valueRank	the ValueRank of the DataVariable.
arrayDimensions	the arrayDimensions value for the passed UaUInt32Array.
description	the description as UaLocalizedText.

UaString UaArgument::toString

(

)

const

Converts the UaArgument into a UaString.

Returns

the converted UaArgument.

OpcUa_Int32 UaArgument::valueRank ( ) const

inline

Get the ValueRank for the DataVariable.

Returns

the ValueRank for the DataVariable.

---

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

• /home/buildbot/work/uasdkcpp/src/uabase/uabasecpp/uaargument.h
• /home/buildbot/work/uasdkcpp/src/uabase/uabasecpp/uaargument.cpp