C++ Based OPC UA Client/Server/PubSub SDK
1.7.9.586
|
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 for equality. More... | |
bool | operator!= (const UaServerDiagnosticsSummaryDataType &other) const |
Compare two UaServerDiagnosticsSummaryDataType for inequality. More... | |
UaServerDiagnosticsSummaryDataType & | operator= (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 to an existing OpcUa_ServerDiagnosticsSummaryDataType structure. More... | |
OpcUa_ServerDiagnosticsSummaryDataType * | detach (OpcUa_ServerDiagnosticsSummaryDataType *pDst) |
Detaches the internal ServerDiagnosticsSummaryDataType structure from this class. More... | |
OpcUa_UInt32 | getServerViewCount () const |
The number of server-created views in the server. | |
OpcUa_UInt32 | getCurrentSessionCount () const |
The number of client sessions currently established in the server. | |
OpcUa_UInt32 | getCumulatedSessionCount () const |
The cumulative number of client sessions that have been established in the server since the server was started (or restarted). More... | |
OpcUa_UInt32 | getSecurityRejectedSessionCount () const |
The number of client session establishment requests that were rejected due to security constraints since the server was started (or restarted). | |
OpcUa_UInt32 | getRejectedSessionCount () const |
The number of client session establishment requests that were rejected since the server was started (or restarted). More... | |
OpcUa_UInt32 | getSessionTimeoutCount () const |
The number of client sessions that were closed due to timeout since the server was started (or restarted). | |
OpcUa_UInt32 | getSessionAbortCount () const |
The number of client sessions that were closed due to errors since the server was started (or restarted). | |
OpcUa_UInt32 | getCurrentSubscriptionCount () const |
The number of subscriptions currently established in the server. | |
OpcUa_UInt32 | getCumulatedSubscriptionCount () const |
The cumulative number of subscriptions that have been established in the server since the server was started (or restarted). More... | |
OpcUa_UInt32 | getPublishingIntervalCount () const |
The number of publishing intervals currently supported in the server. | |
OpcUa_UInt32 | getSecurityRejectedRequestsCount () const |
The number of requests that were rejected due to security constraints since the server was started (or restarted). More... | |
OpcUa_UInt32 | getRejectedRequestsCount () const |
The number of requests that were rejected since the server was started (or restarted). More... | |
void | setServerViewCount (OpcUa_UInt32 serverViewCount) |
The number of server-created views in the server. | |
void | setCurrentSessionCount (OpcUa_UInt32 currentSessionCount) |
The number of client sessions currently established in the server. | |
void | setCumulatedSessionCount (OpcUa_UInt32 cumulatedSessionCount) |
The cumulative number of client sessions that have been established in the server since the server was started (or restarted). More... | |
void | setSecurityRejectedSessionCount (OpcUa_UInt32 securityRejectedSessionCount) |
The number of client session establishment requests that were rejected due to security constraints since the server was started (or restarted). | |
void | setRejectedSessionCount (OpcUa_UInt32 rejectedSessionCount) |
The number of client session establishment requests that were rejected since the server was started (or restarted). More... | |
void | setSessionTimeoutCount (OpcUa_UInt32 sessionTimeoutCount) |
The number of client sessions that were closed due to timeout since the server was started (or restarted). | |
void | setSessionAbortCount (OpcUa_UInt32 sessionAbortCount) |
The number of client sessions that were closed due to errors since the server was started (or restarted). | |
void | setCurrentSubscriptionCount (OpcUa_UInt32 currentSubscriptionCount) |
The number of subscriptions currently established in the server. | |
void | setCumulatedSubscriptionCount (OpcUa_UInt32 cumulatedSubscriptionCount) |
The cumulative number of subscriptions that have been established in the server since the server was started (or restarted). More... | |
void | setPublishingIntervalCount (OpcUa_UInt32 publishingIntervalCount) |
The number of publishing intervals currently supported in the server. | |
void | setSecurityRejectedRequestsCount (OpcUa_UInt32 securityRejectedRequestsCount) |
The number of requests that were rejected due to security constraints since the server was started (or restarted). More... | |
void | setRejectedRequestsCount (OpcUa_UInt32 rejectedRequestsCount) |
The number of requests that were rejected since the server was started (or restarted). 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 OpcUa_ServerDiagnosticsSummaryDataType data to an existing OpcUa_ServerDiagnosticsSummaryDataType structure. More... | |
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.
Contains diagnostic summary information for the Server.
UaServerDiagnosticsSummaryDataType::UaServerDiagnosticsSummaryDataType | ( | const UaServerDiagnosticsSummaryDataType & | other | ) |
Constructs an instance of the class UaServerDiagnosticsSummaryDataType with values from another UaServerDiagnosticsSummaryDataType object.
other | the 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.
other | the 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.
extensionObject | the 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.
extensionObject | the extension object containing the ServerDiagnosticsSummaryDataType |
void UaServerDiagnosticsSummaryDataType::attach | ( | OpcUa_ServerDiagnosticsSummaryDataType * | pValue | ) |
Attaches to an existing OpcUa_ServerDiagnosticsSummaryDataType structure.
Don't manually free the attached structure afterwards, because UaServerDiagnosticsSummaryDataType is responsible for it now.
pValue | [in] Parameter to attach to. |
void UaServerDiagnosticsSummaryDataType::clear | ( | ) |
Clear the data of the UaServerDiagnosticsSummaryDataType.
|
static |
Copy OpcUa_ServerDiagnosticsSummaryDataType data to a newly allocated OpcUa_ServerDiagnosticsSummaryDataType.
source | Source to clone. |
|
static |
Copy OpcUa_ServerDiagnosticsSummaryDataType data to an existing OpcUa_ServerDiagnosticsSummaryDataType structure.
source | the source of the clone operation. |
copy | the destination of the clone operation. |
OpcUa_ServerDiagnosticsSummaryDataType * UaServerDiagnosticsSummaryDataType::copy | ( | ) | const |
Copy UaServerDiagnosticsSummaryDataType data to a newly allocated OpcUa_ServerDiagnosticsSummaryDataType.
void UaServerDiagnosticsSummaryDataType::copyTo | ( | OpcUa_ServerDiagnosticsSummaryDataType * | pDst | ) | const |
Copy UaServerDiagnosticsSummaryDataType data to an existing OpcUa_ServerDiagnosticsSummaryDataType structure.
pDst | the 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 freeing the ServerDiagnosticsSummaryDataType data. If more than one reference exists, the data is copied to pDst instead of being detached.
pDst | [out] Pointer to an OpcUa_ServerDiagnosticsSummaryDataType structure that receives the ServerDiagnosticsSummaryDataType data. |
OpcUa_UInt32 UaServerDiagnosticsSummaryDataType::getCumulatedSessionCount | ( | ) | const |
The cumulative number of client sessions that have been established in the server since the server was started (or restarted).
This includes the currentSessionCount.
OpcUa_UInt32 UaServerDiagnosticsSummaryDataType::getCumulatedSubscriptionCount | ( | ) | const |
The cumulative number of subscriptions that have been established in the server since the server was started (or restarted).
This includes the currentSubscriptionCount.
OpcUa_UInt32 UaServerDiagnosticsSummaryDataType::getRejectedRequestsCount | ( | ) | const |
The number of requests that were rejected since the server was started (or restarted).
The requests include all Services defined in Part 4 of the OPC UA Specification, also requests to create sessions. This number includes the securityRejectedRequestsCount.
OpcUa_UInt32 UaServerDiagnosticsSummaryDataType::getRejectedSessionCount | ( | ) | const |
The number of client session establishment requests that were rejected since the server was started (or restarted).
This number includes the securityRejectedSessionCount.
OpcUa_UInt32 UaServerDiagnosticsSummaryDataType::getSecurityRejectedRequestsCount | ( | ) | const |
The number of requests that were rejected due to security constraints since the server was started (or restarted).
The requests include all Services defined in Part 4 of the OPC UA Specification, also requests to create sessions.
bool UaServerDiagnosticsSummaryDataType::operator!= | ( | const UaServerDiagnosticsSummaryDataType & | other | ) | const |
Compare two UaServerDiagnosticsSummaryDataType for inequality.
other | the UaServerDiagnosticsSummaryDataType to compare with. |
UaServerDiagnosticsSummaryDataType & UaServerDiagnosticsSummaryDataType::operator= | ( | const UaServerDiagnosticsSummaryDataType & | other | ) |
Assignment operator.
other | the UaServerDiagnosticsSummaryDataType to assign. |
bool UaServerDiagnosticsSummaryDataType::operator== | ( | const UaServerDiagnosticsSummaryDataType & | other | ) | const |
Compare two UaServerDiagnosticsSummaryDataType for equality.
other | the UaServerDiagnosticsSummaryDataType to compare with. |
void UaServerDiagnosticsSummaryDataType::setCumulatedSessionCount | ( | OpcUa_UInt32 | cumulatedSessionCount | ) |
The cumulative number of client sessions that have been established in the server since the server was started (or restarted).
This includes the currentSessionCount.
void UaServerDiagnosticsSummaryDataType::setCumulatedSubscriptionCount | ( | OpcUa_UInt32 | cumulatedSubscriptionCount | ) |
The cumulative number of subscriptions that have been established in the server since the server was started (or restarted).
This includes the currentSubscriptionCount.
void UaServerDiagnosticsSummaryDataType::setRejectedRequestsCount | ( | OpcUa_UInt32 | rejectedRequestsCount | ) |
The number of requests that were rejected since the server was started (or restarted).
The requests include all Services defined in Part 4 of the OPC UA Specification, also requests to create sessions. This number includes the securityRejectedRequestsCount.
void UaServerDiagnosticsSummaryDataType::setRejectedSessionCount | ( | OpcUa_UInt32 | rejectedSessionCount | ) |
The number of client session establishment requests that were rejected since the server was started (or restarted).
This number includes the securityRejectedSessionCount.
void UaServerDiagnosticsSummaryDataType::setSecurityRejectedRequestsCount | ( | OpcUa_UInt32 | securityRejectedRequestsCount | ) |
The number of requests that were rejected due to security constraints since the server was started (or restarted).
The requests include all Services defined in Part 4 of the OPC UA Specification, also requests to create sessions.