C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
HistoryVariableHandle Class Reference

HistoryVariableHandle. More...

#include <variablehandle.h>

Inherits ReferenceCounter.

Inherited by HistoryVariableHandleNodeId, and HistoryVariableHandleUaNode.

Public Types

enum  ServiceType {
  ServiceReadEvents, ServiceReadRaw, ServiceReadModified, ServiceReadProcessed,
  ServiceReadAtTime, ServiceUpdateData, ServiceUpdateStructureData, ServiceUpdateEvent,
  ServiceDeleteRaw, ServiceDeleteAtTime, ServiceDeleteEvent
}
 Enumeration for the different history service options. More...
 
enum  HandleImplementation { CUSTOM, NODE_ID, UA_NODE }
 Enumeration for the different HistoryVariableHandle implementations. More...
 

Public Member Functions

 HistoryVariableHandle ()
 construction
 
virtual NodeAccessInfogetAccessInfo () const
 Returns the NodeAccessInfo for the Node related to the HistoryVariableHandle The NodeAccessInfo is reference counted. More...
 
virtual UaStatus setAccessInfo (NodeAccessInfo *pNodeAccessInfo)
 Sets the NodeAccessInfo of the Node related to the HistoryVariableHandle 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 HistoryVariableHandle. More...
 
virtual UaStatus setAccessLevel (OpcUa_UInt32 accessLevelEx)
 Sets the extended AccessLevel of the Node related to the HistoryVariableHandle. More...
 
virtual HandleImplementation getHandleImplementation () const
 Returns the type of handle implementation.
 
- Public Member Functions inherited from ReferenceCounter
 ReferenceCounter ()
 construction
 
virtual ~ReferenceCounter ()
 destruction
 

Public Attributes

HistoryManagerm_pHistoryManager
 Interface of the history manager responsible for this variable.
 

Protected Member Functions

virtual ~HistoryVariableHandle ()
 destruction
 

Detailed Description

HistoryVariableHandle.

Base class for the History Variable Handle used in history access methods. Derived from ReferenceCounter. It is not possible to create shallow copies of this Class.

Member Enumeration Documentation

Enumeration for the different HistoryVariableHandle implementations.

Enumerator
CUSTOM 

A product specific handle implementation is used

NODE_ID 

The class HistoryVariableHandleNodeId is used

UA_NODE 

The class HistoryVariableHandleUaNode is used

Enumeration for the different history service options.

Enumerator
ServiceReadEvents 

Service HistoryRead with ReadEventDetails for read events

ServiceReadRaw 

Service HistoryRead with ReadRawModifiedDetails for read raw data

ServiceReadModified 

Service HistoryRead with ReadRawModifiedDetails for read modified data

ServiceReadProcessed 

Service HistoryRead with ReadProcessedDetails for read processed data

ServiceReadAtTime 

Service HistoryRead with ReadAtTimeDetails for read data at a list of timestamps

ServiceUpdateData 

Service HistoryUpdate with UpdateDataDetails for update of data

ServiceUpdateStructureData 

Service HistoryUpdate with UpdateStructureDataDetails for update of structure data like Anotations

ServiceUpdateEvent 

Service HistoryUpdate with UpdateEventDetails for update of events

ServiceDeleteRaw 

Service HistoryUpdate with DeleteRawModifiedDetails for deletion of raw or modified data

ServiceDeleteAtTime 

Service HistoryUpdate with DeleteAtTimeDetails for deletion of data at a list of timestamps

ServiceDeleteEvent 

Service HistoryUpdate with DeleteEventDetails for deletion of events

Member Function Documentation

NodeAccessInfo * HistoryVariableHandle::getAccessInfo ( ) const
virtual

Returns the NodeAccessInfo for the Node related to the HistoryVariableHandle 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 HistoryVariableHandleNodeId.

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

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

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.

Reimplemented in HistoryVariableHandleNodeId.

UaStatus HistoryVariableHandle::setAccessInfo ( NodeAccessInfo pNodeAccessInfo)
virtual

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

The default implementation returns bad status.

Reimplemented in HistoryVariableHandleNodeId.

UaStatus HistoryVariableHandle::setAccessLevel ( OpcUa_UInt32  accessLevelEx)
virtual

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

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.

Reimplemented in HistoryVariableHandleNodeId.


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