UaMonitoredItem Class Reference

UaMonitoredItem. More...

#include <uamonitoreditem.h>

Inherited by UaMonitoredItemData, and UaMonitoredItemEvent.

Public Types
enum	MonitoredItemType { DATA, EVENT }
	MonitoredItem type enumeration. More...

Public Member Functions
	UaMonitoredItem (const UaNodeId &nodeId, OpcUa_MonitoringMode MonitoringMode, OpcUa_Int32 ClientHandle, OpcUa_Double SamplingInterval, UaSubscription *pUaSubscription)
	construction More...
virtual	~UaMonitoredItem ()
	destruction
virtual MonitoredItemType	type () const =0
	Get the type of monitored item. More...
virtual OpcUa_Boolean	hasChanged ()=0
	Check if the value or status of the item has changed. More...
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...
virtual void	setMonitoringMode (OpcUa_MonitoringMode monitoringMode)
	Set the Monitoring Mode. 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.
virtual void	reset ()=0
	Deletes all queued datachanges / events and resets flags to the state of creation.

Protected Attributes
UaSubscription *	m_pUaSubscription
	Parent subscription for the monitored item.

Detailed Description

UaMonitoredItem.

Implements a UA monitored item. It is not possible to create shallow copies of this class. It is not possible to use the default constructor.

Member Enumeration Documentation

enum UaMonitoredItem::MonitoredItemType

MonitoredItem type enumeration.

Enumerator
DATA	Data monitored item used to monitor node attributes like the Value attribute for data changes
EVENT	Event monitored item used to monitor the event notifier attribute of objects for event notifications

Constructor & Destructor Documentation

UaMonitoredItem::UaMonitoredItem	(	const UaNodeId &	nodeId,
		OpcUa_MonitoringMode	MonitoringMode,
		OpcUa_Int32	ClientHandle,
		OpcUa_Double	SamplingInterval,
		UaSubscription *	pUaSubscription
	)

construction

Parameters

nodeId	The Id of the given Node.
MonitoringMode	the mode for monitoring items.
ClientHandle	a handle to the client.
SamplingInterval	the value in MS for a Interval of a Variable.
pUaSubscription	The subscription of the given Node.

Member Function Documentation

OpcUa_Int32 UaMonitoredItem::clientHandle ( ) const

inline

Get the client handle of the monitored item.

Returns

the client handle of the monitored item

virtual OpcUa_Boolean UaMonitoredItem::hasChanged ( )

pure virtual

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

Returns

true if changed false if not.

Implemented in UaMonitoredItemEvent, and UaMonitoredItemData.

std::list<OpcUa_UInt32>* UaMonitoredItem::links ( )

inline

Returns the triggering links of the monitored item.

Returns

Triggering links of the monitored item.

OpcUa_MonitoringMode UaMonitoredItem::monitoringMode ( ) const

inline

Get the monitoring mode of the monitored item.

Returns

the monitoring mode of the monitored item

UaNodeId UaMonitoredItem::nodeId ( ) const

inline

NodeId of the node monitored with this item.

Returns

NodeId used for the monitored item

OpcUa_Double UaMonitoredItem::samplingInterval ( ) const

inline

Get the sampling rate of the monitored item.

Returns

the sampling rate of the monitored item

void UaMonitoredItem::setClientHandle ( OpcUa_Int32  clientHandle )

inline

Set the client handle of the monitored item.

Parameters

clientHandle

New client handle for the monitored item

void UaMonitoredItem::setLinks ( std::list< OpcUa_UInt32 > *  pLinks )

inline

Sets the triggering links of the monitored item.

Parameters

pLinks

the triggering links the monitored item

virtual void UaMonitoredItem::setMonitoringMode ( OpcUa_MonitoringMode  monitoringMode )

inlinevirtual

Set the Monitoring Mode.

Parameters

monitoringMode

the Monitoring Mode

Reimplemented in UaMonitoredItemEvent, and UaMonitoredItemData.

void UaMonitoredItem::setSamplingInterval ( OpcUa_Double  samplingInterval )

inline

Set the sampling rate of the monitored item.

Parameters

samplingInterval

the sampling rate of the monitored item

virtual MonitoredItemType UaMonitoredItem::type ( ) const

pure virtual

Get the type of monitored item.

Returns

the type of monitored item

Implemented in UaMonitoredItemEvent, and UaMonitoredItemData.

OpcUa_Boolean UaMonitoredItem::wasTriggered ( ) const

inline

Check if the item triggered.

Returns

true if triggered false if not.

---

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

• C:/work/uasdkcpp/src/uaserver/uaservercpp/uamodule/uamonitoreditem.h
• C:/work/uasdkcpp/src/uaserver/uaservercpp/uamodule/uamonitoreditem.cpp