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

Represents a data MonitoredItem in durable subscriptions. More...

#include <uamonitoreditem.h>

Inherits UaMonitoredItemData.

Public Member Functions

 UaMonitoredItemDataDurable (const UaNodeId &nodeId, VariableHandle *pVariableHandle, OpcUa_MonitoringMode MonitoringMode, OpcUa_Int32 ClientHandle, OpcUa_Double SamplingInterval, UaSubscription *pUaSubscription, OpcUa_UInt32 QueueSize, OpcUa_Boolean DiscardOldest, OpcUa_DataChangeTrigger dataChangeTrigger, OpcUa_Int32 attributeId, UaString sIndexRange, OpcUa_UInt32 durableItemHandle, OpcUa_UInt32 liveQueueSize, bool recreated)
 construction More...
 
virtual ~UaMonitoredItemDataDurable ()
 destruction
 
virtual void setShutdown ()
 Set flag that the server is shutting down without client side monitored item deletion.
 
virtual OpcUa_Boolean hasChanged ()
 Check if the value or status of the item has changed. More...
 
virtual void dataChange (const UaDataValue &dataValue, bool changeCheckExecuted=false)
 Signal a change in value or state. More...
 
virtual UaDataValuegetChangedValue ()
 Get changed value from item and reset changed flag. More...
 
virtual OpcUa_UInt32 queueSize ()
 Get the queue size of the monitored item.
 
- Public Member Functions inherited from UaMonitoredItemData
 UaMonitoredItemData (const UaNodeId &nodeId, VariableHandle *pVariableHandle, OpcUa_MonitoringMode MonitoringMode, OpcUa_Int32 ClientHandle, OpcUa_Double SamplingInterval, UaSubscription *pUaSubscription, OpcUa_UInt32 QueueSize, OpcUa_Boolean DiscardOldest, OpcUa_DataChangeTrigger dataChangeTrigger)
 construction More...
 
virtual ~UaMonitoredItemData ()
 destruction
 
MonitoredItemType type () const
 Get the type of monitored item.
 
void setMonitoringMode (OpcUa_MonitoringMode monitoringMode)
 Set the Monitoring Mode. More...
 
void setIOVariableHandle (OpcUa_UInt32 hIOVariable)
 Set the related IOVariable handle. More...
 
void setDiscardPolicy (OpcUa_Boolean discardOldest)
 Set the discard policy for the monitored item. More...
 
OpcUa_Boolean discardOldest () const
 Get the discard policy for the monitored item.
 
void setQueueSize (OpcUa_UInt32 queueSize)
 Set the queue size for the monitored item. More...
 
void setDeadband (OpcUa_Double deadband, OpcUa_DeadbandType deadbandType)
 Set the absolute deadband for the monitored item. More...
 
void setDataChangeTrigger (OpcUa_DataChangeTrigger dataChangeTrigger)
 Set the data change trigger for the monitored item. More...
 
OpcUa_DataChangeTrigger dataChangeTrigger () const
 Get the data change trigger for the monitored item.
 
IOManagerpIOManager () const
 Get the related IOManager.
 
VariableHandlepVariableHandle () const
 Get the related VariableHandle.
 
virtual void reset ()
 Deletes all queued datachanges and resets flags to the state of creation.
 
virtual UaDataValue getLastValue ()
 Get last value send with dataChange.
 
virtual OpcUa_Int32 getRemainingQueueSize ()
 Get the number of free slots in the queue If no queue is provided, the return value is -1.
 
- Public Member Functions inherited from UaMonitoredItem
 UaMonitoredItem (const UaNodeId &nodeId, OpcUa_MonitoringMode MonitoringMode, OpcUa_Int32 ClientHandle, OpcUa_Double SamplingInterval, UaSubscription *pUaSubscription)
 construction More...
 
virtual ~UaMonitoredItem ()
 destruction
 
void setClientHandle (OpcUa_Int32 clientHandle)
 Set the client handle of the monitored item. More...
 
OpcUa_Int32 clientHandle () const
 Get the client handle of the monitored item. More...
 
OpcUa_MonitoringMode monitoringMode () const
 Get the monitoring mode of the monitored item. More...
 
void setSamplingInterval (OpcUa_Double samplingInterval)
 Set the sampling rate of the monitored item. More...
 
OpcUa_Double samplingInterval () const
 Get the sampling rate of the monitored item. More...
 
UaNodeId nodeId () const
 NodeId of the node monitored with this item. More...
 
void setLinks (std::list< OpcUa_UInt32 > *pLinks)
 Sets the triggering links of the monitored item. More...
 
std::list< OpcUa_UInt32 > * links ()
 Returns the triggering links of the monitored item. More...
 
OpcUa_Boolean wasTriggered () const
 Check if the item triggered. More...
 
void resetTriggeredStatus ()
 Sets the triggered status of the monitored item to false.
 
OpcUa_TimestampsToReturn timestampsToReturn () const
 Timestamps to return with a datavalue.
 
void setTimestampsToReturn (OpcUa_TimestampsToReturn timestampsToReturn)
 Sets which timestamps shall be returned with a data value.
 
- Public Member Functions inherited from IOVariableCallback
 IOVariableCallback ()
 Construction.
 
virtual ~IOVariableCallback ()
 Destruction.
 

Additional Inherited Members

- Public Types inherited from UaMonitoredItem
enum  MonitoredItemType { DATA, EVENT }
 MonitoredItem type enumeration. More...
 
- Protected Attributes inherited from UaMonitoredItem
UaSubscriptionm_pUaSubscription
 Parent subscription for the monitored item.
 

Detailed Description

Represents a data MonitoredItem in durable subscriptions.

Constructor & Destructor Documentation

UaMonitoredItemDataDurable::UaMonitoredItemDataDurable ( const UaNodeId nodeId,
VariableHandle pVariableHandle,
OpcUa_MonitoringMode  MonitoringMode,
OpcUa_Int32  ClientHandle,
OpcUa_Double  SamplingInterval,
UaSubscription pUaSubscription,
OpcUa_UInt32  QueueSize,
OpcUa_Boolean  DiscardOldest,
OpcUa_DataChangeTrigger  dataChangeTrigger,
OpcUa_Int32  attributeId,
UaString  sIndexRange,
OpcUa_UInt32  durableItemHandle,
OpcUa_UInt32  liveQueueSize,
bool  recreated 
)

construction

Parameters
nodeIdThe Id of the given Node.
pVariableHandleVariable handle provided by the NodeManager::getVariableHandle.
MonitoringModethe mode for monitoring items.
ClientHandlea handle to the client.
SamplingIntervalthe value in MS for a Interval of a Variable
pUaSubscriptionThe subscription of the given Node.
QueueSizethe size of the queue.
DiscardOldestdiscards the oldest.
dataChangeTriggera trigger that indicates that data has changed.
attributeIdthe ID of the attribute monitored by the item.
sIndexRangethe index range configured for the monitored item.
durableItemHandlethe handle of the item in the durable storage.
liveQueueSizethe live queue size configured for the monitored item.
recreatedflag indicating if the item was created from storage.

Member Function Documentation

void UaMonitoredItemDataDurable::dataChange ( const UaDataValue dataValue,
bool  changeCheckExecuted = false 
)
virtual

Signal a change in value or state.

Parameters
dataValuethe requested Value for this operation.

Reimplemented from UaMonitoredItemData.

UaDataValue * UaMonitoredItemDataDurable::getChangedValue ( )
virtual

Get changed value from item and reset changed flag.

Returns
the changed value from item and reset changed flag.

Reimplemented from UaMonitoredItemData.

OpcUa_Boolean UaMonitoredItemDataDurable::hasChanged ( )
virtual

Check if the value or status of the item has changed.

Returns
true if changed false if not.

Reimplemented from UaMonitoredItemData.


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