#include <types.hpp>

Inheritance diagram for opcua::ExtensionObject:

Detailed Description

ExtensionObjects may contain scalars of any data type. Even those that are unknown to the receiver. If the received data type is unknown, the encoded string and target NodeId is stored instead of the decoded data.

See also: https://reference.opcfoundation.org/Core/Part6/v105/docs/5.1.6; https://reference.opcfoundation.org/Core/Part6/v105/docs/5.2.2.15

Examples: custom_datatypes/client_custom_datatypes.cpp, and server_accesscontrol.cpp.

Definition at line 1742 of file types.hpp.

Public Member Functions
template<typename T >
	ExtensionObject (T *ptr) noexcept

template<typename T >
	ExtensionObject (T *ptr, const UA_DataType &type) noexcept

template<typename T , typename = std::enable_if_t<!isExtensionObject<T>>>
	ExtensionObject (const T &decoded)

template<typename T , typename = std::enable_if_t<!isExtensionObject<T>>>
	ExtensionObject (const T &decoded, const UA_DataType &type)

bool	empty () const noexcept

bool	isEncoded () const noexcept

bool	isDecoded () const noexcept

ExtensionObjectEncoding	encoding () const noexcept

const NodeId *	encodedTypeId () const noexcept

const ByteString *	encodedBinary () const noexcept

const XmlElement *	encodedXml () const noexcept

const UA_DataType *	decodedType () const noexcept

template<typename T >
T *	decodedData () noexcept

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

void *	decodedData () noexcept

const void *	decodedData () const noexcept

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

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

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

Constructor & Destructor Documentation

◆ ExtensionObject() [1/4]

template<typename T >

opcua::ExtensionObject::ExtensionObject ( T * ptr )

inlineexplicitnoexcept

Create ExtensionObject from a pointer to a decoded object (no copy).

The object will not be deleted when the ExtensionObject is destructed.

Parameters

ptr	Pointer to decoded object (native or wrapper).

Definition at line 1758 of file types.hpp.

◆ ExtensionObject() [2/4]

template<typename T >

opcua::ExtensionObject::ExtensionObject	(	T *	ptr,
		const UA_DataType &	type
	)

inlinenoexcept

Create ExtensionObject from a pointer to a decoded object with a custom data type (no copy).

The object will not be deleted when the ExtensionObject is destructed.

Parameters

ptr	Pointer to decoded object (native or wrapper).
type	Data type of the decoded object.

Definition at line 1768 of file types.hpp.

◆ ExtensionObject() [3/4]

template<typename T , typename = std::enable_if_t<!isExtensionObject<T>>>

opcua::ExtensionObject::ExtensionObject ( const T & decoded )

inlineexplicit

Create ExtensionObject from a decoded object (copy).

Parameters

decoded Decoded object (native or wrapper).

Definition at line 1783 of file types.hpp.

◆ ExtensionObject() [4/4]

template<typename T , typename = std::enable_if_t<!isExtensionObject<T>>>

opcua::ExtensionObject::ExtensionObject	(	const T &	decoded,
		const UA_DataType &	type
	)

inlineexplicit

Create ExtensionObject from a decoded object with a custom data type (copy).

Parameters

decoded	Decoded object (native or wrapper).
type	Data type of the decoded object.

Definition at line 1792 of file types.hpp.

Member Function Documentation

◆ decodedData() [1/4]

template<typename T >

const T * opcua::ExtensionObject::decodedData ( ) const

inlinenoexcept

Get const pointer to the decoded data with given template type.

Returns nullptr if the ExtensionObject is either not decoded or the decoded data is not of type T.

Definition at line 1866 of file types.hpp.

◆ decodedData() [2/4]

const void * opcua::ExtensionObject::decodedData ( ) const

inlinenoexcept

Get pointer to the decoded data.

Returns nullptr if the ExtensionObject is not decoded.

Warning: Type erased version, use with caution.

Definition at line 1882 of file types.hpp.

◆ decodedData() [3/4]

template<typename T >

T * opcua::ExtensionObject::decodedData ( )

inlinenoexcept

Get pointer to the decoded data with given template type.

Returns nullptr if the ExtensionObject is either not decoded or the decoded data is not of type T.

Examples: server_accesscontrol.cpp.

Definition at line 1858 of file types.hpp.

Referenced by decodedData(), and decodedData().

◆ decodedData() [4/4]

void * opcua::ExtensionObject::decodedData ( )

inlinenoexcept

Get pointer to the decoded data.

Returns nullptr if the ExtensionObject is not decoded.

Warning: Type erased version, use with caution.

Definition at line 1873 of file types.hpp.

◆ decodedType()

const UA_DataType * opcua::ExtensionObject::decodedType ( ) const

inlinenoexcept

Get the decoded data type.

Returns nullptr if ExtensionObject is not decoded.

Definition at line 1848 of file types.hpp.

◆ empty()

bool opcua::ExtensionObject::empty ( ) const

inlinenoexcept

Check if the ExtensionObject is empty.

Definition at line 1801 of file types.hpp.

◆ encodedBinary()

const ByteString * opcua::ExtensionObject::encodedBinary ( ) const

inlinenoexcept

Get the encoded body in binary format.

Returns nullptr if ExtensionObject is not encoded in binary format.

Definition at line 1832 of file types.hpp.

◆ encodedTypeId()

const NodeId * opcua::ExtensionObject::encodedTypeId ( ) const

inlinenoexcept

Get the encoded type id.

Returns nullptr if ExtensionObject is not encoded.

Definition at line 1824 of file types.hpp.

◆ encodedXml()

const XmlElement * opcua::ExtensionObject::encodedXml ( ) const

inlinenoexcept

Get the encoded body in XML format.

Returns nullptr if ExtensionObject is not encoded in XML format.

Definition at line 1840 of file types.hpp.

◆ encoding()

ExtensionObjectEncoding opcua::ExtensionObject::encoding ( ) const

inlinenoexcept

Get the encoding.

Definition at line 1818 of file types.hpp.

Referenced by empty(), isDecoded(), and isEncoded().

◆ isDecoded()

bool opcua::ExtensionObject::isDecoded ( ) const

inlinenoexcept

Check if the ExtensionObject is decoded.

Definition at line 1812 of file types.hpp.

Referenced by decodedData(), decodedData(), and decodedType().

◆ isEncoded()

bool opcua::ExtensionObject::isEncoded ( ) const

inlinenoexcept

Check if the ExtensionObject is encoded (usually if the data type is unknown).

Definition at line 1806 of file types.hpp.

Referenced by encodedTypeId().

◆ 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.

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ ExtensionObject() [1/4]

◆ ExtensionObject() [2/4]

◆ ExtensionObject() [3/4]

◆ ExtensionObject() [4/4]

Member Function Documentation

◆ decodedData() [1/4]

◆ decodedData() [2/4]

◆ decodedData() [3/4]

◆ decodedData() [4/4]

◆ decodedType()

◆ empty()

◆ encodedBinary()

◆ encodedTypeId()

◆ encodedXml()

◆ encoding()

◆ isDecoded()

◆ isEncoded()

◆ Wrapper() [1/5]

◆ Wrapper() [2/5]

◆ Wrapper() [3/5]

◆ Wrapper() [4/5]

◆ Wrapper() [5/5]