Wrapper class for the UA stack structure OpcUa_SubscriptionDiagnosticsDataType. More...

#include <uasubscriptiondiagnosticsdatatype.h>

Public Member Functions
	UaSubscriptionDiagnosticsDataType ()
	Constructs an instance of the class UaSubscriptionDiagnosticsDataType with empty default values.

	UaSubscriptionDiagnosticsDataType (const UaSubscriptionDiagnosticsDataType &other)
	Constructs an instance of the class UaSubscriptionDiagnosticsDataType with values from another UaSubscriptionDiagnosticsDataType object. More...

	UaSubscriptionDiagnosticsDataType (const OpcUa_SubscriptionDiagnosticsDataType &other)
	Constructs an instance of the class UaSubscriptionDiagnosticsDataType with values from another OpcUa_SubscriptionDiagnosticsDataType structure. More...

	UaSubscriptionDiagnosticsDataType (const UaNodeId &sessionId, OpcUa_UInt32 subscriptionId, OpcUa_Byte priority, OpcUa_Double publishingInterval, OpcUa_UInt32 maxKeepAliveCount, OpcUa_UInt32 maxLifetimeCount, OpcUa_UInt32 maxNotificationsPerPublish, OpcUa_Boolean publishingEnabled, OpcUa_UInt32 modifyCount, OpcUa_UInt32 enableCount, OpcUa_UInt32 disableCount, OpcUa_UInt32 republishRequestCount, OpcUa_UInt32 republishMessageRequestCount, OpcUa_UInt32 republishMessageCount, OpcUa_UInt32 transferRequestCount, OpcUa_UInt32 transferredToAltClientCount, OpcUa_UInt32 transferredToSameClientCount, OpcUa_UInt32 publishRequestCount, OpcUa_UInt32 dataChangeNotificationsCount, OpcUa_UInt32 eventNotificationsCount, OpcUa_UInt32 notificationsCount, OpcUa_UInt32 latePublishRequestCount, OpcUa_UInt32 currentKeepAliveCount, OpcUa_UInt32 currentLifetimeCount, OpcUa_UInt32 unacknowledgedMessageCount, OpcUa_UInt32 discardedMessageCount, OpcUa_UInt32 monitoredItemCount, OpcUa_UInt32 disabledMonitoredItemCount, OpcUa_UInt32 monitoringQueueOverflowCount, OpcUa_UInt32 nextSequenceNumber, OpcUa_UInt32 eventQueueOverFlowCount)
	Constructs an instance of the class UaSubscriptionDiagnosticsDataType with values provided in the constructor.

	UaSubscriptionDiagnosticsDataType (const UaExtensionObject &extensionObject)
	Constructs an instance of the class UaSubscriptionDiagnosticsDataType initialized with value from a UaExtensionObject. More...

	UaSubscriptionDiagnosticsDataType (const OpcUa_ExtensionObject &extensionObject)
	Constructs an instance of the class UaSubscriptionDiagnosticsDataType initialized with value from an OpcUa_ExtensionObject structure. More...

	~UaSubscriptionDiagnosticsDataType ()
	Destroys the UaSubscriptionDiagnosticsDataType object.

void	clear ()
	Clear the data of the UaSubscriptionDiagnosticsDataType. More...

bool	operator== (const UaSubscriptionDiagnosticsDataType &other) const
	Compare two UaSubscriptionDiagnosticsDataType for equality. More...

bool	operator!= (const UaSubscriptionDiagnosticsDataType &other) const
	Compare two UaSubscriptionDiagnosticsDataType for inequality. More...

UaSubscriptionDiagnosticsDataType &	operator= (const UaSubscriptionDiagnosticsDataType &other)
	Assignment operator. More...

OpcUa_SubscriptionDiagnosticsDataType *	copy () const
	Copy UaSubscriptionDiagnosticsDataType data to a newly allocated OpcUa_SubscriptionDiagnosticsDataType. More...

void	copyTo (OpcUa_SubscriptionDiagnosticsDataType *pDst) const
	Copy UaSubscriptionDiagnosticsDataType data to an existing OpcUa_SubscriptionDiagnosticsDataType structure. More...

void	attach (OpcUa_SubscriptionDiagnosticsDataType *pValue)
	Attaches to an existing OpcUa_SubscriptionDiagnosticsDataType structure. More...

OpcUa_SubscriptionDiagnosticsDataType *	detach (OpcUa_SubscriptionDiagnosticsDataType *pDst)
	Detaches the internal SubscriptionDiagnosticsDataType structure from this class. More...

UaNodeId	getSessionId () const
	Server-assigned identifier of the session the subscription belongs to.

OpcUa_UInt32	getSubscriptionId () const
	Server-assigned identifier of the subscription.

OpcUa_Byte	getPriority () const
	The priority the client assigned to the subscription.

OpcUa_Double	getPublishingInterval () const
	The publishing interval of the subscription in milliseconds.

OpcUa_UInt32	getMaxKeepAliveCount () const
	The maximum keep-alive count of the subscription.

OpcUa_UInt32	getMaxLifetimeCount () const
	The maximum lifetime count of the subscription.

OpcUa_UInt32	getMaxNotificationsPerPublish () const
	The maximum number of notifications per publish response.

OpcUa_Boolean	getPublishingEnabled () const
	Whether publishing is enabled for the subscription.

OpcUa_UInt32	getModifyCount () const
	The number of ModifySubscription requests received for the subscription.

OpcUa_UInt32	getEnableCount () const
	The number of times the subscription has been enabled.

OpcUa_UInt32	getDisableCount () const
	The number of times the subscription has been disabled.

OpcUa_UInt32	getRepublishRequestCount () const
	The number of Republish Service requests that have been received and processed for the subscription.

OpcUa_UInt32	getRepublishMessageRequestCount () const
	The total number of messages that have been requested to be republished for the subscription. More...

OpcUa_UInt32	getRepublishMessageCount () const
	The number of messages that have been successfully republished for the subscription.

OpcUa_UInt32	getTransferRequestCount () const
	The total number of TransferSubscriptions Service requests that have been received for the subscription.

OpcUa_UInt32	getTransferredToAltClientCount () const
	The number of times the subscription has been transferred to an alternate client.

OpcUa_UInt32	getTransferredToSameClientCount () const
	The number of times the subscription has been transferred to an alternate session for the same client.

OpcUa_UInt32	getPublishRequestCount () const
	The number of Publish Service requests that have been received and processed for the subscription.

OpcUa_UInt32	getDataChangeNotificationsCount () const
	The number of data change Notifications sent by the subscription.

OpcUa_UInt32	getEventNotificationsCount () const
	The number of Event Notifications sent by the subscription.

OpcUa_UInt32	getNotificationsCount () const
	The total number of Notifications sent by the subscription.

OpcUa_UInt32	getLatePublishRequestCount () const
	The number of times the subscription has entered the LATE State, i.e. More...

OpcUa_UInt32	getCurrentKeepAliveCount () const
	The number of times the subscription has entered the KEEPALIVE State.

OpcUa_UInt32	getCurrentLifetimeCount () const
	The current lifetime count of the subscription.

OpcUa_UInt32	getUnacknowledgedMessageCount () const
	The number of unacknowledged messages saved in the republish queue.

OpcUa_UInt32	getDiscardedMessageCount () const
	The number of messages that were discarded before they were acknowledged.

OpcUa_UInt32	getMonitoredItemCount () const
	The total number of monitored items of the subscription, including the disabled monitored items.

OpcUa_UInt32	getDisabledMonitoredItemCount () const
	The number of disabled monitored items of the subscription.

OpcUa_UInt32	getMonitoringQueueOverflowCount () const
	The number of times a monitored item dropped notifications because of a queue overflow.

OpcUa_UInt32	getNextSequenceNumber () const
	Sequence number for the next notification message.

OpcUa_UInt32	getEventQueueOverFlowCount () const
	The number of times a monitored item in the subscription has generated an Event of type EventQueueOverflowEventType.

void	setSessionId (const UaNodeId &sessionId)
	Server-assigned identifier of the session the subscription belongs to.

void	setSubscriptionId (OpcUa_UInt32 subscriptionId)
	Server-assigned identifier of the subscription.

void	setPriority (OpcUa_Byte priority)
	The priority the client assigned to the subscription.

void	setPublishingInterval (OpcUa_Double publishingInterval)
	The publishing interval of the subscription in milliseconds.

void	setMaxKeepAliveCount (OpcUa_UInt32 maxKeepAliveCount)
	The maximum keep-alive count of the subscription.

void	setMaxLifetimeCount (OpcUa_UInt32 maxLifetimeCount)
	The maximum lifetime count of the subscription.

void	setMaxNotificationsPerPublish (OpcUa_UInt32 maxNotificationsPerPublish)
	The maximum number of notifications per publish response.

void	setPublishingEnabled (OpcUa_Boolean publishingEnabled)
	Whether publishing is enabled for the subscription.

void	setModifyCount (OpcUa_UInt32 modifyCount)
	The number of ModifySubscription requests received for the subscription.

void	setEnableCount (OpcUa_UInt32 enableCount)
	The number of times the subscription has been enabled.

void	setDisableCount (OpcUa_UInt32 disableCount)
	The number of times the subscription has been disabled.

void	setRepublishRequestCount (OpcUa_UInt32 republishRequestCount)
	The number of Republish Service requests that have been received and processed for the subscription.

void	setRepublishMessageRequestCount (OpcUa_UInt32 republishMessageRequestCount)
	The total number of messages that have been requested to be republished for the subscription. More...

void	setRepublishMessageCount (OpcUa_UInt32 republishMessageCount)
	The number of messages that have been successfully republished for the subscription.

void	setTransferRequestCount (OpcUa_UInt32 transferRequestCount)
	The total number of TransferSubscriptions Service requests that have been received for the subscription.

void	setTransferredToAltClientCount (OpcUa_UInt32 transferredToAltClientCount)
	The number of times the subscription has been transferred to an alternate client.

void	setTransferredToSameClientCount (OpcUa_UInt32 transferredToSameClientCount)
	The number of times the subscription has been transferred to an alternate session for the same client.

void	setPublishRequestCount (OpcUa_UInt32 publishRequestCount)
	The number of Publish Service requests that have been received and processed for the subscription.

void	setDataChangeNotificationsCount (OpcUa_UInt32 dataChangeNotificationsCount)
	The number of data change Notifications sent by the subscription.

void	setEventNotificationsCount (OpcUa_UInt32 eventNotificationsCount)
	The number of Event Notifications sent by the subscription.

void	setNotificationsCount (OpcUa_UInt32 notificationsCount)
	The total number of Notifications sent by the subscription.

void	setLatePublishRequestCount (OpcUa_UInt32 latePublishRequestCount)
	The number of times the subscription has entered the LATE State, i.e. More...

void	setCurrentKeepAliveCount (OpcUa_UInt32 currentKeepAliveCount)
	The number of times the subscription has entered the KEEPALIVE State.

void	setCurrentLifetimeCount (OpcUa_UInt32 currentLifetimeCount)
	The current lifetime count of the subscription.

void	setUnacknowledgedMessageCount (OpcUa_UInt32 unacknowledgedMessageCount)
	The number of unacknowledged messages saved in the republish queue.

void	setDiscardedMessageCount (OpcUa_UInt32 discardedMessageCount)
	The number of messages that were discarded before they were acknowledged.

void	setMonitoredItemCount (OpcUa_UInt32 monitoredItemCount)
	The total number of monitored items of the subscription, including the disabled monitored items.

void	setDisabledMonitoredItemCount (OpcUa_UInt32 disabledMonitoredItemCount)
	The number of disabled monitored items of the subscription.

void	setMonitoringQueueOverflowCount (OpcUa_UInt32 monitoringQueueOverflowCount)
	The number of times a monitored item dropped notifications because of a queue overflow.

void	setNextSequenceNumber (OpcUa_UInt32 nextSequenceNumber)
	Sequence number for the next notification message.

void	setEventQueueOverFlowCount (OpcUa_UInt32 eventQueueOverFlowCount)
	The number of times a monitored item in the subscription has generated an Event of type EventQueueOverflowEventType.

Static Public Member Functions
static OpcUa_SubscriptionDiagnosticsDataType *	clone (const OpcUa_SubscriptionDiagnosticsDataType &source)
	Copy OpcUa_SubscriptionDiagnosticsDataType data to a newly allocated OpcUa_SubscriptionDiagnosticsDataType. More...

static void	cloneTo (const OpcUa_SubscriptionDiagnosticsDataType &source, OpcUa_SubscriptionDiagnosticsDataType &copy)
	Copy OpcUa_SubscriptionDiagnosticsDataType data to an existing OpcUa_SubscriptionDiagnosticsDataType structure. More...

Detailed Description

Wrapper class for the UA stack structure OpcUa_SubscriptionDiagnosticsDataType.

This class encapsulates the native OpcUa_SubscriptionDiagnosticsDataType structure and handles memory allocation and cleanup for you. UaSubscriptionDiagnosticsDataType uses implicit sharing to avoid needless copying and to boost the performance. Only if you modify a shared SubscriptionDiagnosticsDataType it creates a copy for that (copy-on-write). So assigning another UaSubscriptionDiagnosticsDataType or passing it as parameter needs constant time and is nearly as fast as assigning a pointer.

Contains diagnostic information about subscriptions.

Constructor & Destructor Documentation

UaSubscriptionDiagnosticsDataType::UaSubscriptionDiagnosticsDataType ( const UaSubscriptionDiagnosticsDataType & other )

Constructs an instance of the class UaSubscriptionDiagnosticsDataType with values from another UaSubscriptionDiagnosticsDataType object.

Parameters

other the other UaSubscriptionDiagnosticsDataType used to initialize the object

UaSubscriptionDiagnosticsDataType::UaSubscriptionDiagnosticsDataType ( const OpcUa_SubscriptionDiagnosticsDataType & other )

Constructs an instance of the class UaSubscriptionDiagnosticsDataType with values from another OpcUa_SubscriptionDiagnosticsDataType structure.

Parameters

other the other OpcUa_SubscriptionDiagnosticsDataType used to initialize the object

UaSubscriptionDiagnosticsDataType::UaSubscriptionDiagnosticsDataType ( const UaExtensionObject & extensionObject )

Constructs an instance of the class UaSubscriptionDiagnosticsDataType initialized with value from a UaExtensionObject.

Parameters

extensionObject the extension object containing the SubscriptionDiagnosticsDataType

UaSubscriptionDiagnosticsDataType::UaSubscriptionDiagnosticsDataType ( const OpcUa_ExtensionObject & extensionObject )

Constructs an instance of the class UaSubscriptionDiagnosticsDataType initialized with value from an OpcUa_ExtensionObject structure.

Parameters

extensionObject the extension object containing the SubscriptionDiagnosticsDataType

Member Function Documentation

void UaSubscriptionDiagnosticsDataType::attach ( OpcUa_SubscriptionDiagnosticsDataType * pValue )

Attaches to an existing OpcUa_SubscriptionDiagnosticsDataType structure.

Don't manually free the attached structure afterwards, because UaSubscriptionDiagnosticsDataType is responsible for it now.

Parameters

pValue [in] Parameter to attach to.

void UaSubscriptionDiagnosticsDataType::clear ( )

Clear the data of the UaSubscriptionDiagnosticsDataType.

OpcUa_SubscriptionDiagnosticsDataType * UaSubscriptionDiagnosticsDataType::clone ( const OpcUa_SubscriptionDiagnosticsDataType & source )

static

Copy OpcUa_SubscriptionDiagnosticsDataType data to a newly allocated OpcUa_SubscriptionDiagnosticsDataType.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_SubscriptionDiagnosticsDataType.

void UaSubscriptionDiagnosticsDataType::cloneTo	(	const OpcUa_SubscriptionDiagnosticsDataType &	source,
		OpcUa_SubscriptionDiagnosticsDataType &	copy
	)

static

Copy OpcUa_SubscriptionDiagnosticsDataType data to an existing OpcUa_SubscriptionDiagnosticsDataType structure.

Parameters

source	the source of the clone operation.
copy	the destination of the clone operation.

OpcUa_SubscriptionDiagnosticsDataType * UaSubscriptionDiagnosticsDataType::copy ( ) const

Copy UaSubscriptionDiagnosticsDataType data to a newly allocated OpcUa_SubscriptionDiagnosticsDataType.

Returns: pointer to a newly allocated OpcUa_SubscriptionDiagnosticsDataType.

void UaSubscriptionDiagnosticsDataType::copyTo ( OpcUa_SubscriptionDiagnosticsDataType * pDst ) const

Copy UaSubscriptionDiagnosticsDataType data to an existing OpcUa_SubscriptionDiagnosticsDataType structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_SubscriptionDiagnosticsDataType * UaSubscriptionDiagnosticsDataType::detach ( OpcUa_SubscriptionDiagnosticsDataType * pDst )

Detaches the internal SubscriptionDiagnosticsDataType structure from this class.

This way you take over the control of freeing the SubscriptionDiagnosticsDataType data. If more than one reference exists, the data is copied to pDst instead of being detached.

Parameters

pDst	[out] Pointer to an OpcUa_SubscriptionDiagnosticsDataType structure that receives the SubscriptionDiagnosticsDataType data.

Returns: If the function succeeds, pDst is returned, otherwise 0 is returned.

OpcUa_UInt32 UaSubscriptionDiagnosticsDataType::getLatePublishRequestCount ( ) const

The number of times the subscription has entered the LATE State, i.e.

the number of times the publish timer expires and there are unsent notifications.

OpcUa_UInt32 UaSubscriptionDiagnosticsDataType::getRepublishMessageRequestCount ( ) const

The total number of messages that have been requested to be republished for the subscription.

Note that due to the design of the Republish Service this number is always equal to the republishRequestCount.

bool UaSubscriptionDiagnosticsDataType::operator!= ( const UaSubscriptionDiagnosticsDataType & other ) const

Compare two UaSubscriptionDiagnosticsDataType for inequality.

See also: operator==

Parameters

other the UaSubscriptionDiagnosticsDataType to compare with.

Returns: true if not equal, false otherwise.

UaSubscriptionDiagnosticsDataType & UaSubscriptionDiagnosticsDataType::operator= ( const UaSubscriptionDiagnosticsDataType & other )

Assignment operator.

Parameters

other the UaSubscriptionDiagnosticsDataType to assign.

Returns: reference to itself.

bool UaSubscriptionDiagnosticsDataType::operator== ( const UaSubscriptionDiagnosticsDataType & other ) const

Compare two UaSubscriptionDiagnosticsDataType for equality.

Parameters

other the UaSubscriptionDiagnosticsDataType to compare with.

Returns: true if equal, false if not.

void UaSubscriptionDiagnosticsDataType::setLatePublishRequestCount ( OpcUa_UInt32 latePublishRequestCount )

The number of times the subscription has entered the LATE State, i.e.

the number of times the publish timer expires and there are unsent notifications.

void UaSubscriptionDiagnosticsDataType::setRepublishMessageRequestCount ( OpcUa_UInt32 republishMessageRequestCount )

The total number of messages that have been requested to be republished for the subscription.

Note that due to the design of the Republish Service this number is always equal to the republishRequestCount.

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

C:/work/uasdkcpp/src/uabase/uabasecpp/uasubscriptiondiagnosticsdatatype.h
C:/work/uasdkcpp/src/uabase/uabasecpp/uasubscriptiondiagnosticsdatatype.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation