#include <types.hpp>

Inheritance diagram for opcua::NodeId:

Detailed Description

UA_NodeId wrapper class.

See also: https://reference.opcfoundation.org/Core/Part3/v105/docs/8.2

Examples: events/client_eventfilter.cpp, method/server_method_async.cpp, server_accesscontrol.cpp, server_datasource.cpp, and server_valuecallback.cpp.

Definition at line 641 of file types.hpp.

Public Member Functions
	NodeId (NamespaceIndex namespaceIndex, uint32_t identifier) noexcept

	NodeId (NamespaceIndex namespaceIndex, std::string_view identifier)

	NodeId (NamespaceIndex namespaceIndex, Guid identifier) noexcept

	NodeId (NamespaceIndex namespaceIndex, ByteString identifier) noexcept

template<typename T , typename = std::enable_if_t<detail::IsNodeIdEnum<T>::value>>
	NodeId (T identifier) noexcept

bool	isNull () const noexcept

uint32_t	hash () const noexcept

NamespaceIndex	namespaceIndex () const noexcept

NodeIdType	identifierType () const noexcept

template<typename T >
T *	identifierIf () noexcept

template<typename T >
const T *	identifierIf () const noexcept

template<typename T >
T &	identifier ()

template<typename T >
const T &	identifier () const

String	toString () const

constexpr	Wrapper () noexcept=default

constexpr	Wrapper (const Wrapper &other)

constexpr	Wrapper (const T &native)

constexpr	Wrapper (Wrapper &&other) noexcept

constexpr	Wrapper (T &&native) noexcept

Public Member Functions inherited from opcua::Wrapper< T, Handler >
constexpr	Wrapper () noexcept=default

constexpr	Wrapper (const Wrapper &other)

constexpr	Wrapper (const T &native)

constexpr	Wrapper (Wrapper &&other) noexcept

constexpr	Wrapper (T &&native) noexcept

	~Wrapper () noexcept=default

constexpr Wrapper &	operator= (const Wrapper &other)

constexpr Wrapper &	operator= (const T &native)

constexpr Wrapper &	operator= (Wrapper &&other) noexcept

constexpr Wrapper &	operator= (T &&native) noexcept

constexpr	operator T& () noexcept

constexpr	operator const T & () const noexcept

constexpr T *	operator-> () noexcept

constexpr const T *	operator-> () const noexcept

constexpr T *	handle () noexcept

constexpr const T *	handle () const noexcept

constexpr void	swap (Wrapper &other) noexcept

constexpr void	swap (T &native) noexcept

Static Public Member Functions
static NodeId	parse (std::string_view str)

Related Symbols
(Note that these are not member symbols.)
bool	operator== (const UA_NodeId &lhs, const UA_NodeId &rhs) noexcept

bool	operator!= (const UA_NodeId &lhs, const UA_NodeId &rhs) noexcept

bool	operator< (const UA_NodeId &lhs, const UA_NodeId &rhs) noexcept

bool	operator> (const UA_NodeId &lhs, const UA_NodeId &rhs) noexcept

bool	operator<= (const UA_NodeId &lhs, const UA_NodeId &rhs) noexcept

bool	operator>= (const UA_NodeId &lhs, const UA_NodeId &rhs) noexcept

Related Symbols inherited from opcua::Wrapper< T, Handler >
template<typename T >
constexpr T *	asWrapper (typename T::NativeType *native) noexcept

template<typename T >
constexpr const T *	asWrapper (const typename T::NativeType *native) noexcept

template<typename T >
constexpr T &	asWrapper (typename T::NativeType &native) noexcept

template<typename T >
constexpr const T &	asWrapper (const typename T::NativeType &native) noexcept

template<typename T >
constexpr T::NativeType *	asNative (T *wrapper) noexcept

template<typename T >
constexpr const T::NativeType *	asNative (const T *wrapper) noexcept

template<typename T >
constexpr T::NativeType &	asNative (T &wrapper) noexcept

template<typename T >
constexpr const T::NativeType &	asNative (const T &wrapper) noexcept

Additional Inherited Members
Public Types inherited from opcua::Wrapper< T, Handler >
using	NativeType = T

using	HandlerType = Handler

Protected Member Functions inherited from opcua::Wrapper< T, Handler >
constexpr const T &	native () const noexcept

constexpr T &	native () noexcept

constexpr void	clear () noexcept

Constructor & Destructor Documentation

◆ NodeId() [1/5]

opcua::NodeId::NodeId	(	NamespaceIndex	namespaceIndex,
		uint32_t	identifier
	)

inlinenoexcept

Create NodeId with numeric identifier.

Definition at line 646 of file types.hpp.

◆ NodeId() [2/5]

opcua::NodeId::NodeId	(	NamespaceIndex	namespaceIndex,
		std::string_view	identifier
	)

inline

Create NodeId with String identifier.

Definition at line 653 of file types.hpp.

◆ NodeId() [3/5]

opcua::NodeId::NodeId	(	NamespaceIndex	namespaceIndex,
		Guid	identifier
	)

inlinenoexcept

Create NodeId with Guid identifier.

Definition at line 660 of file types.hpp.

◆ NodeId() [4/5]

opcua::NodeId::NodeId	(	NamespaceIndex	namespaceIndex,
		ByteString	identifier
	)

inlinenoexcept

Create NodeId with ByteString identifier.

Definition at line 667 of file types.hpp.

◆ NodeId() [5/5]

template<typename T , typename = std::enable_if_t<detail::IsNodeIdEnum<T>::value>>

opcua::NodeId::NodeId ( T identifier )

inlinenoexcept

Create NodeId from enum class with numeric identifiers like opcua::ObjectId.

The namespace is retrieved by calling e.g. namespaceOf(opcua::ObjectId). Make sure to provide an overload for custom enum types.

Definition at line 679 of file types.hpp.

Member Function Documentation

◆ hash()

uint32_t opcua::NodeId::hash ( ) const

inlinenoexcept

Definition at line 697 of file types.hpp.

◆ identifier() [1/2]

template<typename T >

T & opcua::NodeId::identifier ( )

inline

Get identifier reference.

Template Parameters

T	Requested identifier type, should be either: `uint32_t` for NodeIdType::Numeric `String` for NodeIdType::String `Guid` for NodeIdType::Guid `ByteString` for NodeIdType::ByteString

Returns: Reference to the stored identifier

Exceptions

TypeError If the requested type T doesn't match the stored identifier type

Definition at line 765 of file types.hpp.

Referenced by identifierIf(), NodeId(), NodeId(), NodeId(), NodeId(), and opcua::DataType::setBinaryEncodingId().

◆ identifier() [2/2]

template<typename T >

const T & opcua::NodeId::identifier ( ) const

inline

Get identifier reference.

Template Parameters

T	Requested identifier type, should be either: `uint32_t` for NodeIdType::Numeric `String` for NodeIdType::String `Guid` for NodeIdType::Guid `ByteString` for NodeIdType::ByteString

Returns: Reference to the stored identifier

Exceptions

TypeError If the requested type T doesn't match the stored identifier type

Definition at line 771 of file types.hpp.

◆ identifierIf() [1/2]

template<typename T >

const T * opcua::NodeId::identifierIf ( ) const

inlinenoexcept

Get identifier pointer or nullptr on error.

Template Parameters

T	Requested identifier type, should be either: `uint32_t` for NodeIdType::Numeric `String` for NodeIdType::String `Guid` for NodeIdType::Guid `ByteString` for NodeIdType::ByteString

Returns: Pointer to the stored identifier or a nullptr if T doesn't match the stored identifier type

Definition at line 726 of file types.hpp.

◆ identifierIf() [2/2]

template<typename T >

T * opcua::NodeId::identifierIf ( )

inlinenoexcept

Get identifier pointer or nullptr on error.

Template Parameters

T	Requested identifier type, should be either: `uint32_t` for NodeIdType::Numeric `String` for NodeIdType::String `Guid` for NodeIdType::Guid `ByteString` for NodeIdType::ByteString

Returns: Pointer to the stored identifier or a nullptr if T doesn't match the stored identifier type

Definition at line 720 of file types.hpp.

◆ identifierType()

NodeIdType opcua::NodeId::identifierType ( ) const

inlinenoexcept

Definition at line 705 of file types.hpp.

Referenced by identifierIf().

◆ isNull()

bool opcua::NodeId::isNull ( ) const

inlinenoexcept

Definition at line 693 of file types.hpp.

◆ namespaceIndex()

NamespaceIndex opcua::NodeId::namespaceIndex ( ) const

inlinenoexcept

Definition at line 701 of file types.hpp.

Referenced by NodeId(), NodeId(), NodeId(), and NodeId().

◆ parse()

static NodeId opcua::NodeId::parse ( std::string_view str )

inlinestatic

Parse NodeId from its string representation.

Format: ns=<namespaceindex>;<type>=<value>, e.g. i=13 or ns=10;s=HelloWorld

See also: https://reference.opcfoundation.org/Core/Part6/v104/docs/5.3.1.10

Definition at line 686 of file types.hpp.

◆ toString()

String opcua::NodeId::toString ( ) const

Deprecated:: Use free function opcua::toString(const T&) instead

◆ Wrapper() [1/5]

constexpr opcua::Wrapper< T, Handler >::Wrapper ( )

constexprdefaultnoexcept

◆ Wrapper() [2/5]

constexpr opcua::Wrapper< T, Handler >::Wrapper ( const T & native )

inlineexplicitconstexpr

Copy constructor with native object.

Definition at line 151 of file wrapper.hpp.

◆ Wrapper() [3/5]

constexpr opcua::Wrapper< T, Handler >::Wrapper ( const Wrapper & other )

inlineconstexpr

Copy constructor.

Definition at line 147 of file wrapper.hpp.

◆ Wrapper() [4/5]

constexpr opcua::Wrapper< T, Handler >::Wrapper ( T && native )

inlineconstexprnoexcept

Move constructor with native object.

Definition at line 159 of file wrapper.hpp.

◆ Wrapper() [5/5]

constexpr opcua::Wrapper< T, Handler >::Wrapper ( Wrapper && other )

inlineconstexprnoexcept

Move constructor.

Definition at line 155 of file wrapper.hpp.

Friends And Related Symbol Documentation

◆ operator!=()

bool operator!=	(	const UA_NodeId &	lhs,
		const UA_NodeId &	rhs
	)

◆ operator<()

bool operator<	(	const UA_NodeId &	lhs,
		const UA_NodeId &	rhs
	)

◆ operator<=()

bool operator<=	(	const UA_NodeId &	lhs,
		const UA_NodeId &	rhs
	)

◆ operator==()

bool operator==	(	const UA_NodeId &	lhs,
		const UA_NodeId &	rhs
	)

◆ operator>()

bool operator>	(	const UA_NodeId &	lhs,
		const UA_NodeId &	rhs
	)

◆ operator>=()

bool operator>=	(	const UA_NodeId &	lhs,
		const UA_NodeId &	rhs
	)

Detailed Description

Public Member Functions

Static Public Member Functions

Related Symbols

Additional Inherited Members

Constructor & Destructor Documentation

◆ NodeId() [1/5]

◆ NodeId() [2/5]

◆ NodeId() [3/5]

◆ NodeId() [4/5]

◆ NodeId() [5/5]

Member Function Documentation

◆ hash()

◆ identifier() [1/2]

◆ identifier() [2/2]

◆ identifierIf() [1/2]

◆ identifierIf() [2/2]

◆ identifierType()

◆ isNull()

◆ namespaceIndex()

◆ parse()

◆ toString()

◆ Wrapper() [1/5]

◆ Wrapper() [2/5]

◆ Wrapper() [3/5]

◆ Wrapper() [4/5]

◆ Wrapper() [5/5]

Friends And Related Symbol Documentation

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()