UaDataVariableDevice Class Reference
[Core Module Address Model Classes]

Derived from UaVariable and UaReferenceLists. It is not possible to use the default constructor. More...

#include <uaobjecttypes.h>

Inheritance diagram for UaDataVariableDevice:

Inheritance graph
[legend]
Collaboration diagram for UaDataVariableDevice:

Collaboration graph
[legend]

List of all members.


Public Member Functions

 UaDataVariableDevice (const UaString &name, const UaNodeId &nodeId, const UaNodeId &dataType, OpcUa_Int32 valueRank, OpcUa_Byte accessLevel, const UaString &defaultLocaleId)
virtual ~UaDataVariableDevice ()
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
virtual OpcUa_UInt32 valueHandling () const
UaNode * getUaNode () const

Detailed Description

Derived from UaVariable and UaReferenceLists. It is not possible to use the default constructor.

UaDataVariableDevice

Constructor & Destructor Documentation

UaDataVariableDevice::UaDataVariableDevice ( const UaString &  name,
const UaNodeId &  nodeId,
const UaNodeId &  dataType,
OpcUa_Int32  valueRank,
OpcUa_Byte  accessLevel,
const UaString &  defaultLocaleId 
)

construction

UaDataVariableDevice::~UaDataVariableDevice (  )  [virtual]

destruction

Member Function Documentation

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

Get the object type NodeId for the server object.

Returns:
the object type NodeId for the server object.

Implements UaNode.

UaNodeId UaDataVariableDevice::nodeId (  )  const [virtual]

Get the NodeId of the current Node.

Returns:
the NodeId of the current Node.

Implements UaNode.

UaQualifiedName UaDataVariableDevice::browseName (  )  const [virtual]

Get the browseName as QualifiedName of the current Node.

Returns:
the browseName as QualifiedName.

Implements UaNode.

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

Check if Node is DescriptionSupported.

Returns:
FALSE if not supported.

Implements UaNode.

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

Check if Node is WriteMaskSupported.

Returns:
TRUE if Node is WriteMaskSupported.

Implements UaNode.

OpcUa_UInt32 UaDataVariableDevice::writeMask (  )  const [virtual]

Get the writeMask of the current Node.

Returns:
the writeMask.

Implements UaNode.

OpcUa_Boolean UaDataVariableDevice::isUserWriteMaskSupported (  )  const [virtual]

Check if Node is UserWriteMaskSupported.

Returns:
TRUE if Node is UserWriteMaskSupported.

Implements UaNode.

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

UaDataValue UaDataVariableDevice::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 UaDataVariableDevice::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 UaDataVariableDevice::dataType (  )  const [virtual]

Get the DataType for the DataVariable.

Returns:
the DataType for the DataVariable.

Implements UaVariable.

OpcUa_Int32 UaDataVariableDevice::valueRank (  )  const [virtual]

Get the ValueRank for the DataVariable.

Returns:
the ValueRank for the DataVariable.

Implements UaVariable.

OpcUa_Boolean UaDataVariableDevice::isArrayDimensionsSupported (  )  const [virtual]

Check if the Node is ArrayDimensionsSupported.

Returns:
FALSE if not supported.

Implements UaVariable.

void UaDataVariableDevice::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 UaDataVariableDevice::accessLevel (  )  const [virtual]

Get the AccessLevel for the DataVariable.

Returns:
the AccessLevel for the DataVariable.

Implements UaVariable.

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

Check wether a minimum sampling interval is supported.

Returns:
TRUE if supported FALSE if not.

Implements UaVariable.

OpcUa_Double UaDataVariableDevice::minimumSamplingInterval (  )  const [virtual]

Get the minimum sampling interval of the Node.

Returns:
the minimum sampling interval.

Implements UaVariable.

OpcUa_Boolean UaDataVariableDevice::historizing (  )  const [virtual]

Indicates if historizing is available or not.

Returns:
TRUE if historizing is available FALSE if not.

Implements UaVariable.

virtual OpcUa_UInt32 UaDataVariableDevice::valueHandling (  )  const [inline, virtual]

Get the handling of a Value (UaVariable_Value_Cache or UaVariable_Value_CacheIsSource).

Returns:
the handling of a Value.

Reimplemented from UaVariable.

UaNode* UaDataVariableDevice::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/uaobjecttypes.h
  • src/uaserver/uaservercpp/coremodule/uaobjecttypes.cpp