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

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

#include <uasessionsecuritydiagnosticsdatatype.h>

Public Member Functions

 UaSessionSecurityDiagnosticsDataType ()
 Constructs an instance of the class UaSessionSecurityDiagnosticsDataType with empty default values.
 
 UaSessionSecurityDiagnosticsDataType (const UaSessionSecurityDiagnosticsDataType &other)
 Constructs an instance of the class UaSessionSecurityDiagnosticsDataType with values from another UaSessionSecurityDiagnosticsDataType object. More...
 
 UaSessionSecurityDiagnosticsDataType (const OpcUa_SessionSecurityDiagnosticsDataType &other)
 Constructs an instance of the class UaSessionSecurityDiagnosticsDataType with values from another OpcUa_SessionSecurityDiagnosticsDataType structure. More...
 
 UaSessionSecurityDiagnosticsDataType (const UaNodeId &sessionId, const UaString &clientUserIdOfSession, const UaStringArray &clientUserIdHistory, const UaString &authenticationMechanism, const UaString &encoding, const UaString &transportProtocol, OpcUa_MessageSecurityMode securityMode, const UaString &securityPolicyUri, const UaByteString &clientCertificate)
 Constructs an instance of the class UaSessionSecurityDiagnosticsDataType with values provided in the constructor.
 
 UaSessionSecurityDiagnosticsDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaSessionSecurityDiagnosticsDataType initialized with value from a UaExtensionObject. More...
 
 UaSessionSecurityDiagnosticsDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaSessionSecurityDiagnosticsDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaSessionSecurityDiagnosticsDataType ()
 Destroys the UaSessionSecurityDiagnosticsDataType object.
 
void clear ()
 Clear the data of the UaSessionSecurityDiagnosticsDataType. More...
 
bool operator== (const UaSessionSecurityDiagnosticsDataType &other) const
 Compare two UaSessionSecurityDiagnosticsDataType if they are similar. More...
 
bool operator!= (const UaSessionSecurityDiagnosticsDataType &other) const
 Returns true if the other UaSessionSecurityDiagnosticsDataType is not equal to this. More...
 
UaSessionSecurityDiagnosticsDataTypeoperator= (const UaSessionSecurityDiagnosticsDataType &other)
 Assignment operator. More...
 
OpcUa_SessionSecurityDiagnosticsDataType * copy () const
 Copy UaSessionSecurityDiagnosticsDataType data to a newly allocated OpcUa_SessionSecurityDiagnosticsDataType. More...
 
void copyTo (OpcUa_SessionSecurityDiagnosticsDataType *pDst) const
 Copy UaSessionSecurityDiagnosticsDataType data to an existing OpcUa_SessionSecurityDiagnosticsDataType structure. More...
 
void attach (OpcUa_SessionSecurityDiagnosticsDataType *pValue)
 Attaches the data of the parameter pValue. More...
 
OpcUa_SessionSecurityDiagnosticsDataType * detach (OpcUa_SessionSecurityDiagnosticsDataType *pDst)
 Detaches the internal SessionSecurityDiagnosticsDataType structure from this class. More...
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_SessionSecurityDiagnosticsDataType.

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

Constructor & Destructor Documentation

UaSessionSecurityDiagnosticsDataType::UaSessionSecurityDiagnosticsDataType ( const UaSessionSecurityDiagnosticsDataType other)

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

Parameters
otherthe other UaSessionSecurityDiagnosticsDataType used to initialize the object
UaSessionSecurityDiagnosticsDataType::UaSessionSecurityDiagnosticsDataType ( const OpcUa_SessionSecurityDiagnosticsDataType &  other)

Constructs an instance of the class UaSessionSecurityDiagnosticsDataType with values from another OpcUa_SessionSecurityDiagnosticsDataType structure.

Parameters
otherthe other OpcUa_SessionSecurityDiagnosticsDataType used to initialize the object
UaSessionSecurityDiagnosticsDataType::UaSessionSecurityDiagnosticsDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the SessionSecurityDiagnosticsDataType
UaSessionSecurityDiagnosticsDataType::UaSessionSecurityDiagnosticsDataType ( const OpcUa_ExtensionObject &  extensionObject)

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

Parameters
extensionObjectthe extension object containing the SessionSecurityDiagnosticsDataType

Member Function Documentation

void UaSessionSecurityDiagnosticsDataType::attach ( OpcUa_SessionSecurityDiagnosticsDataType *  pValue)

Attaches the data of the parameter pValue.

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

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

Clear the data of the UaSessionSecurityDiagnosticsDataType.

OpcUa_SessionSecurityDiagnosticsDataType * UaSessionSecurityDiagnosticsDataType::clone ( const OpcUa_SessionSecurityDiagnosticsDataType &  source)
static

Copy OpcUa_SessionSecurityDiagnosticsDataType data to a newly allocated OpcUa_SessionSecurityDiagnosticsDataType.

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

Copy OpcUa_SessionSecurityDiagnosticsDataType data to an existing OpcUa_SessionSecurityDiagnosticsDataType structure.

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

Copy UaSessionSecurityDiagnosticsDataType data to a newly allocated OpcUa_SessionSecurityDiagnosticsDataType.

Returns
data to a newly allocated OpcUa_SessionSecurityDiagnosticsDataType.
void UaSessionSecurityDiagnosticsDataType::copyTo ( OpcUa_SessionSecurityDiagnosticsDataType *  pDst) const

Copy UaSessionSecurityDiagnosticsDataType data to an existing OpcUa_SessionSecurityDiagnosticsDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_SessionSecurityDiagnosticsDataType * UaSessionSecurityDiagnosticsDataType::detach ( OpcUa_SessionSecurityDiagnosticsDataType *  pDst)

Detaches the internal SessionSecurityDiagnosticsDataType structure from this class.

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

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

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

Assignment operator.

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

Compare two UaSessionSecurityDiagnosticsDataType if they are similar.

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

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