UA Server SDK C++ Bundle  1.4.0.258
 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 (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
 UaSessionDiagnosticsDataType (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
 ~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 (const 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...
 
void toVariant (UaVariant &variant) const
 
void toVariant (OpcUa_Variant &variant) const
 
void toVariant (UaVariant &variant, OpcUa_Boolean bDetach)
 
void toVariant (OpcUa_Variant &variant, OpcUa_Boolean bDetach)
 
void toDataValue (UaDataValue &dataValue, OpcUa_Boolean updateTimeStamps) const
 
void toDataValue (OpcUa_DataValue &dataValue, OpcUa_Boolean updateTimeStamps) const
 
void toDataValue (UaDataValue &dataValue, OpcUa_Boolean bDetach, OpcUa_Boolean updateTimeStamps)
 
void toDataValue (OpcUa_DataValue &dataValue, OpcUa_Boolean bDetach, OpcUa_Boolean updateTimeStamps)
 
void toExtensionObject (UaExtensionObject &extensionObject) const
 
void toExtensionObject (OpcUa_ExtensionObject &extensionObject) const
 
void toExtensionObject (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
void toExtensionObject (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
OpcUa_StatusCode setSessionDiagnosticsDataType (const UaExtensionObject &extensionObject)
 
OpcUa_StatusCode setSessionDiagnosticsDataType (const OpcUa_ExtensionObject &extensionObject)
 
OpcUa_StatusCode setSessionDiagnosticsDataType (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
OpcUa_StatusCode setSessionDiagnosticsDataType (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
void setSessionDiagnosticsDataType (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)
 
UaNodeId getSessionId () const
 
UaString getSessionName () const
 
UaApplicationDescription getClientDescription () const
 
UaString getServerUri () const
 
UaString getEndpointUrl () const
 
void getLocaleIds (UaStringArray &localeIds) const
 
OpcUa_Double getActualSessionTimeout () const
 
OpcUa_UInt32 getMaxResponseMessageSize () const
 
UaDateTime getClientConnectionTime () const
 
UaDateTime getClientLastContactTime () const
 
OpcUa_UInt32 getCurrentSubscriptionsCount () const
 
OpcUa_UInt32 getCurrentMonitoredItemsCount () const
 
OpcUa_UInt32 getCurrentPublishRequestsInQueue () const
 
UaServiceCounterDataType getTotalRequestCount () const
 
OpcUa_UInt32 getUnauthorizedRequestCount () const
 
UaServiceCounterDataType getReadCount () const
 
UaServiceCounterDataType getHistoryReadCount () const
 
UaServiceCounterDataType getWriteCount () const
 
UaServiceCounterDataType getHistoryUpdateCount () const
 
UaServiceCounterDataType getCallCount () const
 
UaServiceCounterDataType getCreateMonitoredItemsCount () const
 
UaServiceCounterDataType getModifyMonitoredItemsCount () const
 
UaServiceCounterDataType getSetMonitoringModeCount () const
 
UaServiceCounterDataType getSetTriggeringCount () const
 
UaServiceCounterDataType getDeleteMonitoredItemsCount () const
 
UaServiceCounterDataType getCreateSubscriptionCount () const
 
UaServiceCounterDataType getModifySubscriptionCount () const
 
UaServiceCounterDataType getSetPublishingModeCount () const
 
UaServiceCounterDataType getPublishCount () const
 
UaServiceCounterDataType getRepublishCount () const
 
UaServiceCounterDataType getTransferSubscriptionsCount () const
 
UaServiceCounterDataType getDeleteSubscriptionsCount () const
 
UaServiceCounterDataType getAddNodesCount () const
 
UaServiceCounterDataType getAddReferencesCount () const
 
UaServiceCounterDataType getDeleteNodesCount () const
 
UaServiceCounterDataType getDeleteReferencesCount () const
 
UaServiceCounterDataType getBrowseCount () const
 
UaServiceCounterDataType getBrowseNextCount () const
 
UaServiceCounterDataType getTranslateBrowsePathsToNodeIdsCount () const
 
UaServiceCounterDataType getQueryFirstCount () const
 
UaServiceCounterDataType getQueryNextCount () const
 
UaServiceCounterDataType getRegisterNodesCount () const
 
UaServiceCounterDataType getUnregisterNodesCount () const
 
void setSessionId (const UaNodeId &sessionId)
 
void setSessionName (const UaString &sessionName)
 
void setClientDescription (const UaApplicationDescription &clientDescription)
 
void setServerUri (const UaString &serverUri)
 
void setEndpointUrl (const UaString &endpointUrl)
 
void setLocaleIds (const UaStringArray &localeIds)
 
void setActualSessionTimeout (OpcUa_Double actualSessionTimeout)
 
void setMaxResponseMessageSize (OpcUa_UInt32 maxResponseMessageSize)
 
void setClientConnectionTime (const UaDateTime &clientConnectionTime)
 
void setClientLastContactTime (const UaDateTime &clientLastContactTime)
 
void setCurrentSubscriptionsCount (OpcUa_UInt32 currentSubscriptionsCount)
 
void setCurrentMonitoredItemsCount (OpcUa_UInt32 currentMonitoredItemsCount)
 
void setCurrentPublishRequestsInQueue (OpcUa_UInt32 currentPublishRequestsInQueue)
 
void setTotalRequestCount (const UaServiceCounterDataType &totalRequestCount)
 
void setUnauthorizedRequestCount (OpcUa_UInt32 unauthorizedRequestCount)
 
void setReadCount (const UaServiceCounterDataType &readCount)
 
void setHistoryReadCount (const UaServiceCounterDataType &historyReadCount)
 
void setWriteCount (const UaServiceCounterDataType &writeCount)
 
void setHistoryUpdateCount (const UaServiceCounterDataType &historyUpdateCount)
 
void setCallCount (const UaServiceCounterDataType &callCount)
 
void setCreateMonitoredItemsCount (const UaServiceCounterDataType &createMonitoredItemsCount)
 
void setModifyMonitoredItemsCount (const UaServiceCounterDataType &modifyMonitoredItemsCount)
 
void setSetMonitoringModeCount (const UaServiceCounterDataType &setMonitoringModeCount)
 
void setSetTriggeringCount (const UaServiceCounterDataType &setTriggeringCount)
 
void setDeleteMonitoredItemsCount (const UaServiceCounterDataType &deleteMonitoredItemsCount)
 
void setCreateSubscriptionCount (const UaServiceCounterDataType &createSubscriptionCount)
 
void setModifySubscriptionCount (const UaServiceCounterDataType &modifySubscriptionCount)
 
void setSetPublishingModeCount (const UaServiceCounterDataType &setPublishingModeCount)
 
void setPublishCount (const UaServiceCounterDataType &publishCount)
 
void setRepublishCount (const UaServiceCounterDataType &republishCount)
 
void setTransferSubscriptionsCount (const UaServiceCounterDataType &transferSubscriptionsCount)
 
void setDeleteSubscriptionsCount (const UaServiceCounterDataType &deleteSubscriptionsCount)
 
void setAddNodesCount (const UaServiceCounterDataType &addNodesCount)
 
void setAddReferencesCount (const UaServiceCounterDataType &addReferencesCount)
 
void setDeleteNodesCount (const UaServiceCounterDataType &deleteNodesCount)
 
void setDeleteReferencesCount (const UaServiceCounterDataType &deleteReferencesCount)
 
void setBrowseCount (const UaServiceCounterDataType &browseCount)
 
void setBrowseNextCount (const UaServiceCounterDataType &browseNextCount)
 
void setTranslateBrowsePathsToNodeIdsCount (const UaServiceCounterDataType &translateBrowsePathsToNodeIdsCount)
 
void setQueryFirstCount (const UaServiceCounterDataType &queryFirstCount)
 
void setQueryNextCount (const UaServiceCounterDataType &queryNextCount)
 
void setRegisterNodesCount (const UaServiceCounterDataType &registerNodesCount)
 
void setUnregisterNodesCount (const UaServiceCounterDataType &unregisterNodesCount)
 

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 ( const 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: