opcua Namespace Reference

Namespaces
namespace	services
namespace	ua

Classes
class	AccessControlBase
class	AccessControlDefault
class	AddNodesItem
class	AddNodesRequest
class	AddNodesResponse
class	AddNodesResult
class	AddReferencesItem
class	AddReferencesRequest
class	AddReferencesResponse
class	AggregateFilter
class	AnonymousIdentityToken
class	ApplicationDescription
class	Argument
struct	AsyncResult
struct	AsyncResult< services::detail::HookToken< HookFunction, CompletionToken >, T >
struct	AsyncResult< services::detail::TransformToken< TransformFunction, CompletionToken >, T >
struct	AsyncResult< UseDeferredToken, T >
struct	AsyncResult< UseDetachedToken, T >
struct	AsyncResult< UseFutureToken, T >
class	AttributeOperand
class	AxisInformation
class	BadDisconnect
class	BadResult
class	BadStatus
class	BadVariantAccess
class	Bitmask
class	BrowseDescription
class	BrowseNextRequest
class	BrowseNextResponse
class	BrowsePath
class	BrowsePathResult
class	BrowsePathTarget
class	BrowseRequest
class	BrowseResponse
class	BrowseResult
class	BuildInfo
class	ByteString
class	CallMethodRequest
class	CallMethodResult
class	CallRequest
class	CallResponse
class	Client
class	ClientConfig
class	ComplexNumberType
class	ContentFilter
class	ContentFilterElement
class	CreateCertificateError
struct	CreateCertificateResult
class	CreateMonitoredItemsRequest
class	CreateMonitoredItemsResponse
class	CreateSubscriptionRequest
class	CreateSubscriptionResponse
class	DataChangeFilter
class	DataSourceBase
class	DataType
class	DataTypeAttributes
class	DataTypeBuilder
class	DataTypeMember
class	DataValue
class	DateTime
class	DeleteMonitoredItemsRequest
class	DeleteMonitoredItemsResponse
class	DeleteNodesItem
class	DeleteNodesRequest
class	DeleteNodesResponse
class	DeleteReferencesItem
class	DeleteReferencesRequest
class	DeleteReferencesResponse
class	DeleteSubscriptionsRequest
class	DeleteSubscriptionsResponse
class	DiagnosticInfo
class	DoubleComplexNumberType
class	ElementOperand
class	EndpointDescription
class	EnumDefinition
class	EnumField
class	EnumValueType
class	EUInformation
class	Event
class	EventFilter
class	ExpandedNodeId
class	ExtensionObject
class	Guid
struct	IsBitmaskEnum
struct	IsBitmaskEnum< AccessLevel >
struct	IsBitmaskEnum< EventNotifier >
struct	IsBitmaskEnum< NodeClass >
struct	IsBitmaskEnum< WriteMask >
class	IssuedIdentityToken
class	LiteralOperand
class	LocalizedText
class	LoggerBase
class	LoggerDefault
struct	Login
class	MethodAttributes
class	ModifyMonitoredItemsRequest
class	ModifyMonitoredItemsResponse
class	ModifySubscriptionRequest
class	ModifySubscriptionResponse
class	MonitoredItem
class	MonitoredItemCreateRequest
class	MonitoredItemCreateResult
class	MonitoredItemModifyRequest
class	MonitoredItemModifyResult
class	MonitoringParameters
struct	Namespace
class	Node
class	NodeAttributes
class	NodeId
class	NumericRange
class	ObjectAttributes
class	ObjectTypeAttributes
class	PluginAdapter
class	QualifiedName
class	Range
class	ReadRequest
class	ReadResponse
class	ReadValueId
class	ReferenceDescription
class	ReferenceTypeAttributes
class	RegisterNodesRequest
class	RegisterNodesResponse
class	RelativePath
class	RelativePathElement
class	RequestHeader
class	ResponseHeader
class	Result
class	Result< void >
class	Server
class	ServerConfig
class	Session
class	SetMonitoringModeRequest
class	SetMonitoringModeResponse
class	SetPublishingModeRequest
class	SetPublishingModeResponse
class	SetTriggeringRequest
class	SetTriggeringResponse
class	SimpleAttributeOperand
class	Span
class	StatusChangeNotification
class	StatusCode
class	String
class	StructureDefinition
class	StructureField
class	Subscription
class	TranslateBrowsePathsToNodeIdsRequest
class	TranslateBrowsePathsToNodeIdsResponse
struct	TypeConverter
struct	TypeConverter< char[N]>
struct	TypeConverter< const char * >
struct	TypeConverter< std::basic_string< char, Traits, Allocator > >
struct	TypeConverter< std::basic_string_view< char, Traits > >
struct	TypeConverter< std::chrono::time_point< Clock, Duration > >
class	TypeError
struct	TypeRegistry
struct	TypeRegistry< T, std::enable_if_t< detail::IsTypeWrapper< T >::value > >
class	TypeWrapper
class	UnregisterNodesRequest
class	UnregisterNodesResponse
struct	UseDeferredToken
struct	UseDetachedToken
struct	UseFutureToken
class	UserIdentityToken
class	UserNameIdentityToken
class	UserTokenPolicy
class	ValueCallbackBase
class	VariableAttributes
class	VariableTypeAttributes
class	Variant
class	ViewAttributes
class	ViewDescription
class	Wrapper
class	WriteRequest
class	WriteResponse
class	WriteValue
class	X509IdentityToken
class	XmlElement
class	XVType

Typedefs
using	DefaultCompletionToken = UseFutureToken
using	StateCallback = std::function< void()>
using	InactivityCallback = std::function< void()>
using	SubscriptionInactivityCallback = std::function< void(IntegerId subscriptionId)>
using	NamespaceIndex = uint16_t
using	TypeIndex = uint16_t
using	MonitoringParametersEx = services::MonitoringParametersEx
using	LogFunction = std::function< void(LogLevel, LogCategory, std::string_view msg)>
using	Logger = LogFunction
using	SubscriptionParameters = services::SubscriptionParameters
using	DataChangeNotificationCallback = services::DataChangeNotificationCallback
using	EventNotificationCallback = services::EventNotificationCallback
using	NumericRangeDimension = UA_NumericRangeDimension
using	IntegerId = uint32_t
using	FilterOperand = std::variant< ElementOperand, LiteralOperand, AttributeOperand, SimpleAttributeOperand, ExtensionObject >
using	AggregateConfiguration = UA_AggregateConfiguration

Enumerations
enum class	AttributeId : int32_t
enum class	NodeClass : int32_t
enum class	AccessLevel : uint8_t
enum class	WriteMask : uint32_t
enum class	ValueRank : int32_t
enum class	EventNotifier : uint8_t
enum class	ModellingRule : uint16_t
enum class	CertificateFormat
enum class	LogLevel
enum class	LogCategory
enum class	NodeIdType : uint8_t
enum class	VariantPolicy
enum class	ExtensionObjectEncoding
enum class	DataTypeId : int32_t
enum class	ReferenceTypeId : int32_t
enum class	ObjectTypeId : int32_t
enum class	VariableTypeId : int32_t
enum class	ObjectId : int32_t
enum class	VariableId : int32_t
enum class	MethodId : int32_t
enum class	ApplicationType : int32_t
enum class	MessageSecurityMode : int32_t
enum class	UserTokenType : int32_t
enum class	NodeAttributesMask : uint32_t
enum class	BrowseDirection : int32_t
enum class	BrowseResultMask : uint32_t
enum class	TimestampsToReturn : int32_t
enum class	MonitoringMode : int32_t
enum class	FilterOperator : int32_t
enum class	DataChangeTrigger : int32_t
enum class	DeadbandType : int32_t
enum class	PerformUpdateType : int32_t
enum class	AxisScaleEnumeration : int32_t
enum class	StructureType : int32_t

Functions
template<typename T , typename Initiation , typename CompletionToken , typename... Args>
auto	asyncInitiate (Initiation &&initiation, CompletionToken &&token, Args &&... args)
template<typename T >
constexpr std::false_type	isBitmaskEnum (T)
constexpr void	throwIfBad (UA_StatusCode code)
CreateCertificateResult	createCertificate (Span< const String > subject, Span< const String > subjectAltName, CertificateFormat certificateFormat=CertificateFormat::DER)
StatusCode	loadNodeset (Server &server, std::string_view nodeset2XmlFilePath)
template<typename T >
const UA_DataType &	getDataType () noexcept
String	toString (const NumericRange &range)
constexpr Namespace	namespaceOf (DataTypeId) noexcept
constexpr Namespace	namespaceOf (ReferenceTypeId) noexcept
constexpr Namespace	namespaceOf (ObjectTypeId) noexcept
constexpr Namespace	namespaceOf (VariableTypeId) noexcept
constexpr Namespace	namespaceOf (ObjectId) noexcept
constexpr Namespace	namespaceOf (VariableId) noexcept
constexpr Namespace	namespaceOf (MethodId) noexcept
constexpr std::true_type	isBitmaskEnum (NodeAttributesMask)
constexpr std::true_type	isBitmaskEnum (BrowseResultMask)
ContentFilter	operator&& (const ContentFilterElement &lhs, const ContentFilter &rhs)
ContentFilter	operator&& (const ContentFilter &lhs, const ContentFilterElement &rhs)
ContentFilter	operator|| (const ContentFilterElement &lhs, const ContentFilter &rhs)
ContentFilter	operator|| (const ContentFilter &lhs, const ContentFilterElement &rhs)

Variables
constexpr UseFutureToken	useFuture
constexpr UseDeferredToken	useDeferred
constexpr UseDetachedToken	useDetached

Typedef Documentation

StateCallback

using opcua::StateCallback = typedef std::function<void()>

Definition at line 105 of file client.hpp.

InactivityCallback

using opcua::InactivityCallback = typedef std::function<void()>

Definition at line 106 of file client.hpp.

SubscriptionInactivityCallback

using opcua::SubscriptionInactivityCallback = typedef std::function<void(IntegerId subscriptionId)>

Definition at line 107 of file client.hpp.

NamespaceIndex

using opcua::NamespaceIndex = typedef uint16_t

Namespace index.

See also

https://reference.opcfoundation.org/Core/Part3/v105/docs/8.2.2

Definition at line 12 of file common.hpp.

TypeIndex

using opcua::TypeIndex = typedef uint16_t

Type index of the UA_TYPES array.

Definition at line 21 of file common.hpp.

MonitoringParametersEx

typedef services::MonitoringParametersEx opcua::MonitoringParametersEx

Definition at line 17 of file monitoreditem.hpp.

LogFunction

using opcua::LogFunction = typedef std::function<void(LogLevel, LogCategory, std::string_view msg)>

Log function.

Definition at line 11 of file log_default.hpp.

Logger

using opcua::Logger = typedef LogFunction

Definition at line 13 of file log_default.hpp.

SubscriptionParameters

using opcua::SubscriptionParameters = typedef services::SubscriptionParameters

Definition at line 21 of file subscription.hpp.

DataChangeNotificationCallback

using opcua::DataChangeNotificationCallback = typedef services::DataChangeNotificationCallback

Definition at line 23 of file subscription.hpp.

EventNotificationCallback

using opcua::EventNotificationCallback = typedef services::EventNotificationCallback

Definition at line 24 of file subscription.hpp.

NumericRangeDimension

using opcua::NumericRangeDimension = typedef UA_NumericRangeDimension

Definition at line 2432 of file types.hpp.

Enumeration Type Documentation

AttributeId

enum class opcua::AttributeId : int32_t

strong

Attribute identifiers.

See also

UA_AttributeId

https://reference.opcfoundation.org/Core/Part3/v105/docs/5.9

Enumerator
NodeId	Unambiguous identifier of a node.
NodeClass	Identifies the class of the node.
BrowseName	A non-localised human-readable name used to browse the address space. The browse name of a reference type must be unique in a server.
DisplayName	The localized name of the node.
Description	Explains the meaning of the node in a localized text.
WriteMask	Exposes the possibilities of a client to write the attributes of the node.
UserWriteMask	Exposes the possibilities of a client to write the attributes of the node. In contrast to the write mask, the user write mask is taking access rights into account.
IsAbstract	If a reference is abstract, no reference of this type shall exist, only of its subtypes.
Symmetric	If a reference is symmetric, it can seen from both the source and target node.
InverseName	The inverse name describes the reference type as seen from the target node. For example, the reference type HasSubtype has the inverse name HasSupertype.
ContainsNoLoops	Indicates that by following the references in the context of the view there are no loops.
EventNotifier	Indicates if the node can be used to subscribe to events or the read/write historic events.
Value	The most recent value of the variable that the server has.
DataType	The NodeId of the data type definition for the Value attribute.
ValueRank	Indicates whether the Value attribute of the variable node is an array and how many dimensions the array has. See also ValueRank
ArrayDimensions	Specifies the maximum supported length of each dimension of the Value attribute. Should be unspecified if ValueRank <= 0 (ValueRank::Any, ValueRank::Scalar, ValueRank::ScalarOrOneDimension, ValueRank::OneOrMoreDimensions). The dimension 0 is a wildcard and the actual value may have any length in this dimension.
AccessLevel	Indicate how the value of a variable can be accessed (read/write) and if it contains current and/or historic data.
UserAccessLevel	Indicates how the value of a variable can be accessed (read/write) and if it contains current and/or historic data. In contrast to the AccessLevel, the UserAccessLevel is taking access rights into account.
MinimumSamplingInterval	Specifies (in milliseconds) how fast the server can reasonably sample the value for changes. A minimum sampling interval of 0 indicates that the server is to monitor the item continuously. A minimum sampling interval of -1 means indeterminate.
Historizing	Indicates whether the server is actively collecting data for the history of the variable.
Executable	Indicates if the method is currently executable.
UserExecutable	Indicates if the method is currently executable taking user access rights into account.
DataTypeDefinition	Provides the meta data and encoding information for custom data types. See also https://reference.opcfoundation.org/Core/Part3/v105/docs/5.8.3
RolePermissions	Permissions that apply to a node. See also https://reference.opcfoundation.org/Core/Part3/v105/docs/5.2.9
UserRolePermissions	Specifies the permissions that apply to a node for all roles granted to current session. See also https://reference.opcfoundation.org/Core/Part3/v105/docs/5.2.10
AccessRestrictions	Specifies access restrictions that apply to a node. See also https://reference.opcfoundation.org/Core/Part3/v105/docs/5.2.11
AccessLevelEx	Extended version of the AccessLevel attribute. See also https://reference.opcfoundation.org/Core/Part3/v104/docs/8.58

Definition at line 28 of file common.hpp.

NodeClass

enum class opcua::NodeClass : int32_t

strong

Node class.

The enum can be used as a bitmask and allows bitwise operations, e.g.:

auto mask = NodeClass::Object | NodeClass::Variable;

See also

UA_NodeClass

https://reference.opcfoundation.org/Core/Part3/v105/docs/8.29

Enumerator
Unspecified
Object
Variable
Method
ObjectType
VariableType
ReferenceType
DataType
View

Definition at line 71 of file common.hpp.

AccessLevel

enum class opcua::AccessLevel : uint8_t

strong

Access level.

Indicates how the value of an variable can be accessed (read/write) and if it contains current and/or historic data.

See also

https://reference.opcfoundation.org/Core/Part3/v104/docs/8.57

Enumerator
None
CurrentRead
CurrentWrite
HistoryRead
HistoryWrite
SemanticChange
StatusWrite
TimestampWrite

Definition at line 94 of file common.hpp.

WriteMask

enum class opcua::WriteMask : uint32_t

strong

Write mask.

Indicates which attributes of a node a writeable.

See also

https://reference.opcfoundation.org/Core/Part3/v105/docs/5.2.7

https://reference.opcfoundation.org/Core/Part3/v105/docs/8.60

Enumerator
None
AccessLevel
ArrayDimensions
BrowseName
ContainsNoLoops
DataType
Description
DisplayName
EventNotifier
Executable
Historizing
InverseName
IsAbstract
MinimumSamplingInterval
NodeClass
NodeId
Symmetric
UserAccessLevel
UserExecutable
UserWriteMask
ValueRank
WriteMask
ValueForVariableType
DataTypeDefinition
RolePermissions
AccessRestrictions
AccessLevelEx

Definition at line 116 of file common.hpp.

ValueRank

enum class opcua::ValueRank : int32_t

strong

Value rank.

Indicates whether the value attribute of the variable is an array and how many dimensions the array has.

See also

https://reference.opcfoundation.org/Core/Part3/v105/docs/5.6.2

Enumerator
ScalarOrOneDimension
Any
Scalar
OneOrMoreDimensions
OneDimension
TwoDimensions
ThreeDimensions

Definition at line 157 of file common.hpp.

EventNotifier

enum class opcua::EventNotifier : uint8_t

strong

Event notifier.

Indicates if a node can be used to subscribe to events or read/write historic events.

See also

https://reference.opcfoundation.org/Core/Part3/v105/docs/8.59

Enumerator
None
SubscribeToEvents
HistoryRead
HistoryWrite

Definition at line 174 of file common.hpp.

ModellingRule

enum class opcua::ModellingRule : uint16_t

strong

Modelling rules.

See also

https://reference.opcfoundation.org/Core/Part3/v105/docs/6.4.4

Enumerator
Mandatory
Optional
ExposesItsArray
OptionalPlaceholder
MandatoryPlaceholder

Definition at line 190 of file common.hpp.

CertificateFormat

enum class opcua::CertificateFormat

strong

Enumerator
DER
PEM

Definition at line 11 of file create_certificate.hpp.

LogLevel

enum class opcua::LogLevel

strong

Log level.

See also

UA_LogLevel

Enumerator
Trace
Debug
Info
Warning
Error
Fatal

Definition at line 14 of file log.hpp.

LogCategory

enum class opcua::LogCategory

strong

Log category.

See also

UA_LogCategory

Enumerator
Network
SecureChannel
Session
Server
Client
Userland
SecurityPolicy

Definition at line 27 of file log.hpp.

NodeIdType

enum class opcua::NodeIdType : uint8_t

strong

NodeId types.

See also

UA_NodeIdType

Enumerator
Numeric
String
Guid
ByteString

Definition at line 653 of file types.hpp.

VariantPolicy

enum class opcua::VariantPolicy

strong

Policies for variant factory methods Variant::fromScalar, Variant::fromArray.

Enumerator
Copy	Store copy of scalar/array inside the variant.
Reference	Store reference to scalar/array inside the variant. Both scalars and arrays must be mutable native/wrapper types. Arrays must store the elements contiguously in memory.

Definition at line 1124 of file types.hpp.

ExtensionObjectEncoding

enum class opcua::ExtensionObjectEncoding

strong

Extension object encoding.

See also

UA_ExtensionObjectEncoding

Enumerator
EncodedNoBody
EncodedByteString
EncodedXml
Decoded
DecodedNoDelete

Definition at line 2073 of file types.hpp.

Function Documentation

throwIfBad()

constexpr void opcua::throwIfBad ( UA_StatusCode  code )

constexpr

Check the status code and throw a BadStatus exception if the status code is bad.

Definition at line 85 of file exception.hpp.

Referenced by opcua::services::createMonitoredItemsDataChangeAsync(), opcua::services::createMonitoredItemsEventAsync(), opcua::services::deleteMonitoredItemsAsync(), opcua::services::deleteSubscriptionsAsync(), opcua::services::modifyMonitoredItemsAsync(), opcua::services::modifySubscriptionAsync(), opcua::Guid::parse(), opcua::NodeId::parse(), opcua::ExpandedNodeId::parse(), opcua::StatusCode::throwIfBad(), and opcua::TypeWrapper< T, Index >::toString().

createCertificate()

CreateCertificateResult opcua::createCertificate	(	Span< const String >	subject,
		Span< const String >	subjectAltName,
		CertificateFormat	certificateFormat = CertificateFormat::DER
	)

Create a self-signed X.509 v3 certificate.

It is recommended to store the generated certificate on disk for reuse, so the application can be recognized across several executions.

Note

Only available with open62541 >= v1.3 and OpenSSL/LibreSSL

Parameters

subject	Elements for the subject, e.g. {"C=DE", "O=SampleOrganization", "CN=Open62541Server@localhost"}
subjectAltName	Elements for SubjectAltName, e.g. {"DNS:localhost", "URI:urn:open62541.server.application"}
certificateFormat	Certificate format, either DER or PEM

Exceptions

BadStatus	(BadOutOfMemory)
CreateCertificateError

See also

UA_CreateCertificate

loadNodeset()

StatusCode opcua::loadNodeset	(	Server &	server,
		std::string_view	nodeset2XmlFilePath
	)

Load a nodeset from a NodeSet2.xml file at runtime.

Parameters

server	The server to load the nodeset into.
nodeset2XmlFilePath	The path to the XML file.

getDataType()

template<typename T >

const UA_DataType & opcua::getDataType ( )

noexcept

Definition at line 43 of file typeregistry.hpp.

toString()

String opcua::toString

(

const NumericRange &

range

)

Examples

client_subscription.cpp, events/client_eventfilter.cpp, and server_accesscontrol.cpp.

Referenced by opcua::TypeWrapper< T, Index >::toString().