UaDataVariableCacheEx Class Reference

Highly optimized class providing the UaVariable interface. This class is using a instance declaration variable to provide all other attributes other than the value attribute. It is not possible to use the default constructor. More...

#include <uadatavariablecache.h>

Inheritance diagram for UaDataVariableCacheEx:

[legend]

Collaboration diagram for UaDataVariableCacheEx:

[legend]

List of all members.


Public Member Functions
	UaDataVariableCacheEx (UaNode pParentNode, UaVariable pInstanceDeclaration)
virtual	~UaDataVariableCacheEx ()
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 (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 UaDataValue	value (Session *pSession)
virtual UaStatus	setValue (Session *pSession, 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

Detailed Description

Highly optimized class providing the UaVariable interface. This class is using a instance declaration variable to provide all other attributes other than the value attribute. It is not possible to use the default constructor.

UaDataVariableCacheEx

Constructor & Destructor Documentation

UaDataVariableCacheEx::UaDataVariableCacheEx	(	UaNode *	pParentNode,
		UaVariable *	pInstanceDeclaration
	)

construction

UaDataVariableCacheEx::~UaDataVariableCacheEx ( ) [virtual]

destruction

Member Function Documentation

UaReferenceLists* UaDataVariableCacheEx::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 UaDataVariableCacheEx::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 UaDataVariableCacheEx::typeDefinitionId ( ) const [virtual]

Get the object type NodeId for the server object.

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

Implements UaNode.

Reimplemented in UaAnalogItemCacheEx, and UaPropertyCacheEx.

UaNodeId UaDataVariableCacheEx::nodeId ( ) const [virtual]

Get the NodeId for the DataVariable.

Returns:: the NodeId for the DataVariable.

Implements UaNode.

UaQualifiedName UaDataVariableCacheEx::browseName ( ) const [virtual]

Get the browseName as QualifiedName of the current Node.

Returns:: the BrowseName for the DataVariable as QualifiedName.

Implements UaNode.

UaLocalizedText UaDataVariableCacheEx::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 UaDataVariableCacheEx::isDescriptionSupported ( ) const [virtual]

Check if Node is DescriptionSupported.

Returns:: FALSE if not supported.

Implements UaNode.

UaLocalizedText UaDataVariableCacheEx::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 UaDataVariableCacheEx::isWriteMaskSupported ( ) const [virtual]

Check if Node is WriteMaskSupported.

Returns:: TRUE if Node is WriteMaskSupported.

Implements UaNode.

OpcUa_UInt32 UaDataVariableCacheEx::writeMask ( ) const [virtual]

Get the writeMask of the current Node.

Returns:: the writeMask.

Implements UaNode.

OpcUa_Boolean UaDataVariableCacheEx::isUserWriteMaskSupported ( ) const [virtual]

Check if Node is UserWriteMaskSupported.

Returns:: TRUE if Node is UserWriteMaskSupported.

Implements UaNode.

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

UaStatus UaDataVariableCacheEx::setValue	(	Session *	pSession,
		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 UaDataVariableCacheEx::dataType ( ) const [virtual]

Get the DataType for the DataVariable.

Returns:: the DataType for the DataVariable.

Implements UaVariable.

OpcUa_Int32 UaDataVariableCacheEx::valueRank ( ) const [virtual]

Get the ValueRank for the DataVariable.

Returns:: the ValueRank for the DataVariable.

Implements UaVariable.

OpcUa_Boolean UaDataVariableCacheEx::isArrayDimensionsSupported ( ) const [virtual]

Check if the Node is ArrayDimensionsSupported.

Returns:: FALSE if not supported.

Implements UaVariable.

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

Get the arrayDimensions value for the passed UaNode.

Parameters:

arrayDimensions

the arrayDimensions value for the passed UaNode.

Implements UaVariable.

OpcUa_Byte UaDataVariableCacheEx::accessLevel ( ) const [virtual]

Get the AccessLevel for the DataVariable.

Returns:: the AccessLevel for the DataVariable.

Implements UaVariable.

OpcUa_Byte UaDataVariableCacheEx::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_Boolean UaDataVariableCacheEx::isMinimumSamplingIntervalSupported ( ) const [virtual]

Check wether a minimum sampling interval is supported.

Returns:: TRUE if supported FALSE if not.

Implements UaVariable.

OpcUa_Double UaDataVariableCacheEx::minimumSamplingInterval ( ) const [virtual]

Get the minimum sampling interval of the Node.

Returns:: the minimum sampling interval.

Implements UaVariable.

OpcUa_Boolean UaDataVariableCacheEx::historizing ( ) const [virtual]

Indicates if historizing is available or not.

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

Implements UaVariable.

UaNode* UaDataVariableCacheEx::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

UaDataVariableCacheEx Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation