UaNode Class Reference
[Core Module Address Model Classes]

Class definition of the UaNode. Derived from ChainEntry Get all information about Nodes and their references. More...

#include <uabasenodes.h>

Inheritance diagram for UaNode:

[legend]

Collaboration diagram for UaNode:

[legend]

List of all members.

Public Member Functions
	UaNode ()
virtual UaNodeId	getKey () const
virtual UaReferenceLists *	getUaReferenceLists () const
virtual UaStatus	browse (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)=0
virtual UaNodeId	typeDefinitionId () const =0
virtual OpcUa_NodeClass	nodeClass () const =0
virtual UaNodeId	nodeId () const =0
virtual UaQualifiedName	browseName () const =0
virtual UaLocalizedText	displayName (const UaString &localId) const =0
virtual OpcUa_Boolean	isDescriptionSupported () const =0
virtual UaLocalizedText	description (const UaString &localId) const =0
virtual OpcUa_Boolean	isWriteMaskSupported () const =0
virtual OpcUa_UInt32	writeMask () const =0
virtual OpcUa_Boolean	isUserWriteMaskSupported () const =0
virtual OpcUa_UInt32	userWriteMask (Session *pSession) const =0
virtual OpcUa_Boolean	isInstanceDeclaration () const
Protected Member Functions
virtual	~UaNode ()

---

Detailed Description

Class definition of the UaNode. Derived from ChainEntry Get all information about Nodes and their references.

UaNode

---

Constructor & Destructor Documentation

UaNode::~UaNode

(

)

[protected, virtual]

destruction

UaNode::UaNode

(

)

construction

---

Member Function Documentation

UaNodeId UaNode::getKey

(

)

const [virtual]

Get the key from the current NodeId.

Returns:

the key of the current NodeId.

Implements ChainEntry.

virtual UaReferenceLists* UaNode::getUaReferenceLists

(

)

const [inline, virtual]

Get the UaReferenceLists interface for the node. The UaReferenceLists interface is used to manage and to access the references from and to this node.

Returns:

UaReferenceLists interface for the node.

Reimplemented in UaDataTypeNS0, UaDataVariableCache, UaMethodGeneric, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericObject, UaGenericObjectType, UaGenericVariable, UaGenericVariableType, UaGenericDataType, UaGenericView, UaGenericMethod, UaGenericReferenceType, UaObjectTypeSimple, UaObjectBase, UaVariableTypeSimple, UaDataVariableDevice, UaViewSimple, and UaReferenceTypeNS0.

virtual UaStatus UaNode::browse	(	const ServiceContext &	serviceContext,
		BrowseContext &	browseContext,
		UaReferenceDescriptions &	References
	)			[pure virtual]

Discover the references of a specified node of a view. This method is used to return a list of references and target nodes for the passed node to browse for the services Browse and BrowseNext.

Parameters:

	serviceContext	General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
	browseContext	Browse context for the first browse or the following browse with continuation point.
	References	Array of ReferenceDescription results for the browsed node.

Returns:

Error code

Implemented in UaDataTypeNS0, UaDataVariableCache, UaMethodGeneric, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericObject, UaGenericObjectType, UaGenericVariable, UaGenericVariableType, UaGenericDataType, UaGenericView, UaGenericMethod, UaGenericReferenceType, UaObjectTypeSimple, UaObjectBase, UaVariableTypeSimple, UaDataVariableDevice, UaViewSimple, and UaReferenceTypeNS0.

virtual UaNodeId UaNode::typeDefinitionId

(

)

const [pure virtual]

Get the object type NodeId for the server object.

Returns:

the object type NodeId for the server object.

Implemented in UaObjectType, UaProperty, UaVariableType, UaDataType, UaView, UaMethod, UaReferenceType, UaStateMachineType, UaDataVariableCache, UaAnalogItemCache, UaPropertyCache, UaPropertyMethodArgument, UaDataVariableCacheEx, UaAnalogItemCacheEx, UaPropertyCacheEx, UaFolder, UaGenericObject, UaGenericObjectType, UaGenericVariable, UaGenericVariableType, UaGenericDataType, UaGenericView, UaGenericMethod, UaGenericReferenceType, UaObjectServer, UaObjectServerCapabilities, UaModelingRule, UaObjectServerDiagnostic, UaObjectServerRedundancy, UaObjectVendorServerInfo, UaVariableTypeSimple, and UaDataVariableDevice.

virtual OpcUa_NodeClass UaNode::nodeClass

(

)

const [pure virtual]

Get the Nodeclass of the current Node.

Returns:

the Nodeclass of the current Node.

Implemented in UaObject, UaObjectType, UaVariable, UaVariableType, UaDataType, UaView, UaMethod, UaReferenceType, UaGenericObject, UaGenericObjectType, UaGenericVariable, UaGenericVariableType, UaGenericDataType, UaGenericView, UaGenericMethod, UaGenericReferenceType, and UaVariableTypeSimple.

virtual UaNodeId UaNode::nodeId

(

)

const [pure virtual]

Get the NodeId of the current Node.

Returns:

the NodeId of the current Node.

Implemented in UaDataTypeNS0, UaDataVariableCache, UaMethodGeneric, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericObject, UaGenericObjectType, UaGenericVariable, UaGenericVariableType, UaGenericDataType, UaGenericView, UaGenericMethod, UaGenericReferenceType, UaObjectTypeSimple, UaObjectBase, UaVariableTypeSimple, UaDataVariableDevice, UaViewSimple, and UaReferenceTypeNS0.

virtual UaQualifiedName UaNode::browseName

(

)

const [pure virtual]

Get the browseName as QualifiedName of the current Node.

Returns:

the browseName as QualifiedName.

Implemented in UaDataTypeNS0, UaDataVariableCache, UaMethodGeneric, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericObject, UaGenericObjectType, UaGenericVariable, UaGenericVariableType, UaGenericDataType, UaGenericView, UaGenericMethod, UaGenericReferenceType, UaObjectTypeSimple, UaObjectBase, UaVariableTypeSimple, UaDataVariableDevice, UaViewSimple, and UaReferenceTypeNS0.

virtual UaLocalizedText UaNode::displayName

(

const UaString &

localId

)

const [pure virtual]

Get the displayName as LocalizedText of the current Node.

Parameters:

localId

the local Id as Variable used for the session.

Returns:

the LocalizedText of the current Node.

Implemented in UaDataTypeNS0, UaDataVariableCache, UaMethodGeneric, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericObject, UaGenericObjectType, UaGenericVariable, UaGenericVariableType, UaGenericDataType, UaGenericView, UaGenericMethod, UaGenericReferenceType, UaObjectTypeSimple, UaObjectBase, UaVariableTypeSimple, UaDataVariableDevice, UaViewSimple, and UaReferenceTypeNS0.

virtual OpcUa_Boolean UaNode::isDescriptionSupported

(

)

const [pure virtual]

Check if Node is DescriptionSupported.

Returns:

FALSE if not supported.

Implemented in UaDataTypeNS0, UaDataVariableCache, UaMethodGeneric, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericObject, UaGenericObjectType, UaGenericVariable, UaGenericVariableType, UaGenericDataType, UaGenericView, UaGenericMethod, UaGenericReferenceType, UaObjectTypeSimple, UaObjectBase, UaVariableTypeSimple, UaDataVariableDevice, UaViewSimple, and UaReferenceTypeNS0.

virtual UaLocalizedText UaNode::description

(

const UaString &

localId

)

const [pure virtual]

Get the description as LocalizedText of the current Node.

Parameters:

localId

the local Id as Variable used for the session.

Returns:

the LocalizedText of the current Node.

Implemented in UaDataTypeNS0, UaDataVariableCache, UaMethodGeneric, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericObject, UaGenericObjectType, UaGenericVariable, UaGenericVariableType, UaGenericDataType, UaGenericView, UaGenericMethod, UaGenericReferenceType, UaObjectTypeSimple, UaObjectBase, UaVariableTypeSimple, UaDataVariableDevice, UaViewSimple, and UaReferenceTypeNS0.

virtual OpcUa_Boolean UaNode::isWriteMaskSupported

(

)

const [pure virtual]

Check if Node is WriteMaskSupported.

Returns:

TRUE if Node is WriteMaskSupported.

Implemented in UaDataTypeNS0, UaDataVariableCache, UaMethodGeneric, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericObject, UaGenericObjectType, UaGenericVariable, UaGenericVariableType, UaGenericDataType, UaGenericView, UaGenericMethod, UaGenericReferenceType, UaObjectTypeSimple, UaObjectBase, UaVariableTypeSimple, UaDataVariableDevice, UaViewSimple, and UaReferenceTypeNS0.

virtual OpcUa_UInt32 UaNode::writeMask

(

)

const [pure virtual]

Get the writeMask of the current Node.

Returns:

the writeMask.

Implemented in UaDataTypeNS0, UaDataVariableCache, UaMethodGeneric, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericObject, UaGenericObjectType, UaGenericVariable, UaGenericVariableType, UaGenericDataType, UaGenericView, UaGenericMethod, UaGenericReferenceType, UaObjectTypeSimple, UaObjectBase, UaVariableTypeSimple, UaDataVariableDevice, UaViewSimple, and UaReferenceTypeNS0.

virtual OpcUa_Boolean UaNode::isUserWriteMaskSupported

(

)

const [pure virtual]

Check if Node is UserWriteMaskSupported.

Returns:

TRUE if Node is UserWriteMaskSupported.

Implemented in UaDataTypeNS0, UaDataVariableCache, UaMethodGeneric, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericObject, UaGenericObjectType, UaGenericVariable, UaGenericVariableType, UaGenericDataType, UaGenericView, UaGenericMethod, UaGenericReferenceType, UaObjectTypeSimple, UaObjectBase, UaVariableTypeSimple, UaDataVariableDevice, UaViewSimple, and UaReferenceTypeNS0.

virtual OpcUa_UInt32 UaNode::userWriteMask

(

Session *

pSession

)

const [pure virtual]

Get the WriteMask of the User.

Parameters:

pSession

Interface to the Session context for the method call

Returns:

the WriteMask of the User.

Implemented in UaDataTypeNS0, UaDataVariableCache, UaMethodGeneric, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericObject, UaGenericObjectType, UaGenericVariable, UaGenericVariableType, UaGenericDataType, UaGenericView, UaGenericMethod, UaGenericReferenceType, UaObjectTypeSimple, UaObjectBase, UaVariableTypeSimple, UaDataVariableDevice, UaViewSimple, and UaReferenceTypeNS0.

virtual OpcUa_Boolean UaNode::isInstanceDeclaration

(

)

const [inline, virtual]

Indicates if the node is a instance declaration node Can be overwritten by classes used for instance declarations

Returns:

FALSE if Instaance has Declaration.

Reimplemented in UaDataVariableCacheID, UaPropertyCacheID, and UaPropertyMethodArgumentID.

---

The documentation for this class was generated from the following files:

• src/uaserver/uaservercpp/coremodule/uabasenodes.h
• src/uaserver/uaservercpp/coremodule/uabasenodes.cpp