UaObjectBase Class Reference
[Core Module Address Model Classes]

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 plane copies of this Class. More...

#include <uaobjecttypes.h>

Inheritance diagram for UaObjectBase:

[legend]

Collaboration diagram for UaObjectBase:

[legend]

List of all members.

Public Member Functions
	UaObjectBase (const UaString &name, const UaNodeId &newNodeId, const UaString &defaultLocaleId)
virtual	~UaObjectBase ()
UaReferenceLists *	getUaReferenceLists () const
virtual UaStatus	browse (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
UaNodeId	nodeId () const
virtual UaQualifiedName	browseName () const
virtual UaLocalizedText	displayName (const UaString &localId) const
virtual OpcUa_Boolean	isDescriptionSupported () const
virtual UaLocalizedText	description (const UaString &localId) const
virtual OpcUa_Boolean	isWriteMaskSupported () const
virtual OpcUa_UInt32	writeMask () const
virtual OpcUa_Boolean	isUserWriteMaskSupported () const
virtual OpcUa_UInt32	userWriteMask (Session *pSession) const
UaNode *	getUaNode () const
Protected Attributes
UaString	m_defaultLocaleId

---

Detailed Description

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 plane copies of this Class.

UaObjectBase

---

Constructor & Destructor Documentation

UaObjectBase::UaObjectBase	(	const UaString &	name,
		const UaNodeId &	newNodeId,
		const UaString &	defaultLocaleId
	)

construction

UaObjectBase::~UaObjectBase

(

)

[virtual]

destruction

---

Member Function Documentation

UaReferenceLists* UaObjectBase::getUaReferenceLists

(

)

const [inline, virtual]

Get a ReferenceList where all the Nodes are in.

Returns:

a ReferenceList where all the Nodes are in.

Reimplemented from UaNode.

UaStatus UaObjectBase::browse	(	const ServiceContext &	serviceContext,
		BrowseContext &	browseContext,
		UaReferenceDescriptions &	References
	)			[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

Implements UaNode.

UaNodeId UaObjectBase::nodeId

(

)

const [virtual]

Get the NodeId of the current Node.

Returns:

the NodeId of the current Node.

Implements UaNode.

UaQualifiedName UaObjectBase::browseName

(

)

const [virtual]

Get the browseName of the current Node.

Returns:

the browseName of the current Node.

Implements UaNode.

UaLocalizedText UaObjectBase::displayName

(

const UaString &

localId

)

const [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.

Implements UaNode.

OpcUa_Boolean UaObjectBase::isDescriptionSupported

(

)

const [virtual]

Check if Node is DescriptionSupported.

Returns:

FALSE if not supported.

Implements UaNode.

UaLocalizedText UaObjectBase::description

(

const UaString &

localId

)

const [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.

Implements UaNode.

OpcUa_Boolean UaObjectBase::isWriteMaskSupported

(

)

const [virtual]

Check if Node is WriteMaskSupported.

Returns:

TRUE if Node is WriteMaskSupported.

Implements UaNode.

OpcUa_UInt32 UaObjectBase::writeMask

(

)

const [virtual]

Get the writeMask of the current Node.

Returns:

the writeMask.

Implements UaNode.

OpcUa_Boolean UaObjectBase::isUserWriteMaskSupported

(

)

const [virtual]

Check if Node is UserWriteMaskSupported.

Returns:

TRUE if Node is UserWriteMaskSupported.

Implements UaNode.

OpcUa_UInt32 UaObjectBase::userWriteMask

(

Session *

pSession

)

const [virtual]

Check if Node has a userWriteMask.

Parameters:

pSession

Interface to the Session context for the method call

Returns:

the userWriteMask.

Implements UaNode.

UaNode* UaObjectBase::getUaNode

(

)

const [inline, virtual]

Get the Node.

Returns:

the current searched Node.

Implements UaReferenceLists.

Reimplemented in UaStateMachineType, UaFolder, and UaObjectServer.

---

Member Data Documentation

UaString UaObjectBase::m_defaultLocaleId [protected]

Default localeId for the object. MemberVar.

---

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

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