C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
UaSignedSoftwareCertificate Class Reference

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

#include <uasignedsoftwarecertificate.h>

Public Member Functions

 UaSignedSoftwareCertificate ()
 Constructs an instance of the class UaSignedSoftwareCertificate with empty default values.
 
 UaSignedSoftwareCertificate (const UaSignedSoftwareCertificate &other)
 Constructs an instance of the class UaSignedSoftwareCertificate with values from another UaSignedSoftwareCertificate object. More...
 
 UaSignedSoftwareCertificate (const OpcUa_SignedSoftwareCertificate &other)
 Constructs an instance of the class UaSignedSoftwareCertificate with values from another OpcUa_SignedSoftwareCertificate structure. More...
 
 UaSignedSoftwareCertificate (const UaByteString &certificateData, const UaByteString &signature)
 Constructs an instance of the class UaSignedSoftwareCertificate with values provided in the constructor.
 
 UaSignedSoftwareCertificate (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaSignedSoftwareCertificate initialized with value from a UaExtensionObject. More...
 
 UaSignedSoftwareCertificate (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaSignedSoftwareCertificate initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaSignedSoftwareCertificate ()
 Destroys the UaSignedSoftwareCertificate object.
 
void clear ()
 Clear the data of the UaSignedSoftwareCertificate. More...
 
bool operator== (const UaSignedSoftwareCertificate &other) const
 Compare two UaSignedSoftwareCertificate for equality. More...
 
bool operator!= (const UaSignedSoftwareCertificate &other) const
 Compare two UaSignedSoftwareCertificate for inequality. More...
 
UaSignedSoftwareCertificateoperator= (const UaSignedSoftwareCertificate &other)
 Assignment operator. More...
 
OpcUa_SignedSoftwareCertificatecopy () const
 Copy UaSignedSoftwareCertificate data to a newly allocated OpcUa_SignedSoftwareCertificate. More...
 
void copyTo (OpcUa_SignedSoftwareCertificate *pDst) const
 Copy UaSignedSoftwareCertificate data to an existing OpcUa_SignedSoftwareCertificate structure. More...
 
void attach (OpcUa_SignedSoftwareCertificate *pValue)
 Attaches to an existing OpcUa_SignedSoftwareCertificate structure. More...
 
OpcUa_SignedSoftwareCertificatedetach (OpcUa_SignedSoftwareCertificate *pDst)
 Detaches the internal SignedSoftwareCertificate structure from this class. More...
 
UaByteString getCertificateData () const
 The certificate data serialized as a ByteString.
 
UaByteString getSignature () const
 The signature for the certificateData.
 
void setCertificateData (const UaByteString &certificateData)
 The certificate data serialized as a ByteString.
 
void setSignature (const UaByteString &signature)
 The signature for the certificateData.
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_SignedSoftwareCertificate.

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

A ByteString containing an encoded certificate.

The encoding of a SignedSoftwareCertificate depends on the security technology mapping and is defined completely in Part 6 of the OPC UA Specification.

Constructor & Destructor Documentation

UaSignedSoftwareCertificate::UaSignedSoftwareCertificate ( const UaSignedSoftwareCertificate other)

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

Parameters
otherthe other UaSignedSoftwareCertificate used to initialize the object
UaSignedSoftwareCertificate::UaSignedSoftwareCertificate ( const OpcUa_SignedSoftwareCertificate other)

Constructs an instance of the class UaSignedSoftwareCertificate with values from another OpcUa_SignedSoftwareCertificate structure.

Parameters
otherthe other OpcUa_SignedSoftwareCertificate used to initialize the object
UaSignedSoftwareCertificate::UaSignedSoftwareCertificate ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the SignedSoftwareCertificate
UaSignedSoftwareCertificate::UaSignedSoftwareCertificate ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the SignedSoftwareCertificate

Member Function Documentation

void UaSignedSoftwareCertificate::attach ( OpcUa_SignedSoftwareCertificate pValue)

Attaches to an existing OpcUa_SignedSoftwareCertificate structure.

Don't manually free the attached structure afterwards, because UaSignedSoftwareCertificate is responsible for it now.

Parameters
pValue[in] Parameter to attach to.
void UaSignedSoftwareCertificate::clear ( )

Clear the data of the UaSignedSoftwareCertificate.

OpcUa_SignedSoftwareCertificate * UaSignedSoftwareCertificate::clone ( const OpcUa_SignedSoftwareCertificate source)
static

Copy OpcUa_SignedSoftwareCertificate data to a newly allocated OpcUa_SignedSoftwareCertificate.

Parameters
sourceSource to clone.
Returns
pointer to a newly allocated OpcUa_SignedSoftwareCertificate.
void UaSignedSoftwareCertificate::cloneTo ( const OpcUa_SignedSoftwareCertificate source,
OpcUa_SignedSoftwareCertificate copy 
)
static

Copy OpcUa_SignedSoftwareCertificate data to an existing OpcUa_SignedSoftwareCertificate structure.

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

Copy UaSignedSoftwareCertificate data to a newly allocated OpcUa_SignedSoftwareCertificate.

Returns
pointer to a newly allocated OpcUa_SignedSoftwareCertificate.
void UaSignedSoftwareCertificate::copyTo ( OpcUa_SignedSoftwareCertificate pDst) const

Copy UaSignedSoftwareCertificate data to an existing OpcUa_SignedSoftwareCertificate structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_SignedSoftwareCertificate * UaSignedSoftwareCertificate::detach ( OpcUa_SignedSoftwareCertificate pDst)

Detaches the internal SignedSoftwareCertificate structure from this class.

This way you take over the control of freeing the SignedSoftwareCertificate data. If more than one reference exists, the data is copied to pDst instead of being detached.

Parameters
pDst[out] Pointer to an OpcUa_SignedSoftwareCertificate structure that receives the SignedSoftwareCertificate data.
Returns
If the function succeeds, pDst is returned, otherwise 0 is returned.
bool UaSignedSoftwareCertificate::operator!= ( const UaSignedSoftwareCertificate other) const

Compare two UaSignedSoftwareCertificate for inequality.

See also
operator==
Parameters
otherthe UaSignedSoftwareCertificate to compare with.
Returns
true if not equal, false otherwise.
UaSignedSoftwareCertificate & UaSignedSoftwareCertificate::operator= ( const UaSignedSoftwareCertificate other)

Assignment operator.

Parameters
otherthe UaSignedSoftwareCertificate to assign.
Returns
reference to itself.
bool UaSignedSoftwareCertificate::operator== ( const UaSignedSoftwareCertificate other) const

Compare two UaSignedSoftwareCertificate for equality.

Parameters
otherthe UaSignedSoftwareCertificate to compare with.
Returns
true if equal, false if not.

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