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

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

#include <uaserverdiagnosticssummarydatatype.h>

Public Member Functions

 UaServerDiagnosticsSummaryDataType ()
 Constructs an instance of the class UaServerDiagnosticsSummaryDataType with empty default values.
 
 UaServerDiagnosticsSummaryDataType (const UaServerDiagnosticsSummaryDataType &other)
 Constructs an instance of the class UaServerDiagnosticsSummaryDataType with values from another UaServerDiagnosticsSummaryDataType object. More...
 
 UaServerDiagnosticsSummaryDataType (const OpcUa_ServerDiagnosticsSummaryDataType &other)
 Constructs an instance of the class UaServerDiagnosticsSummaryDataType with values from another OpcUa_ServerDiagnosticsSummaryDataType structure. More...
 
 UaServerDiagnosticsSummaryDataType (OpcUa_UInt32 serverViewCount, OpcUa_UInt32 currentSessionCount, OpcUa_UInt32 cumulatedSessionCount, OpcUa_UInt32 securityRejectedSessionCount, OpcUa_UInt32 rejectedSessionCount, OpcUa_UInt32 sessionTimeoutCount, OpcUa_UInt32 sessionAbortCount, OpcUa_UInt32 currentSubscriptionCount, OpcUa_UInt32 cumulatedSubscriptionCount, OpcUa_UInt32 publishingIntervalCount, OpcUa_UInt32 securityRejectedRequestsCount, OpcUa_UInt32 rejectedRequestsCount)
 Constructs an instance of the class UaServerDiagnosticsSummaryDataType with values provided in the constructor.
 
 UaServerDiagnosticsSummaryDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaServerDiagnosticsSummaryDataType initialized with value from a UaExtensionObject. More...
 
 UaServerDiagnosticsSummaryDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaServerDiagnosticsSummaryDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaServerDiagnosticsSummaryDataType ()
 Destroys the UaServerDiagnosticsSummaryDataType object.
 
void clear ()
 Clear the data of the UaServerDiagnosticsSummaryDataType. More...
 
bool operator== (const UaServerDiagnosticsSummaryDataType &other) const
 Compare two UaServerDiagnosticsSummaryDataType if they are similar. More...
 
bool operator!= (const UaServerDiagnosticsSummaryDataType &other) const
 Returns true if the other UaServerDiagnosticsSummaryDataType is not equal to this. More...
 
UaServerDiagnosticsSummaryDataTypeoperator= (const UaServerDiagnosticsSummaryDataType &other)
 Assignment operator. More...
 
OpcUa_ServerDiagnosticsSummaryDataType * copy () const
 Copy UaServerDiagnosticsSummaryDataType data to a newly allocated OpcUa_ServerDiagnosticsSummaryDataType. More...
 
void copyTo (OpcUa_ServerDiagnosticsSummaryDataType *pDst) const
 Copy UaServerDiagnosticsSummaryDataType data to an existing OpcUa_ServerDiagnosticsSummaryDataType structure. More...
 
void attach (OpcUa_ServerDiagnosticsSummaryDataType *pValue)
 Attaches the data of the parameter pValue. More...
 
OpcUa_ServerDiagnosticsSummaryDataType * detach (OpcUa_ServerDiagnosticsSummaryDataType *pDst)
 Detaches the internal ServerDiagnosticsSummaryDataType structure from this class. More...
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_ServerDiagnosticsSummaryDataType.

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

Constructor & Destructor Documentation

UaServerDiagnosticsSummaryDataType::UaServerDiagnosticsSummaryDataType ( const UaServerDiagnosticsSummaryDataType other)

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

Parameters
otherthe other UaServerDiagnosticsSummaryDataType used to initialize the object
UaServerDiagnosticsSummaryDataType::UaServerDiagnosticsSummaryDataType ( const OpcUa_ServerDiagnosticsSummaryDataType &  other)

Constructs an instance of the class UaServerDiagnosticsSummaryDataType with values from another OpcUa_ServerDiagnosticsSummaryDataType structure.

Parameters
otherthe other OpcUa_ServerDiagnosticsSummaryDataType used to initialize the object
UaServerDiagnosticsSummaryDataType::UaServerDiagnosticsSummaryDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the ServerDiagnosticsSummaryDataType
UaServerDiagnosticsSummaryDataType::UaServerDiagnosticsSummaryDataType ( const OpcUa_ExtensionObject &  extensionObject)

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

Parameters
extensionObjectthe extension object containing the ServerDiagnosticsSummaryDataType

Member Function Documentation

void UaServerDiagnosticsSummaryDataType::attach ( OpcUa_ServerDiagnosticsSummaryDataType *  pValue)

Attaches the data of the parameter pValue.

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

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

Clear the data of the UaServerDiagnosticsSummaryDataType.

OpcUa_ServerDiagnosticsSummaryDataType * UaServerDiagnosticsSummaryDataType::clone ( const OpcUa_ServerDiagnosticsSummaryDataType &  source)
static

Copy OpcUa_ServerDiagnosticsSummaryDataType data to a newly allocated OpcUa_ServerDiagnosticsSummaryDataType.

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

Copy OpcUa_ServerDiagnosticsSummaryDataType data to an existing OpcUa_ServerDiagnosticsSummaryDataType structure.

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

Copy UaServerDiagnosticsSummaryDataType data to a newly allocated OpcUa_ServerDiagnosticsSummaryDataType.

Returns
data to a newly allocated OpcUa_ServerDiagnosticsSummaryDataType.
void UaServerDiagnosticsSummaryDataType::copyTo ( OpcUa_ServerDiagnosticsSummaryDataType *  pDst) const

Copy UaServerDiagnosticsSummaryDataType data to an existing OpcUa_ServerDiagnosticsSummaryDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_ServerDiagnosticsSummaryDataType * UaServerDiagnosticsSummaryDataType::detach ( OpcUa_ServerDiagnosticsSummaryDataType *  pDst)

Detaches the internal ServerDiagnosticsSummaryDataType structure from this class.

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

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

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

Assignment operator.

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

Compare two UaServerDiagnosticsSummaryDataType if they are similar.

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

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