C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537

Base class for the variable handle used in data access methods. More...

#include <variablehandle.h>

Inherits ReferenceCounter.

Inherited by VariableHandleUaNode.

Public Types

enum  ServiceType { ServiceRead, ServiceWrite, ServiceMonitoring, ServiceRegister }
 This enumeration indicates the type of action this variable handle is used for. More...
 

Public Member Functions

 VariableHandle ()
 construction
 
virtual NodeAccessInfogetAccessInfo () const
 Returns the NodeAccessInfo for the Node related to the VariableHandle The NodeAccessInfo is reference counted. More...
 
virtual UaStatus setAccessInfo (NodeAccessInfo *pNodeAccessInfo)
 Sets the NodeAccessInfo of the Node related to the VariableHandle Returns a bad status if the NodeAccessInfo cannot be stored in the derived class. More...
 
virtual bool getAccessLevel (OpcUa_UInt32 &accessLevelEx) const
 Returns the extended AccessLevel for the Node related to the VariableHandle. More...
 
virtual UaStatus setAccessLevel (OpcUa_UInt32 accessLevelEx)
 Sets the extended AccessLevel of the Node related to the VariableHandle. More...
 
- Public Member Functions inherited from ReferenceCounter
 ReferenceCounter ()
 construction
 
virtual ~ReferenceCounter ()
 destruction
 

Public Attributes

IOManagerm_pIOManager
 Interface pointer of the responsible IOManager for the node.
 
OpcUa_Int32 m_AttributeID
 Requested attribute for the action.
 

Protected Member Functions

virtual ~VariableHandle ()
 destruction
 

Detailed Description

Base class for the variable handle used in data access methods.

The content of this class is used by the server SDK to multiplex access to node attributes to 1 to N IOManagers per NodeManager. Therefore this class contains the interface pointer of the responsible IOManager for the node and the attribute id. NodeManagers can use derived classes to add more information for the responsible IOManager. The class is derived from ReferenceCounter to control the life time of the object through reference counting.

Member Function Documentation

NodeAccessInfo * VariableHandle::getAccessInfo ( ) const
virtual

Returns the NodeAccessInfo for the Node related to the VariableHandle The NodeAccessInfo is reference counted.

The reference counter is incremented before returning the pointer. The caller is responsible to release the reference again.

Returns Null if the NodeAccessInfo is not available or the derived class does not have access to the NodeAccessInfo. The default implementation returns always Null.

Reimplemented in VariableHandleUaNode.

bool VariableHandle::getAccessLevel ( OpcUa_UInt32 &  accessLevelEx) const
virtual

Returns the extended AccessLevel for the Node related to the VariableHandle.

The extended AccessLevel is a UInt32 and contains the AccessLevel with data type Byte.

Returns false if the AccessLevel is not available or the derived class does not have access to the AccessLevel.

The default implementation returns always false.

UaStatus VariableHandle::setAccessInfo ( NodeAccessInfo pNodeAccessInfo)
virtual

Sets the NodeAccessInfo of the Node related to the VariableHandle Returns a bad status if the NodeAccessInfo cannot be stored in the derived class.

The default implementation returns bad status.

UaStatus VariableHandle::setAccessLevel ( OpcUa_UInt32  accessLevelEx)
virtual

Sets the extended AccessLevel of the Node related to the VariableHandle.

The extended AccessLevel is a UInt32 and contains the AccessLevel with data type Byte.

Returns a bad status if the AccessLevel cannot be stored in the derived class.

The default implementation returns bad status.


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