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

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

#include <uasoftwarecertificate.h>

Public Member Functions

 UaSoftwareCertificate ()
 Constructs an instance of the class UaSoftwareCertificate with empty default values.
 
 UaSoftwareCertificate (const UaSoftwareCertificate &other)
 Constructs an instance of the class UaSoftwareCertificate with values from another UaSoftwareCertificate object. More...
 
 UaSoftwareCertificate (const OpcUa_SoftwareCertificate &other)
 Constructs an instance of the class UaSoftwareCertificate with values from another OpcUa_SoftwareCertificate structure. More...
 
 UaSoftwareCertificate (const UaString &productName, const UaString &productUri, const UaString &vendorName, const UaByteString &vendorProductCertificate, const UaString &softwareVersion, const UaString &buildNumber, const UaDateTime &buildDate, const UaString &issuedBy, const UaDateTime &issueDate, const UaSupportedProfiles &supportedProfiles)
 Constructs an instance of the class UaSoftwareCertificate with values provided in the constructor.
 
 UaSoftwareCertificate (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaSoftwareCertificate initialized with value from a UaExtensionObject. More...
 
 UaSoftwareCertificate (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaSoftwareCertificate initialized with value from an OpcUa_ExtensionObject structure. More...
 
 UaSoftwareCertificate (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
 UaSoftwareCertificate (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
 ~UaSoftwareCertificate ()
 Destroys the UaSoftwareCertificate object.
 
void clear ()
 Clear the data of the UaSoftwareCertificate. More...
 
bool operator== (const UaSoftwareCertificate &other) const
 Compare two UaSoftwareCertificate if they are similar. More...
 
bool operator!= (const UaSoftwareCertificate &other) const
 Returns true if the other UaSoftwareCertificate is not equal to this. More...
 
UaSoftwareCertificateoperator= (const UaSoftwareCertificate &other)
 Assignment operator. More...
 
OpcUa_SoftwareCertificate * copy () const
 Copy UaSoftwareCertificate data to a newly allocated OpcUa_SoftwareCertificate. More...
 
void copyTo (OpcUa_SoftwareCertificate *pDst) const
 Copy UaSoftwareCertificate data to an existing OpcUa_SoftwareCertificate structure. More...
 
void attach (const OpcUa_SoftwareCertificate *pValue)
 Attaches the data of the parameter pValue. More...
 
OpcUa_SoftwareCertificate * detach (OpcUa_SoftwareCertificate *pDst)
 Detaches the internal SoftwareCertificate 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 setSoftwareCertificate (const UaExtensionObject &extensionObject)
 
OpcUa_StatusCode setSoftwareCertificate (const OpcUa_ExtensionObject &extensionObject)
 
OpcUa_StatusCode setSoftwareCertificate (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
OpcUa_StatusCode setSoftwareCertificate (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
void setSoftwareCertificate (const UaString &productName, const UaString &productUri, const UaString &vendorName, const UaByteString &vendorProductCertificate, const UaString &softwareVersion, const UaString &buildNumber, const UaDateTime &buildDate, const UaString &issuedBy, const UaDateTime &issueDate, const UaSupportedProfiles &supportedProfiles)
 
UaString getProductName () const
 
UaString getProductUri () const
 
UaString getVendorName () const
 
UaByteString getVendorProductCertificate () const
 
UaString getSoftwareVersion () const
 
UaString getBuildNumber () const
 
UaDateTime getBuildDate () const
 
UaString getIssuedBy () const
 
UaDateTime getIssueDate () const
 
void getSupportedProfiles (UaSupportedProfiles &supportedProfiles) const
 
void setProductName (const UaString &productName)
 
void setProductUri (const UaString &productUri)
 
void setVendorName (const UaString &vendorName)
 
void setVendorProductCertificate (const UaByteString &vendorProductCertificate)
 
void setSoftwareVersion (const UaString &softwareVersion)
 
void setBuildNumber (const UaString &buildNumber)
 
void setBuildDate (const UaDateTime &buildDate)
 
void setIssuedBy (const UaString &issuedBy)
 
void setIssueDate (const UaDateTime &issueDate)
 
void setSupportedProfiles (const UaSupportedProfiles &supportedProfiles)
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_SoftwareCertificate.

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

Constructor & Destructor Documentation

UaSoftwareCertificate::UaSoftwareCertificate ( const UaSoftwareCertificate other)

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

Parameters
otherthe other UaSoftwareCertificate used to initialize the object
UaSoftwareCertificate::UaSoftwareCertificate ( const OpcUa_SoftwareCertificate &  other)

Constructs an instance of the class UaSoftwareCertificate with values from another OpcUa_SoftwareCertificate structure.

Parameters
otherthe other OpcUa_SoftwareCertificate used to initialize the object
UaSoftwareCertificate::UaSoftwareCertificate ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the SoftwareCertificate
UaSoftwareCertificate::UaSoftwareCertificate ( const OpcUa_ExtensionObject &  extensionObject)

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

Parameters
extensionObjectthe extension object containing the SoftwareCertificate

Member Function Documentation

void UaSoftwareCertificate::attach ( const OpcUa_SoftwareCertificate *  pValue)

Attaches the data of the parameter pValue.

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

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

Clear the data of the UaSoftwareCertificate.

OpcUa_SoftwareCertificate * UaSoftwareCertificate::clone ( const OpcUa_SoftwareCertificate &  source)
static

Copy OpcUa_SoftwareCertificate data to a newly allocated OpcUa_SoftwareCertificate.

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

Copy OpcUa_SoftwareCertificate data to an existing OpcUa_SoftwareCertificate structure.

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

Copy UaSoftwareCertificate data to a newly allocated OpcUa_SoftwareCertificate.

Returns
data to a newly allocated OpcUa_SoftwareCertificate.
void UaSoftwareCertificate::copyTo ( OpcUa_SoftwareCertificate *  pDst) const

Copy UaSoftwareCertificate data to an existing OpcUa_SoftwareCertificate structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_SoftwareCertificate * UaSoftwareCertificate::detach ( OpcUa_SoftwareCertificate *  pDst)

Detaches the internal SoftwareCertificate structure from this class.

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

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

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

Assignment operator.

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

Compare two UaSoftwareCertificate if they are similar.

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

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