Core Module Address Model Classes

This module contains all class implementing a generic address space model. More...

Classes
class	UaNode
	Interface class for OPC UA Nodes created and managed with the SDK. More...
class	UaObject
	Interface for OPC UA Object nodes created and managed with the SDK. More...
class	UaObjectType
	Class definition of the UaObjectType. More...
class	UaVariable
	Class definition of the UaVariable. More...
class	UaVariableType
	Class definition of the UaVariableType. More...
class	UaDataType
	Class definition of the UaDataType. More...
class	UaView
	Interface representing a OPC UA View node. More...
class	UaMethod
	Class definition of the UaMethod. More...
class	UaReferenceType
	Class definition of the UaReferenceType. More...
class	UaReferenceLists
	Class implementing the reference handling for UaNodes. More...
class	UaReference
	Interface definition of the UaReference. More...
class	UaRefCrossNodeManager
	Implements a reference between nodes in two different NodeManagers. More...
class	UaRefCrossNodeManagerSingle
	Implements a reference between two nodes in two different NodeManagers. More...
class	UaRefOutOfServer
	Class definition of the UaRefOutOfServer. More...
class	UaGenericReference
	Implements a reference betwen two nodes with the capability to set the reference type node. More...
class	UaReferenceCPCopy
	Implements a reference betwen two nodes with the capability to set the reference type NodeId. More...
class	UaRefOrganizes
	Class implementing references of type Organizes. More...
class	UaRefHasComponent
	Class implementing references of type HasComponent. More...
class	UaRefHasHistoricalConfiguration
	Class implementing references of type HasHistoricalConfiguration. More...
class	UaRefHasOrderedComponent
	Class implementing references of type HasOrderedComponent. More...
class	UaRefHasArgumentDescription
	Class implementing references of type HasArgumentDescription. More...
class	UaRefHasOptionalInputArgumentDescription
	Class implementing references of type HasOptionalInputArgumentDescription. More...
class	UaRefHasGuard
	Class implementing references of type HasGuard. More...
class	UaRefHasDictionaryEntry
	Class implementing references of type HasDictionaryEntry. More...
class	UaRefHasInterface
	Class implementing references of type HasInterface. More...
class	UaRefHasAddIn
	Class implementing references of type HasAddIn. More...
class	UaRefHasProperty
	Class implementing references of type HasProperty. More...
class	UaRefHasSubtype
	Class implementing references of type HasSubtype. More...
class	UaRefHasEventSource
	Class implementing references of type HasEventSource. More...
class	UaRefHasNotifier
	Class implementing references of type HasNotifier. More...
class	UaRefHasTypeDefinition
	Class implementing references of type HasTypeDefinition. More...
class	UaRefGeneratesEvent
	Class implementing references of type GeneratesEvent. More...
class	UaRefAlwaysGeneratesEvent
	Class implementing references of type AlwaysGeneratesEvent. More...
class	UaRefHasCondition
	Reference class used to represent a HasCondition reference. More...
class	UaRefHasDescription
	Class implementing references of type HasDescription. More...
class	UaRefHasEncoding
	Class implementing references of type HasEncoding. More...
class	UaRefHasModellingRule
	Class implementing references of type HasModellingRule. More...
class	UaRefFromState
	Class implementing references of type FromState. More...
class	UaRefHasCause
	Class implementing references of type HasCause. More...
class	UaRefHasEffect
	Class implementing references of type HasEffect. More...
class	UaRefToState
	Class implementing references of type ToState. More...
class	UaRefHasSubStateMachine
	Class implementing references of type HasSubStateMachine. More...
class	UaRefHasPubSubConnection
	Class implementing references of type HasPubSubConnection. More...
class	UaRefHasWriterGroup
	Class implementing references of type HasWriterGroup. More...
class	UaRefHasReaderGroup
	Class implementing references of type HasReaderGroup. More...
class	UaRefDataSetToWriter
	Class implementing references of type DataSetToWriter. More...
class	UaRefHasDataSetWriter
	Class implementing references of type HasDataSetWriter. More...
class	UaRefHasDataSetReader
	Class implementing references of type HasDataSetReader. More...
class	UaRefHasAlarmSuppressionGroup
	Class implementing references of type HasAlarmSuppressionGroup. More...
class	UaRefAlarmGroupMember
	Class implementing references of type AlarmGroupMember. More...
class	UaRefHasEffectDisable
	Class implementing references of type HasEffectDisable. More...
class	UaRefHasEffectEnable
	Class implementing references of type HasEffectEnable. More...
class	UaRefHasEffectSuppressed
	Class implementing references of type HasEffectSuppressed. More...
class	UaRefHasEffectUnsuppressed
	Class implementing references of type HasEffectUnsuppressed. More...
class	UaRefAliasFor
	Class implementing references of type AliasFor. More...
class	UaFolder
	OPC UA Folder Object handling class. More...
class	UaAreaFolder
	OPC UA Folder Object handling class used as Alarm Area object. More...
class	UaGenericObject
	Derived from UaObject and UaReferenceLists. More...
class	UaGenericObjectType
	Derived from UaObjectType and UaReferenceLists. More...
class	UaGenericVariable
	Derived from UaVariableCache and UaReferenceLists. More...
class	UaGenericVariableType
	Derived from UaVariableType and UaReferenceLists. More...
class	UaGenericDataType
	Derived from UaDataType and UaReferenceLists. More...
class	UaGenericDataTypeStructure
	Generic implementation class for UaDataType that represents a structure. More...
class	UaGenericDataTypeEnum
	Generic implementation class for UaDataType that represents an enumeration. More...
class	UaGenericView
	Derived from UaView and UaReferenceLists. More...
class	UaGenericMethod
	Derived from UaMethod and UaReferenceLists. More...
class	UaGenericReferenceType
	Derived from UaReferenceType and UaReferenceLists. More...
class	UaObjectTypeSimple
	Derived from UaObjectType and UaReferenceLists. More...
class	UaObjectBase
	Provides a base class to implement an Object The object is able to register it's own components at his node manager Derived from UaObject and UaReferenceLists It is not possible to create shallow copies of this Class. More...
class	UaVariableTypeSimple
	Derived from UaVariableType and UaReferenceLists. More...
class	UaDataVariableDevice
	Derived from UaVariable and UaReferenceLists. More...
class	UaViewSimple
	Derived from UaView and UaReferenceLists. More...
class	UaReferenceTypeNS0
	Derived from UaReferenceType and UaReferenceLists. More...

Enumerations
enum	UaDataType::DataTypeDefinitionType
	Enumeration that indicates whether a UaEnumDefinition or a UaStructureDefinition is available.
enum	UaReference::CrossNodeManagerReferenceType { UaReference::UA_NO_CROSSNODEMANAGER = 0, UaReference::UA_LIST_OF_REFERENCES, UaReference::UA_SINGLE_REFERENCE }
	Enumeration of cross node manager reference type. More...

Variables
const OpcUa_UInt32	UaVariable_Value_None = 0x0
	Bit mask for UaVariable::valueHandling. More...
const OpcUa_UInt32	UaVariable_Value_Cache = 0x1
	The variable has a cached value but normal read and data monitoring will not use the value directly. More...
const OpcUa_UInt32	UaVariable_Value_CacheIsSource = 0x2
	If this flag is set, the value in the variable node is the data source and all read, data monitoring and write operations are using the value without requiring any custom code. More...
const OpcUa_UInt32	UaVariable_Value_CacheIsUpdatedOnRequest = 0x4
	If this flag is set, the custom code is responsible for updating the cache value for variables monitored by one or more clients and to handle read and write operations. More...

Detailed Description

This module contains all class implementing a generic address space model.

Enumeration Type Documentation

enum UaReference::CrossNodeManagerReferenceType

Enumeration of cross node manager reference type.

Enumerator
UA_NO_CROSSNODEMANAGER	This is not a cross node manager reference
UA_LIST_OF_REFERENCES	This cross node manager reference can have a list of target nodes
UA_SINGLE_REFERENCE	This cross node manager reference has one target node

Variable Documentation

const OpcUa_UInt32 UaVariable_Value_Cache = 0x1

The variable has a cached value but normal read and data monitoring will not use the value directly.

If only this flag is set all read and sampling access uses IOManagerUaNode::readValues that needs to be implemented in the custom NodeManager. All write operations to this variable are using IOManagerUaNode::writeValues. The cache value is not updated by the SDK. The custom code is responsible for updating the cache to allow the SDK to return values that are not older than the MaxAge parameter in the Read.

const OpcUa_UInt32 UaVariable_Value_CacheIsSource = 0x2

If this flag is set, the value in the variable node is the data source and all read, data monitoring and write operations are using the value without requiring any custom code.

Value changes can be provided with the method UaVariable::setValue(). IOManagerUaNode::beforeSetAttributeValue and IOManagerUaNode::afterSetAttributeValue can be used to control writing of attributes or to get informed about a successful write of an attribute. This requires overwriting these functions in the custom NodeManager implementation class.

const OpcUa_UInt32 UaVariable_Value_CacheIsUpdatedOnRequest = 0x4

If this flag is set, the custom code is responsible for updating the cache value for variables monitored by one or more clients and to handle read and write operations.

Value changes can be provided with the method UaVariable::setValue(). The custom code gets informed about monitoring changes for items of this type by overwriting IOManagerUaNode::variableCacheMonitoringChanged in the custom NodeManager implementation. In addition it is required to implement IOManagerUaNode::readValues and IOManagerUaNode::writeValues for read and write operations. This option allows optimizing cyclic access to devices for data monitoring independent of read operations

const OpcUa_UInt32 UaVariable_Value_None = 0x0

Bit mask for UaVariable::valueHandling.