C++ Based OPC UA Client/Server SDK  1.5.5.355
CacheVariableConnector Class Reference

Class connecting a UaVariableCache object with a monitoring item. More...

#include <uadatavariablecache.h>

Inherits SamplingExecution, and CacheSignal.

Inherited by SamplingItemCache.

Public Member Functions

 CacheVariableConnector (OpcUa_Int32 samplingInterval, UaVariableCache *pUaVariableCache, IOVariableCallback *pIOVariableCallback, Session *pSession)
 Constructs a CacheVariableConnector object. More...
 
virtual ~CacheVariableConnector ()
 Destroys the CacheVariableConnector object.
 
IOVariableCallbackpIOVariableCallback ()
 Get IOVariableCallback used for the variable. More...
 
UaVariableCachepUaVariableCache ()
 Get UaVariableCache used for the variable. More...
 
void setSamplingRate (OpcUa_UInt32 samplingRate)
 Set the sampling rate of the item. More...
 
virtual void sample ()
 Sample signal for the item.
 
virtual void setChanged ()
 Signal a change in value or state.
 
virtual OpcUa_UInt32 getSamplingRate ()
 Get the sampling rate of the item. More...
 
virtual void setInvalid ()
 Set the item invalid.
 
virtual void setValid (UaVariableCache *pUaVariableCache)
 Set the item valid.
 
virtual OpcUa_UInt32 hIOVariable ()
 Get the item handle for the signal defined by the IOManager.
 
virtual void sethIOVariable (OpcUa_UInt32 handle)
 Set the item handle for the signal defined by the IOManager.
 
- Public Member Functions inherited from SamplingExecution
 SamplingExecution ()
 construction
 
virtual ~SamplingExecution ()
 destruction
 
- Public Member Functions inherited from CacheSignal
virtual ~CacheSignal ()
 destruction
 
virtual UaNumericRangegetIndexRange ()
 Get the index range for the sampling item. More...
 
virtual OpcUa_Boolean isPercentDeadband (OpcUa_Double &absoluteChange)
 Indicates if percent deadband is requested and provides the value of the absulute change necessary to pass the deadband filter. More...
 

Detailed Description

Class connecting a UaVariableCache object with a monitoring item.

This class is used to connect a UaVariableCache object with a monitored item for sampling data by implementing the interfaces CacheSignal and SamplingEngine

Constructor & Destructor Documentation

CacheVariableConnector::CacheVariableConnector ( OpcUa_Int32  samplingInterval,
UaVariableCache pUaVariableCache,
IOVariableCallback pIOVariableCallback,
Session pSession 
)

Constructs a CacheVariableConnector object.

Parameters
[in]samplingIntervalThis interval defines the sampling rate of the monitored item
[in]pUaVariableCacheUaVariableCache used in the monitored item
[in]pIOVariableCallbackCallback interface for data changes
[in]pSessionSession object responsible for the sampling item

Member Function Documentation

OpcUa_UInt32 CacheVariableConnector::getSamplingRate ( )
virtual

Get the sampling rate of the item.

Returns
the sampling rate of the item.

Implements CacheSignal.

IOVariableCallback* CacheVariableConnector::pIOVariableCallback ( )
inline

Get IOVariableCallback used for the variable.

Returns
the IOVariableCallback used for the variable
UaVariableCache* CacheVariableConnector::pUaVariableCache ( )
inline

Get UaVariableCache used for the variable.

Returns
the UaVariableCache used for the variable
void CacheVariableConnector::setSamplingRate ( OpcUa_UInt32  samplingRate)
inline

Set the sampling rate of the item.

Parameters
samplingRatethe sampling Rate in Milliseconds.

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