Class definition of the UaPropertyMethodArgument. Derived from UaVariableCache and UaReferenceLists. It is not possible to use the default constructor. More...

#include <uadatavariablecache.h>

Inheritance diagram for UaPropertyMethodArgument:

[legend]

Collaboration diagram for UaPropertyMethodArgument:

[legend]

List of all members.

Public Types
enum	ArgumentType { INARGUMENTS, OUTARGUMENTS }
Public Member Functions
	UaPropertyMethodArgument (const UaNodeId &nodeId, OpcUa_Byte accessLevel, OpcUa_UInt32 numberOfArguments, ArgumentType argumentType)
virtual	~UaPropertyMethodArgument ()
UaReferenceLists *	getUaReferenceLists () const
UaStatus	browse (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
virtual UaNodeId	typeDefinitionId () const
UaNodeId	nodeId () const
virtual UaQualifiedName	browseName () const
virtual UaLocalizedText	displayName (Session *pSession) const
virtual OpcUa_Boolean	isDescriptionSupported () const
virtual UaLocalizedText	description (Session *pSession) const
virtual OpcUa_Boolean	isWriteMaskSupported () const
virtual OpcUa_UInt32	writeMask () const
virtual OpcUa_Boolean	isUserWriteMaskSupported () const
virtual OpcUa_UInt32	userWriteMask (Session *pSession) const
virtual UaDataValue	value (Session *pSession)
virtual UaStatus	setValue (Session *pSession, const UaDataValue &dataValue, OpcUa_Boolean checkAccessLevel)
virtual UaNodeId	dataType () const
virtual OpcUa_Int32	valueRank () const
virtual OpcUa_Boolean	isArrayDimensionsSupported () const
virtual void	arrayDimensions (UaUInt32Array &arrayDimensions) const
virtual OpcUa_Byte	accessLevel () const
virtual OpcUa_Byte	userAccessLevel (Session *pSession) const
virtual OpcUa_Boolean	isMinimumSamplingIntervalSupported () const
virtual OpcUa_Double	minimumSamplingInterval () const
virtual OpcUa_Boolean	historizing () const
UaNode *	getUaNode () const
OpcUa_StatusCode	setArgument (OpcUa_UInt32 index, const UaString &name, const UaNodeId &dataType, OpcUa_Int32 valueRank, const UaUInt32Array &arrayDimensions, const UaLocalizedText &description)

Detailed Description

Class definition of the UaPropertyMethodArgument. Derived from UaVariableCache and UaReferenceLists. It is not possible to use the default constructor.

UaPropertyMethodArgument

Member Enumeration Documentation

enum UaPropertyMethodArgument::ArgumentType

ArgumentType enumeration

Enumerator:

INARGUMENTS	Inargument
OUTARGUMENTS	Outargument

Constructor & Destructor Documentation

UaPropertyMethodArgument::UaPropertyMethodArgument	(	const UaNodeId &	nodeId,
		OpcUa_Byte	accessLevel,
		OpcUa_UInt32	numberOfArguments,
		ArgumentType	argumentType
	)

construction

UaPropertyMethodArgument::~UaPropertyMethodArgument ( ) [virtual]

destruction

Member Function Documentation

OpcUa_Byte UaPropertyMethodArgument::accessLevel ( ) const [virtual]

Get the AccessLevel for the DataVariable.

Returns:: the AccessLevel for the DataVariable.

Implements UaVariable.

void UaPropertyMethodArgument::arrayDimensions ( UaUInt32Array & arrayDimensions ) const [virtual]

Get the arrayDimensions value for the passed UaNode.

Parameters:

arrayDimensions the arrayDimensions value for the passed UaNode.

Implements UaVariable.

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

UaQualifiedName UaPropertyMethodArgument::browseName ( ) const [virtual]

Get the browseName as QualifiedName of the current Node.

Returns:: the BrowseName for the DataVariable as QualifiedName.

Implements UaNode.

UaNodeId UaPropertyMethodArgument::dataType ( ) const [virtual]

Get the DataType for the DataVariable.

Returns:: the DataType for the DataVariable.

Implements UaVariable.

UaLocalizedText UaPropertyMethodArgument::description ( Session * pSession ) const [virtual]

Get the description as LocalizedText of the current Node.

Parameters:

pSession Interface to the Session context for the method call

Returns:: the LocalizedText of the current Node.

Implements UaNode.

UaLocalizedText UaPropertyMethodArgument::displayName ( Session * pSession ) const [virtual]

Get the displayName as LocalizedText of the current Node.

Parameters:

pSession Interface to the Session context for the method call

Returns:: the LocalizedText of the current Node.

Implements UaNode.

UaNode* UaPropertyMethodArgument::getUaNode ( ) const [inline, virtual]

Get the Node.

Returns:: the current searched Node.

Implements UaReferenceLists.

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

OpcUa_Boolean UaPropertyMethodArgument::historizing ( ) const [virtual]

Indicates if historizing is available or not.

Returns:: TRUE if historizing is available FALSE if not.

Implements UaVariable.

OpcUa_Boolean UaPropertyMethodArgument::isArrayDimensionsSupported ( ) const [virtual]

Check if the Node is ArrayDimensionsSupported.

Returns:: FALSE if not supported.

Implements UaVariable.

OpcUa_Boolean UaPropertyMethodArgument::isDescriptionSupported ( ) const [virtual]

Check if Node is DescriptionSupported.

Returns:: FALSE if not supported.

Implements UaNode.

OpcUa_Boolean UaPropertyMethodArgument::isMinimumSamplingIntervalSupported ( ) const [virtual]

Check wether a minimum sampling interval is supported.

Returns:: TRUE if supported FALSE if not.

Implements UaVariable.

OpcUa_Boolean UaPropertyMethodArgument::isUserWriteMaskSupported ( ) const [virtual]

Check if Node is UserWriteMaskSupported.

Returns:: TRUE if Node is UserWriteMaskSupported.

Implements UaNode.

OpcUa_Boolean UaPropertyMethodArgument::isWriteMaskSupported ( ) const [virtual]

Check if Node is WriteMaskSupported.

Returns:: TRUE if Node is WriteMaskSupported.

Implements UaNode.

OpcUa_Double UaPropertyMethodArgument::minimumSamplingInterval ( ) const [virtual]

Get the minimum sampling interval of the Node.

Returns:: the minimum sampling interval.

Implements UaVariable.

UaNodeId UaPropertyMethodArgument::nodeId ( ) const [virtual]

Get the NodeId for the DataVariable.

Returns:: the NodeId for the DataVariable.

Implements UaNode.

OpcUa_StatusCode UaPropertyMethodArgument::setArgument	(	OpcUa_UInt32	index,
		const UaString &	name,
		const UaNodeId &	dataType,
		OpcUa_Int32	valueRank,
		const UaUInt32Array &	arrayDimensions,
		const UaLocalizedText &	description
	)

Set one of the arguments in the argument list.

Parameters:

index	the index where the new item is stored.
name	the name of the new item.
dataType	the DataType of the DataVariable.
valueRank	the ValueRank of the DataVariable.
arrayDimensions	the arrayDimensions value for the passed UaNode.
description	the description as LocalizedText of the current Node.

Returns:: Error code

UaStatus UaPropertyMethodArgument::setValue	(	Session *	pSession,
		const UaDataValue &	dataValue,
		OpcUa_Boolean	checkAccessLevel
	)		`[virtual]`

Sets the current value for the DataVariable.

Parameters:

pSession	Interface to the Session context for the method call
dataValue	Cached value of the DataVariable.
checkAccessLevel	checks the Access Level of the current Session.

Returns:: Error code

Implements UaVariable.

UaNodeId UaPropertyMethodArgument::typeDefinitionId ( ) const [virtual]

Get the object type NodeId for the server object.

Returns:: the object type NodeId for the server object.

Reimplemented from UaNode.

OpcUa_Byte UaPropertyMethodArgument::userAccessLevel ( Session * pSession ) const [virtual]

Get the UserAccessLevel for the DataVariable.

Parameters:

pSession Interface to the Session context for the method call

Returns:: the UserAccessLevel for the DataVariable.

Implements UaVariable.

OpcUa_UInt32 UaPropertyMethodArgument::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.

UaDataValue UaPropertyMethodArgument::value ( Session * pSession ) [virtual]

Sets the current value for the DataVariable.

Parameters:

pSession Interface to the Session context for the method call

Returns:: the current value for the DataVariable.

Implements UaVariable.

OpcUa_Int32 UaPropertyMethodArgument::valueRank ( ) const [virtual]

Get the ValueRank for the DataVariable.

Returns:: the ValueRank for the DataVariable.

Implements UaVariable.

OpcUa_UInt32 UaPropertyMethodArgument::writeMask ( ) const [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/uadatavariablecache.h
/home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/uadatavariablecache.cpp

UaPropertyMethodArgument Class Reference

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation