Source code
Revision control
Copy as Markdown
// Copyright (C) 2015 basysKom GmbH, opensource@basyskom.com
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
#include "qopcuarelativepathelement.h"
#include "qopcuaqualifiedname.h"
QT_BEGIN_NAMESPACE
/*!
\class QOpcUaRelativePathElement
\inmodule QtOpcUa
\brief The OPC UA RelativePathElement.
QOpcUaRelativePathElement defines an element of a relative path on an OPC UA server.
This is needed for resolution of browse paths to node ids in \l QOpcUaNode::resolveBrowsePath().
*/
class QOpcUaRelativePathElementData : public QSharedData
{
public:
QString referenceTypeId;
bool isInverse{false};
bool includeSubtypes{false};
QOpcUaQualifiedName targetName;
};
/*!
Constructs a relative path element with both flags set to \c false.
*/
QOpcUaRelativePathElement::QOpcUaRelativePathElement()
: data(new QOpcUaRelativePathElementData())
{
}
/*!
Constructs a relative path element with targetName \a target, reference type node id \a refType and both flags set to \c false.
*/
QOpcUaRelativePathElement::QOpcUaRelativePathElement(const QOpcUaQualifiedName &target, const QString &refType)
: data(new QOpcUaRelativePathElementData())
{
data->referenceTypeId = refType;
data->targetName = target;
}
/*!
Constructs a relative path element with targetName \a target, \l QOpcUa::ReferenceTypeId \a refType and both flags set to \c false.
*/
QOpcUaRelativePathElement::QOpcUaRelativePathElement(const QOpcUaQualifiedName &target, QOpcUa::ReferenceTypeId refType)
: data(new QOpcUaRelativePathElementData())
{
data->referenceTypeId = QOpcUa::nodeIdFromReferenceType(refType);
data->targetName = target;
}
/*!
Constructs a relative path element from \a rhs.
*/
QOpcUaRelativePathElement::QOpcUaRelativePathElement(const QOpcUaRelativePathElement &rhs)
: data(rhs.data)
{
}
/*!
Sets the values of \a rhs in this relative path element.
*/
QOpcUaRelativePathElement &QOpcUaRelativePathElement::operator=(const QOpcUaRelativePathElement &rhs)
{
if (this != &rhs)
data.operator=(rhs.data);
return *this;
}
/*!
\fn bool QOpcUaRelativePathElement::operator==(const QOpcUaRelativePathElement &lhs,
const QOpcUaRelativePathElement &rhs)
Returns \c true if \a lhs has the same value as \a rhs.
*/
bool comparesEqual(const QOpcUaRelativePathElement &lhs,
const QOpcUaRelativePathElement &rhs) noexcept
{
return lhs.includeSubtypes() == rhs.includeSubtypes() &&
lhs.isInverse() == rhs.isInverse() &&
lhs.referenceTypeId() == rhs.referenceTypeId() &&
lhs.targetName() == rhs.targetName();
}
QOpcUaRelativePathElement::~QOpcUaRelativePathElement()
{
}
/*!
Returns the qualified name of the reference's target.
*/
QOpcUaQualifiedName QOpcUaRelativePathElement::targetName() const
{
return data->targetName;
}
/*!
Sets the target name to \a targetName, for example QOpcUaQualifiedName(0, "DataTypes").
*/
void QOpcUaRelativePathElement::setTargetName(const QOpcUaQualifiedName &targetName)
{
data->targetName = targetName;
}
/*!
Returns the value of the includeSubtypes flag.
*/
bool QOpcUaRelativePathElement::includeSubtypes() const
{
return data->includeSubtypes;
}
/*!
Sets the includeSubtypes flag to \a includeSubtypes.
If the flag is \c true, the lookup also follows references with subtypes of \l referenceTypeId().
*/
void QOpcUaRelativePathElement::setIncludeSubtypes(bool includeSubtypes)
{
data->includeSubtypes = includeSubtypes;
}
/*!
\since 6.7
Returns a \l QVariant containing this relative path element.
*/
QOpcUaRelativePathElement::operator QVariant() const
{
return QVariant::fromValue(*this);
}
/*!
Returns the value of the isInverse flag.
*/
bool QOpcUaRelativePathElement::isInverse() const
{
return data->isInverse;
}
/*!
Sets the isInverse flag to \a isInverse.
If the flag is \c true, the lookup follows the reverse reference.
*/
void QOpcUaRelativePathElement::setIsInverse(bool isInverse)
{
data->isInverse = isInverse;
}
/*!
Returns the type id of the reference connecting this node to the previous node.
*/
QString QOpcUaRelativePathElement::referenceTypeId() const
{
return data->referenceTypeId;
}
/*!
Sets the reference type id to \a referenceTypeId.
*/
void QOpcUaRelativePathElement::setReferenceTypeId(const QString &referenceTypeId)
{
data->referenceTypeId = referenceTypeId;
}
/*!
Sets the reference type id to \a referenceTypeId.
*/
void QOpcUaRelativePathElement::setReferenceTypeId(QOpcUa::ReferenceTypeId referenceTypeId)
{
data->referenceTypeId = QOpcUa::nodeIdFromReferenceType(referenceTypeId);
}
/*!
\fn bool QOpcUaRelativePathElement::operator!=(const QOpcUaRelativePathElement &lhs,
const QOpcUaRelativePathElement &rhs)
\since 6.7
Returns \c true if \a lhs has a different value than \a rhs.
*/
QT_END_NAMESPACE