UaMethodGeneric Class Reference

Class definition of the UaMethodGeneric. Derived from UaReferenceLists and UaMethod. More...

#include <uadatavariablecache.h>

Inheritance diagram for UaMethodGeneric:

[legend]

Collaboration diagram for UaMethodGeneric:

[legend]

List of all members.

Public Member Functions
	UaMethodGeneric (const UaString &name, const UaNodeId &nodeId, const UaString &defaultLocaleId)
virtual	~UaMethodGeneric ()
UaReferenceLists *	getUaReferenceLists () const
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
virtual OpcUa_Boolean	executable () const
virtual OpcUa_Boolean	userExecutable () const
UaNode *	getUaNode () const

---

Detailed Description

Class definition of the UaMethodGeneric. Derived from UaReferenceLists and UaMethod.

UaMethodGeneric

---

Constructor & Destructor Documentation

UaMethodGeneric::UaMethodGeneric	(	const UaString &	name,
		const UaNodeId &	nodeId,
		const UaString &	defaultLocaleId
	)

construction

UaMethodGeneric::~UaMethodGeneric

(

)

[virtual]

destruction

---

Member Function Documentation

UaReferenceLists* UaMethodGeneric::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 UaMethodGeneric::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 UaMethodGeneric::nodeId

(

)

const [virtual]

Get the NodeId for the DataVariable.

Returns:

the NodeId for the DataVariable.

Implements UaNode.

UaQualifiedName UaMethodGeneric::browseName

(

)

const [virtual]

Get the browseName as QualifiedName of the current Node.

Returns:

the BrowseName for the DataVariable as QualifiedName.

Implements UaNode.

UaLocalizedText UaMethodGeneric::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 UaMethodGeneric::isDescriptionSupported

(

)

const [virtual]

Check if Node is DescriptionSupported.

Returns:

FALSE if not supported.

Implements UaNode.

UaLocalizedText UaMethodGeneric::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 UaMethodGeneric::isWriteMaskSupported

(

)

const [virtual]

Check if Node is WriteMaskSupported.

Returns:

TRUE if Node is WriteMaskSupported.

Implements UaNode.

OpcUa_UInt32 UaMethodGeneric::writeMask

(

)

const [virtual]

Get the writeMask of the current Node.

Returns:

the writeMask.

Implements UaNode.

OpcUa_Boolean UaMethodGeneric::isUserWriteMaskSupported

(

)

const [virtual]

Check if Node is UserWriteMaskSupported.

Returns:

TRUE if Node is UserWriteMaskSupported.

Implements UaNode.

OpcUa_UInt32 UaMethodGeneric::userWriteMask

(

Session *

pSession

)

const [virtual]

Get the WriteMask of the User.

Parameters:

pSession

Interface to the Session context for the method call

Returns:

the WriteMask of the User.

Implements UaNode.

OpcUa_Boolean UaMethodGeneric::executable

(

)

const [virtual]

Indicates if Method is executable.

Returns:

TRUE if executable FALSE if not.

Implements UaMethod.

OpcUa_Boolean UaMethodGeneric::userExecutable

(

)

const [virtual]

Indicates if method is executable by the user.

Returns:

TRUE if Userexecutable FALSE if not.

Implements UaMethod.

UaNode* UaMethodGeneric::getUaNode

(

)

const [inline, virtual]

Get the Node.

Returns:

the current searched Node.

Implements UaReferenceLists.

---

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

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