UA Server SDK C++ Bundle  1.4.1.271
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
UaSubscriptionDiagnosticsDataType Class Reference

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 if they are similar. More...
 
bool operator!= (const UaSubscriptionDiagnosticsDataType &other) const
 Returns true if the other UaSubscriptionDiagnosticsDataType is not equal to this. More...
 
UaSubscriptionDiagnosticsDataTypeoperator= (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 the data of the parameter pValue. More...
 
OpcUa_SubscriptionDiagnosticsDataType * detach (OpcUa_SubscriptionDiagnosticsDataType *pDst)
 Detaches the internal SubscriptionDiagnosticsDataType structure from this class. More...
 

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.

Constructor & Destructor Documentation

UaSubscriptionDiagnosticsDataType::UaSubscriptionDiagnosticsDataType ( const UaSubscriptionDiagnosticsDataType other)

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

Parameters
otherthe 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
otherthe 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
extensionObjectthe 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
extensionObjectthe extension object containing the SubscriptionDiagnosticsDataType

Member Function Documentation

void UaSubscriptionDiagnosticsDataType::attach ( OpcUa_SubscriptionDiagnosticsDataType *  pValue)

Attaches the data of the parameter pValue.

Don't clear the data of pValue afterwards manually, because UaSubscriptionDiagnosticsDataType is responsible for it now.

Parameters
[in]pValueParameter 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
sourceSource to clone.
Returns
new copy.
void UaSubscriptionDiagnosticsDataType::cloneTo ( const OpcUa_SubscriptionDiagnosticsDataType &  source,
OpcUa_SubscriptionDiagnosticsDataType &  copy 
)
static

Copy OpcUa_SubscriptionDiagnosticsDataType data to an existing OpcUa_SubscriptionDiagnosticsDataType structure.

Parameters
sourcethe source of the clone operation.
copythe destination of the clone operation.
OpcUa_SubscriptionDiagnosticsDataType * UaSubscriptionDiagnosticsDataType::copy ( ) const

Copy UaSubscriptionDiagnosticsDataType data to a newly allocated OpcUa_SubscriptionDiagnosticsDataType.

Returns
data to a newly allocated OpcUa_SubscriptionDiagnosticsDataType.
void UaSubscriptionDiagnosticsDataType::copyTo ( OpcUa_SubscriptionDiagnosticsDataType *  pDst) const

Copy UaSubscriptionDiagnosticsDataType data to an existing OpcUa_SubscriptionDiagnosticsDataType structure.

Parameters
pDstthe 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 releasing the SubscriptionDiagnosticsDataType data. If more than one reference exists, the data is copied to pDst instead of being detached.

Returns
If the function succeeds, pDst is returned, otherwise 0 is returned.
Parameters
[out]pDstPointer to OpcUa_SubscriptionDiagnosticsDataType structure that receives the SubscriptionDiagnosticsDataType data.
bool UaSubscriptionDiagnosticsDataType::operator!= ( const UaSubscriptionDiagnosticsDataType other) const

Returns true if the other UaSubscriptionDiagnosticsDataType is not equal to this.

See Also
operator==
Parameters
otherthe UaSubscriptionDiagnosticsDataType to compare.
Returns
true if other is not equal to this.
UaSubscriptionDiagnosticsDataType & UaSubscriptionDiagnosticsDataType::operator= ( const UaSubscriptionDiagnosticsDataType other)

Assignment operator.

Parameters
otherthe UaSubscriptionDiagnosticsDataType to assign.
Returns
Assignment operator.
bool UaSubscriptionDiagnosticsDataType::operator== ( const UaSubscriptionDiagnosticsDataType other) const

Compare two UaSubscriptionDiagnosticsDataType if they are similar.

Parameters
otherthe UaSubscriptionDiagnosticsDataType to compare.
Returns
true if similar, false if not.

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