UaMonitoredItem Class Reference

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

#include <uamonitoreditem.h>

Inheritance diagram for UaMonitoredItem:

Collaboration diagram for UaMonitoredItem:

List of all members.

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)
virtual	~UaMonitoredItem ()
virtual MonitoredItemType	type () const =0
virtual OpcUa_Boolean	hasChanged ()=0
void	setClientHandle (OpcUa_Int32 clientHandle)
OpcUa_Int32	clientHandle () const
virtual void	setMonitoringMode (OpcUa_MonitoringMode monitoringMode)
OpcUa_MonitoringMode	monitoringMode () const
void	setSamplingInterval (OpcUa_Double samplingInterval)
OpcUa_Double	samplingInterval () const
UaNodeId	nodeId () const
void	setLinks (std::list< OpcUa_UInt32 > *pLinks)
std::list< OpcUa_UInt32 > *	links ()
OpcUa_Boolean	wasTriggered () const
void	resetTriggeredStatus ()
OpcUa_TimestampsToReturn	timestampsToReturn () const
Protected Attributes
UaSubscription *	m_pUaSubscription

---

Detailed Description

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

UaMonitoredItem

---

Member Enumeration Documentation

enum UaMonitoredItem::MonitoredItemType

MonitoredItem type enumeration.

Enumerator:

DATA	MonitoredItemType: Data
EVENT	MonitoredItemType: Event

---

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.

UaMonitoredItem::~UaMonitoredItem

(

)

[virtual]

destruction

---

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 UaMonitoredItemData, and UaMonitoredItemEvent.

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

void UaMonitoredItem::resetTriggeredStatus

(

)

[inline]

Sets the triggered status of the monitored item to false.

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 )

[inline, virtual]

Set the Monitoring Mode

Parameters:

monitoringMode

the Monitoring Mode

Reimplemented in UaMonitoredItemData, and UaMonitoredItemEvent.

void UaMonitoredItem::setSamplingInterval

(

OpcUa_Double

samplingInterval )

[inline]

Set the sampling rate of the monitored item

Parameters:

samplingInterval

the sampling rate of the monitored item

OpcUa_TimestampsToReturn UaMonitoredItem::timestampsToReturn

(

)

const [inline]

Timestamps to return with a datavalue

virtual MonitoredItemType UaMonitoredItem::type

(

)

const [pure virtual]

Get the type of monitored item

Returns:

the type of monitored item

Implemented in UaMonitoredItemData, and UaMonitoredItemEvent.

OpcUa_Boolean UaMonitoredItem::wasTriggered

(

)

const [inline]

Check if the item triggered

Returns:

true if triggered false if not.

---

Member Data Documentation

UaSubscription* UaMonitoredItem::m_pUaSubscription [protected]

Parent subscription for the monitored item

---

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

• /home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/uamodule/uamonitoreditem.h
• /home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/uamodule/uamonitoreditem.cpp