UaGenericMethod Class Reference [Core Module Address Model Classes]

Derived from UaMethod and UaReferenceLists. More...

#include <uagenericnodes.h>

Inheritance diagram for UaGenericMethod:

Collaboration diagram for UaGenericMethod:

List of all members.

Public Member Functions
	UaGenericMethod (const UaNodeId &nodeId, const UaQualifiedName &browseName, const UaLocalizedText &displayName, const UaLocalizedText &description, OpcUa_Boolean executable, OpcUa_Boolean userExecutable)
virtual	~UaGenericMethod ()
UaStatus	browse (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
virtual UaNodeId	nodeId () const
virtual UaQualifiedName	browseName () const
virtual UaLocalizedText	displayName (Session *) const
virtual OpcUa_Boolean	isDescriptionSupported () const
virtual UaLocalizedText	description (Session *) const
virtual OpcUa_Boolean	isWriteMaskSupported () const
virtual OpcUa_UInt32	writeMask () const
virtual OpcUa_Boolean	isUserWriteMaskSupported () const
virtual OpcUa_UInt32	userWriteMask (Session *) const
virtual OpcUa_Boolean	executable () const
virtual OpcUa_Boolean	userExecutable () const
OpcUa_NodeClass	nodeClass () const
UaNodeId	typeDefinitionId () const
UaNode *	getUaNode () const
UaReferenceLists *	getUaReferenceLists () const
virtual void	setWriteMask (OpcUa_UInt32 writeMask)
virtual UaStatus	setAttributeValue (Session *pSession, OpcUa_Int32 attributeId, const UaDataValue &dataValue, OpcUa_Boolean checkWriteMask)

---

Detailed Description

Derived from UaMethod and UaReferenceLists.

UaGenericMethod

---

Constructor & Destructor Documentation

UaGenericMethod::UaGenericMethod	(	const UaNodeId &	nodeId,
		const UaQualifiedName &	browseName,
		const UaLocalizedText &	displayName,
		const UaLocalizedText &	description,
		OpcUa_Boolean	executable,
		OpcUa_Boolean	userExecutable
	)

construction

UaGenericMethod::~UaGenericMethod

(

)

[virtual]

destruction

---

Member Function Documentation

UaStatus UaGenericMethod::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.

virtual UaQualifiedName UaGenericMethod::browseName

(

)

const [inline, virtual]

Get the browseName as QualifiedName of the current Node.

Returns:

the BrowseName for the DataVariable as QualifiedName.

Implements UaNode.

virtual UaLocalizedText UaGenericMethod::description

(

Session *

)

const [inline, virtual]

Get the description as LocalizedText of the current Node.

Returns:

the LocalizedText of the current Node.

Implements UaNode.

virtual UaLocalizedText UaGenericMethod::displayName

(

Session *

)

const [inline, virtual]

Get the displayName as LocalizedText of the current Node.

Returns:

the LocalizedText of the current Node.

Implements UaNode.

virtual OpcUa_Boolean UaGenericMethod::executable

(

)

const [inline, virtual]

Indicates if Method is executable.

Returns:

TRUE if executable FALSE if not.

Implements UaMethod.

UaNode* UaGenericMethod::getUaNode

(

)

const [inline, virtual]

Get the Node.

Returns:

the current searched Node.

Implements UaReferenceLists.

UaReferenceLists* UaGenericMethod::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.

virtual OpcUa_Boolean UaGenericMethod::isDescriptionSupported

(

)

const [inline, virtual]

Check if Node is DescriptionSupported.

Returns:

FALSE if not supported.

Implements UaNode.

virtual OpcUa_Boolean UaGenericMethod::isUserWriteMaskSupported

(

)

const [inline, virtual]

Check if Node is UserWriteMaskSupported.

Returns:

TRUE if Node is UserWriteMaskSupported.

Implements UaNode.

virtual OpcUa_Boolean UaGenericMethod::isWriteMaskSupported

(

)

const [inline, virtual]

Check if Node is WriteMaskSupported.

Returns:

TRUE if Node is WriteMaskSupported.

Implements UaNode.

OpcUa_NodeClass UaGenericMethod::nodeClass

(

)

const [inline, virtual]

Get the Nodeclass of the current Node.

Returns:

the Nodeclass of the current Node.

Reimplemented from UaMethod.

virtual UaNodeId UaGenericMethod::nodeId

(

)

const [inline, virtual]

Get the NodeId of the current Node.

Returns:

the NodeId of the current Node.

Implements UaNode.

UaStatus UaGenericMethod::setAttributeValue	(	Session *	pSession,
		OpcUa_Int32	attributeId,
		const UaDataValue &	dataValue,
		OpcUa_Boolean	checkWriteMask
	)		[virtual]

Sets the value of an attribute of the Node.

Returns:

Status code

Parameters:

[in]	pSession	Interface to the Session context for the method call
[in]	attributeId	Attribute id indicating the attribute to set
[in]	dataValue	New value for the attribute
[out]	checkWriteMask	Flag indicating if the write mask of the node should be checked before setting the new value

Reimplemented from UaNode.

virtual void UaGenericMethod::setWriteMask

(

OpcUa_UInt32

writeMask )

[inline, virtual]

Sets the write mask attribute.

UaNodeId UaGenericMethod::typeDefinitionId

(

)

const [inline, virtual]

Get the object type NodeId for the server object.

Returns:

the object type NodeId for the server object.

Reimplemented from UaNode.

virtual OpcUa_Boolean UaGenericMethod::userExecutable

(

)

const [inline, virtual]

Indicates if method is executable by the user.

Returns:

TRUE if Userexecutable FALSE if not.

Implements UaMethod.

virtual OpcUa_UInt32 UaGenericMethod::userWriteMask

(

Session *

)

const [inline, virtual]

Get the WriteMask of the User.

Returns:

the WriteMask of the User.

Implements UaNode.

virtual OpcUa_UInt32 UaGenericMethod::writeMask

(

)

const [inline, virtual]

Get the writeMask of the current Node.

Returns:

the writeMask.

Implements UaNode.

---

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

• /home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/uagenericnodes.h
• /home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/uagenericnodes.cpp