Root namespace for the OpcUA tool. More...

Classes
class	BaseNode
	An OPCUA BaseNode. This is the base for all other node classes. For instantiation of a specific node type use one of the specific subclasses. There is no public interface to create a BaseNode. More...

class	BrowseFilter
	The BrowseFilter serves to specify the parameter of a browse operation on an OPCUA node object. More...

class	Client
	An OPCUA Client object. This class handles the client side of the OPCUA client/server interaction. More...

class	FloatNode
	A FloatNode object provides an interface for storage and manipulation of floating point numbers. More...

class	IntegerNode
	A Node with integer values provides an interface for storage and manipulation of integer (default int representation) numbers. More...

class	MethodNode
	An OPCUA method node object to call remote procedures. More...

class	MethodNodeArgument
	An OPCUAMethodNodeArgument is a helper class to manage arguments of a method node. More...

class	NodeID
	An OPCUA NodeID object. NodeIDs provide a unique identifier for OPCUA nodes, i.e. they help with node creation, addition to servers, retrieving from servers etc.. More...

class	ObjectNode
	An OPCUA Object Node object. This is the "base" of many more complex node. However the defining feature is to create a ObjectNode from a OPCUA TypeDefinition. Example: A ObjectNode can be created with Namespace0NodeId of "FolderType", i.e. the creation for a folder. More...

class	OpcUaException
	Special runtime exception to carry a native error code. More...

class	Server
	An OPCUA server object. More...

class	StringNode
	A node object with string values, provides an interface for storage and manipulation of strings (default std::string or std::wstring representation). More...

class	Subscription
	An OPCUA Subscribe serves to monitor OPCUA variables (from a client) and provides a callback mechanism for changes. More...

class	VariableNode
	An OPCUA VariableNode object. It handles the data modeling acording to the OPCUA specification. More...

Typedefs
using	ClientPtr = std::shared_ptr< Client >
	Convenience shared pointer for Client.

using	ServerPtr = std::shared_ptr< Server >
	Convenience shared pointer for Server.

using	NodeIDPtr = std::shared_ptr< NodeID >
	Convenience shared pointer for NodeID.

using	BaseNodePtr = std::shared_ptr< BaseNode >
	Convenience shared pointer for BaseNode.

using	ObjectNodePtr = std::shared_ptr< ObjectNode >
	Convenience shared pointer for ObjectNode.

using	VariableNodePtr = std::shared_ptr< VariableNode >
	Convenience shared pointer for VariableNode.

using	IntegerNodePtr = std::shared_ptr< IntegerNode >
	Convenience shared pointer for IntegerNode.

using	FloatNodePtr = std::shared_ptr< FloatNode >
	Convenience shared pointer for FloatNode.

using	StringNodePtr = std::shared_ptr< StringNode >
	Convenience shared pointer for StringNode.

using	MethodNodePtr = std::shared_ptr< MethodNode >
	Convenience shared pointer for MethodNode.

using	BrowseFilterPtr = std::shared_ptr< BrowseFilter >
	Convenience shared pointer for BrowseFilter.

using	SubscriptionPtr = std::shared_ptr< Subscription >
	Convenience shared pointer for Subscribe.

Enumerations
enum class	ReferenceDirection { Forward = CExports::CVOPC_FD_Forward , Inverse = CExports::CVOPC_FD_Inverse }
	Describes the direction for a OpcUa::Reference. More...

enum class	NodeIDType { Numeric = CExports::CVOPC_NID_Numeric , String = CExports::CVOPC_NID_String , GUID = CExports::CVOPC_NID_Guid , ByteString = CExports::CVOPC_NID_ByteString }
	Describes the representation of a OpcUa::NodeID. More...

enum class	ArgumentType { In = CExports::CVOPC_AGT_Input , Out = CExports::CVOPC_AGT_Output }
	Describes whether an argument of a MethodNode is input or output. More...

enum class	NodeClass { Object = CExports::CVOPC_NC_Object , Variable = CExports::CVOPC_NC_Variable , Method = CExports::CVOPC_NC_Method , ObjectType = CExports::CVOPC_NC_ObjectType , VariableType = CExports::CVOPC_NC_VariableType }
	Describes the "class" (i.e. type) of a BaseNode. More...

enum class	Access { NoAccess = CExports::CVOPC_AL_NoAccess , Read = CExports::CVOPC_AL_Read , Write = CExports::CVOPC_AL_Write , ReadWrite = CExports::CVOPC_AL_ReadOrWrite }
	Describes the access rights to a BaseNode. More...

enum class	ConnectionStatus { NotConnected = CExports::CVOPC_CST_NotConnected , ConnectedToServer = CExports::CVOPC_CST_Connected_To_Server , ConnectedToClient = CExports::CVOPC_CST_Connected_To_Client }
	Describes the connection status of a OpcUa::Server, OpcUa::Client or OpcUa::BaseNode. More...

enum class	DataType { Boolean = CExports::CVOPC_DT_Boolean , SByte = CExports::CVOPC_DT_SByte , Byte = CExports::CVOPC_DT_Byte , Int16 = CExports::CVOPC_DT_Int16 , UInt16 = CExports::CVOPC_DT_UInt16 , Int32 = CExports::CVOPC_DT_Int32 , Uint32 = CExports::CVOPC_DT_UInt32 , Int64 = CExports::CVOPC_DT_Int64 , Uint64 = CExports::CVOPC_DT_UInt64 , Float = CExports::CVOPC_DT_Float , Double = CExports::CVOPC_DT_Double , String = CExports::CVOPC_DT_String , DataTime = CExports::CVOPC_DT_DataTime , GUID = CExports::CVOPC_DT_GUID , ByteString = CExports::CVOPC_DT_ByteString }
	Describes the contents of a VariableNode. More...

enum class	ReferenceType
	Used for defining References between Nodes. See OpcUa::Server::AddReference.

enum class	AttributeID { NodeID = CExports::CVOPC_ATID_NodeId , NodeClass = CExports::CVOPC_ATID_NodeClass , BrowseName = CExports::CVOPC_ATID_BrowseName , DisplayName = CExports::CVOPC_ATID_DisplayName , Description = CExports::CVOPC_ATID_Description , WriteMask = CExports::CVOPC_ATID_WriteMask , UserWriteMask = CExports::CVOPC_ATID_UserWriteMask , IsAbstract = CExports::CVOPC_ATID_IsAbstract , Symmetric = CExports::CVOPC_ATID_Symmetric , InverseName = CExports::CVOPC_ATID_InverseName , ContainsNoLoops = CExports::CVOPC_ATID_ContainsNoLoops , EventNotifier = CExports::CVOPC_ATID_EventNotifier , Value = CExports::CVOPC_ATID_Value , DataType = CExports::CVOPC_ATID_DataType , valueRank = CExports::CVOPC_ATID_ValueRank , ArrayDimensions = CExports::CVOPC_ATID_ArrayDimensions , Access = CExports::CVOPC_ATID_AccessLevel , UserAccessLevel = CExports::CVOPC_ATID_UserAccessLevel , MinimumSamplingInterval = CExports::CVOPC_ATID_MinimumSamplingInterval , Historizing = CExports::CVOPC_ATID_Historizing , Executable = CExports::CVOPC_ATID_Executable , UserExecutable = CExports::CVOPC_ATID_UserExecutable , ArrayDimensionsSize = CExports::CVOPC_ATID_ArrayDimensionsSize }
	Descibes the attributes, which can be requested from nodes. More...

enum	BrowseSubType
	Define whether sub types of nodes should be included as part of a BaseNode::Browse operation.

enum class	Namespace0NodeID
	Lists "Namespace0" node ids Namespace0 node ids are a collection of mandatory and common nodeIDs. See Opcua::NodeID::Create.

Detailed Description

Root namespace for the OpcUA tool.

This namespace groups all parts of the C++ interface to the classic CVB OPCUA API. The classes directly within this namespace are usually your entry point when programming.

Examples

Note: All types under this namespace have unique names, therefore all types are mapped to this namespace for convenience.

Online Manual: Common Vision Blox-Tool OPC UA

Remarks: CMake users: Link to imported target CVB::CvbOpcUa

Enumeration Type Documentation

◆ Access

enum class Access

strong

Describes the access rights to a BaseNode.

Enumerator
NoAccess	No access permission.
Read	Read permission.
Write	Write permission.
ReadWrite	Read and Write permission.

◆ ArgumentType

enum class ArgumentType

strong

Describes whether an argument of a MethodNode is input or output.

Enumerator
In	input argument
Out	output argument

◆ AttributeID

enum class AttributeID

strong

Descibes the attributes, which can be requested from nodes.

Enumerator
NodeID	NodeID of the node (BaseNode (integer, See OpcUa::DataType))
NodeClass	NodeClass of the node (BaseNode (integer))
BrowseName	BrowseName of the node (BaseNode (Cvb::String))
DisplayName	DisplayName of the node (BaseNode (Cvb::String))
Description	Description of the node (BaseNode (Cvb::String))
WriteMask	Access rights as a bit mask (BaseNode (integer))
UserWriteMask	Access rights as a bit mask for a user (BaseNode (integer))
ContainsNoLoops	Circular relationship (i.e. references) present (boolean)
EventNotifier	Event notifier for the node (ObjectNode (boolean))
Value	Value of the node (VariableNode (See OpcUa::DataType))
DataType	Datatype of the node contents (VariableNode (integer See OpcUa::DataType))
ArrayDimensions	Size of array, if in array form (VariableNode (integer))
Access	Access rights to the node (VariableNode (integer))
UserAccessLevel	Access rights to the node by a user (VariableNode (integer))
Executable	Whether the access right permit executing the node (MethodNodes (boolean))
UserExecutable	Whether the access right permit executing the node (MethodNodes (boolean)) by a user.
ArrayDimensionsSize	Size of Value (individual field) if in array representation (variables, variableTypes (integer))

◆ ConnectionStatus

enum class ConnectionStatus

strong

Describes the connection status of a OpcUa::Server, OpcUa::Client or OpcUa::BaseNode.

Enumerator
NotConnected	Server or Client is not connected.
ConnectedToServer	Client is connected to a Server.
ConnectedToClient	Server has at least one connected client.

◆ DataType

enum class DataType

strong

Describes the contents of a VariableNode.

Enumerator
Boolean	Boolean.
SByte	signed byte
Byte	unsigned byte
Int16	signed 16 bit integer
UInt16	unsigned 16 bit integer
Int32	signed 32 bit integer
Uint32	unsigned 32 bit integer
Int64	signed 64 bit integer
Uint64	unsigned 64 bit integer
Float	single precision floating point number
Double	double precision floating point number
String	String.
DataTime	Time.
GUID	Globally Unique Identifier.
ByteString	string of bytes

◆ NodeClass

enum class NodeClass

strong

Describes the "class" (i.e. type) of a BaseNode.

Enumerator
Object	Object BaseNode Class.
Variable	Variable BaseNode Class.
Method	Method BaseNode Class.
ObjectType	Object TYPE Class.
VariableType	Variable TYPE Class.

◆ NodeIDType

enum class NodeIDType

strong

Describes the representation of a OpcUa::NodeID.

Enumerator
Numeric	Numeric representation of NodeID.
String	String representation of NodeID.
GUID	GUID representation of NodeID.
ByteString	ByteString representation of NodeID.

◆ ReferenceDirection

enum class ReferenceDirection

strong

Describes the direction for a OpcUa::Reference.

Enumerator
Forward	Forward.
Inverse	Inverse.


Contact Legal Privacy Statement	Copyright © 2023.
	All rights reserved.

Classes

Typedefs

Enumerations

Detailed Description

Enumeration Type Documentation

◆ Access

◆ ArgumentType

◆ AttributeID

◆ ConnectionStatus

◆ DataType

◆ NodeClass

◆ NodeIDType

◆ ReferenceDirection