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

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

#include <uasessiondiagnosticsdatatype.h>

Public Member Functions

 UaSessionDiagnosticsDataType ()
 Constructs an instance of the class UaSessionDiagnosticsDataType with empty default values.
 
 UaSessionDiagnosticsDataType (const UaSessionDiagnosticsDataType &other)
 Constructs an instance of the class UaSessionDiagnosticsDataType with values from another UaSessionDiagnosticsDataType object. More...
 
 UaSessionDiagnosticsDataType (const OpcUa_SessionDiagnosticsDataType &other)
 Constructs an instance of the class UaSessionDiagnosticsDataType with values from another OpcUa_SessionDiagnosticsDataType structure. More...
 
 UaSessionDiagnosticsDataType (const UaNodeId &sessionId, const UaString &sessionName, const UaApplicationDescription &clientDescription, const UaString &serverUri, const UaString &endpointUrl, const UaStringArray &localeIds, OpcUa_Double actualSessionTimeout, OpcUa_UInt32 maxResponseMessageSize, const UaDateTime &clientConnectionTime, const UaDateTime &clientLastContactTime, OpcUa_UInt32 currentSubscriptionsCount, OpcUa_UInt32 currentMonitoredItemsCount, OpcUa_UInt32 currentPublishRequestsInQueue, const UaServiceCounterDataType &totalRequestCount, OpcUa_UInt32 unauthorizedRequestCount, const UaServiceCounterDataType &readCount, const UaServiceCounterDataType &historyReadCount, const UaServiceCounterDataType &writeCount, const UaServiceCounterDataType &historyUpdateCount, const UaServiceCounterDataType &callCount, const UaServiceCounterDataType &createMonitoredItemsCount, const UaServiceCounterDataType &modifyMonitoredItemsCount, const UaServiceCounterDataType &setMonitoringModeCount, const UaServiceCounterDataType &setTriggeringCount, const UaServiceCounterDataType &deleteMonitoredItemsCount, const UaServiceCounterDataType &createSubscriptionCount, const UaServiceCounterDataType &modifySubscriptionCount, const UaServiceCounterDataType &setPublishingModeCount, const UaServiceCounterDataType &publishCount, const UaServiceCounterDataType &republishCount, const UaServiceCounterDataType &transferSubscriptionsCount, const UaServiceCounterDataType &deleteSubscriptionsCount, const UaServiceCounterDataType &addNodesCount, const UaServiceCounterDataType &addReferencesCount, const UaServiceCounterDataType &deleteNodesCount, const UaServiceCounterDataType &deleteReferencesCount, const UaServiceCounterDataType &browseCount, const UaServiceCounterDataType &browseNextCount, const UaServiceCounterDataType &translateBrowsePathsToNodeIdsCount, const UaServiceCounterDataType &queryFirstCount, const UaServiceCounterDataType &queryNextCount, const UaServiceCounterDataType &registerNodesCount, const UaServiceCounterDataType &unregisterNodesCount)
 Constructs an instance of the class UaSessionDiagnosticsDataType with values provided in the constructor.
 
 UaSessionDiagnosticsDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaSessionDiagnosticsDataType initialized with value from a UaExtensionObject. More...
 
 UaSessionDiagnosticsDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaSessionDiagnosticsDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaSessionDiagnosticsDataType ()
 Destroys the UaSessionDiagnosticsDataType object.
 
void clear ()
 Clear the data of the UaSessionDiagnosticsDataType. More...
 
bool operator== (const UaSessionDiagnosticsDataType &other) const
 Compare two UaSessionDiagnosticsDataType if they are similar. More...
 
bool operator!= (const UaSessionDiagnosticsDataType &other) const
 Returns true if the other UaSessionDiagnosticsDataType is not equal to this. More...
 
UaSessionDiagnosticsDataTypeoperator= (const UaSessionDiagnosticsDataType &other)
 Assignment operator. More...
 
OpcUa_SessionDiagnosticsDataType * copy () const
 Copy UaSessionDiagnosticsDataType data to a newly allocated OpcUa_SessionDiagnosticsDataType. More...
 
void copyTo (OpcUa_SessionDiagnosticsDataType *pDst) const
 Copy UaSessionDiagnosticsDataType data to an existing OpcUa_SessionDiagnosticsDataType structure. More...
 
void attach (OpcUa_SessionDiagnosticsDataType *pValue)
 Attaches the data of the parameter pValue. More...
 
OpcUa_SessionDiagnosticsDataType * detach (OpcUa_SessionDiagnosticsDataType *pDst)
 Detaches the internal SessionDiagnosticsDataType structure from this class. More...
 

Static Public Member Functions

static
OpcUa_SessionDiagnosticsDataType * 
clone (const OpcUa_SessionDiagnosticsDataType &source)
 Copy OpcUa_SessionDiagnosticsDataType data to a newly allocated OpcUa_SessionDiagnosticsDataType. More...
 
static void cloneTo (const OpcUa_SessionDiagnosticsDataType &source, OpcUa_SessionDiagnosticsDataType &copy)
 Copy OpcUa_SessionDiagnosticsDataType data to an existing OpcUa_SessionDiagnosticsDataType structure. More...
 

Detailed Description

Wrapper class for the UA stack structure OpcUa_SessionDiagnosticsDataType.

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

Constructor & Destructor Documentation

UaSessionDiagnosticsDataType::UaSessionDiagnosticsDataType ( const UaSessionDiagnosticsDataType other)

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

Parameters
otherthe other UaSessionDiagnosticsDataType used to initialize the object
UaSessionDiagnosticsDataType::UaSessionDiagnosticsDataType ( const OpcUa_SessionDiagnosticsDataType &  other)

Constructs an instance of the class UaSessionDiagnosticsDataType with values from another OpcUa_SessionDiagnosticsDataType structure.

Parameters
otherthe other OpcUa_SessionDiagnosticsDataType used to initialize the object
UaSessionDiagnosticsDataType::UaSessionDiagnosticsDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the SessionDiagnosticsDataType
UaSessionDiagnosticsDataType::UaSessionDiagnosticsDataType ( const OpcUa_ExtensionObject &  extensionObject)

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

Parameters
extensionObjectthe extension object containing the SessionDiagnosticsDataType

Member Function Documentation

void UaSessionDiagnosticsDataType::attach ( OpcUa_SessionDiagnosticsDataType *  pValue)

Attaches the data of the parameter pValue.

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

Parameters
[in]pValueParameter to attach to.
void UaSessionDiagnosticsDataType::clear ( )

Clear the data of the UaSessionDiagnosticsDataType.

OpcUa_SessionDiagnosticsDataType * UaSessionDiagnosticsDataType::clone ( const OpcUa_SessionDiagnosticsDataType &  source)
static

Copy OpcUa_SessionDiagnosticsDataType data to a newly allocated OpcUa_SessionDiagnosticsDataType.

Parameters
sourceSource to clone.
Returns
new copy.
void UaSessionDiagnosticsDataType::cloneTo ( const OpcUa_SessionDiagnosticsDataType &  source,
OpcUa_SessionDiagnosticsDataType &  copy 
)
static

Copy OpcUa_SessionDiagnosticsDataType data to an existing OpcUa_SessionDiagnosticsDataType structure.

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

Copy UaSessionDiagnosticsDataType data to a newly allocated OpcUa_SessionDiagnosticsDataType.

Returns
data to a newly allocated OpcUa_SessionDiagnosticsDataType.
void UaSessionDiagnosticsDataType::copyTo ( OpcUa_SessionDiagnosticsDataType *  pDst) const

Copy UaSessionDiagnosticsDataType data to an existing OpcUa_SessionDiagnosticsDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_SessionDiagnosticsDataType * UaSessionDiagnosticsDataType::detach ( OpcUa_SessionDiagnosticsDataType *  pDst)

Detaches the internal SessionDiagnosticsDataType structure from this class.

This way you take over the control of releasing the SessionDiagnosticsDataType 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_SessionDiagnosticsDataType structure that receives the SessionDiagnosticsDataType data.
bool UaSessionDiagnosticsDataType::operator!= ( const UaSessionDiagnosticsDataType other) const

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

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

Assignment operator.

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

Compare two UaSessionDiagnosticsDataType if they are similar.

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

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