QOpcUaArgument Class

The OPC UA Argument type. More...

Header:	`#include <QOpcUaArgument>`
CMake:	`find_package(Qt6 REQUIRED COMPONENTS OpcUa)` `target_link_libraries(mytarget PRIVATE Qt6::OpcUa)`
qmake:	`QT += opcua`

List of all members, including inherited members

Public Functions

	QOpcUaArgument()
	QOpcUaArgument(const QString &name, const QString &dataTypeId, qint32 valueRank, const QList<quint32> &arrayDimensions, const QOpcUaLocalizedText &description)
QList<quint32>	arrayDimensions() const
QList<quint32> &	arrayDimensionsRef()
QString	dataTypeId() const
QOpcUaLocalizedText	description() const
QString	name() const
void	setArrayDimensions(const QList<quint32> &arrayDimensions)
void	setDataTypeId(const QString &dataTypeId)
void	setDescription(const QOpcUaLocalizedText &description)
void	setName(const QString &name)
void	setValueRank(qint32 valueRank)
qint32	valueRank() const
QVariant	operator QVariant() const
QOpcUaArgument &	operator=(const QOpcUaArgument &rhs)
bool	operator==(const QOpcUaArgument &other) const

Detailed Description

This is the Qt OPC UA representation for the Argument type defined in OPC UA 1.05 part 3, 8.6.

The Argument type is mainly used for the values of the InputArguments and OutputArguments properties which describe the parameters and return values of method nodes.

Member Function Documentation

QOpcUaArgument::QOpcUaArgument()

Default constructs an argument with no parameters set.

QOpcUaArgument::QOpcUaArgument(const QString &name, const QString &dataTypeId, qint32 valueRank, const QList<quint32> &arrayDimensions, const QOpcUaLocalizedText &description)

Constructs an argument with name name, data type id dataTypeId, value rank valueRank, array dimensions arrayDimensions and description description.

QList<quint32> QOpcUaArgument::arrayDimensions() const

Returns the array dimensions of the argument.

The array dimensions describe the length of each array dimension.

See also setArrayDimensions().

QList<quint32> &QOpcUaArgument::arrayDimensionsRef()

Returns a reference to the array dimensions of the argument.

QString QOpcUaArgument::dataTypeId() const

Returns the data type node id of the argument.

See also setDataTypeId().

QOpcUaLocalizedText QOpcUaArgument::description() const

Returns the description of the argument.

See also setDescription().

QString QOpcUaArgument::name() const

Returns the name of the argument.

See also setName().

void QOpcUaArgument::setArrayDimensions(const QList<quint32> &arrayDimensions)

Sets the array dimensions of the argument to arrayDimensions.

See also arrayDimensions().

void QOpcUaArgument::setDataTypeId(const QString &dataTypeId)

Sets the data type node id of the argument to dataTypeId.

See also dataTypeId().

void QOpcUaArgument::setDescription(const QOpcUaLocalizedText &description)

Sets the description of the argument to description.

See also description().

void QOpcUaArgument::setName(const QString &name)

Sets the name of the argument to name.

See also name().

void QOpcUaArgument::setValueRank(qint32 valueRank)

Sets the value rank of the argument to valueRank.

See also valueRank().

qint32 QOpcUaArgument::valueRank() const

Returns the value rank of the argument. The value rank describes the structure of the value.

ValueRank	Meaning
-3	Scalar or one dimensional array
-2	Scalar or array with any number of dimensions
-1	Not an array
0	Array with one or more dimensions
1	One dimensional array
>1	Array with n dimensions

See also setValueRank().

QVariant QOpcUaArgument::operator QVariant() const

Converts this argument to QVariant.

QOpcUaArgument &QOpcUaArgument::operator=(const QOpcUaArgument &rhs)

Sets the values from rhs in this argument.

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

Returns true if this argument has the same value as other.

Contents