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 ()
	Destroys the UaSoftwareCertificate object.

void	clear ()
	Clear the data of the UaSoftwareCertificate. More...

bool	operator== (const UaSoftwareCertificate &other) const
	Compare two UaSoftwareCertificate for equality. More...

bool	operator!= (const UaSoftwareCertificate &other) const
	Compare two UaSoftwareCertificate for inequality. More...

UaSoftwareCertificate &	operator= (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 (OpcUa_SoftwareCertificate *pValue)
	Attaches to an existing OpcUa_SoftwareCertificate structure. More...

OpcUa_SoftwareCertificate *	detach (OpcUa_SoftwareCertificate *pDst)
	Detaches the internal SoftwareCertificate structure from this class. More...

UaString	getProductName () const
	The name of the product that is certified. More...

UaString	getProductUri () const
	A globally unique identifier for the product that is certified. More...

UaString	getVendorName () const
	The name of the vendor responsible for the product. More...

UaByteString	getVendorProductCertificate () const
	The DER encoded form of the X.509 Certificate which is assigned to the product by the vendor. More...

UaString	getSoftwareVersion () const
	Software version. More...

UaString	getBuildNumber () const
	Build number. More...

UaDateTime	getBuildDate () const
	Date and time of the build. More...

UaString	getIssuedBy () const
	URI of the certifying authority. More...

UaDateTime	getIssueDate () const
	Specifies when the Certificate was issued by the certifying authority. More...

void	getSupportedProfiles (UaSupportedProfiles &supportedProfiles) const
	List of supported Profiles.

void	setProductName (const UaString &productName)
	The name of the product that is certified. More...

void	setProductUri (const UaString &productUri)
	A globally unique identifier for the product that is certified. More...

void	setVendorName (const UaString &vendorName)
	The name of the vendor responsible for the product. More...

void	setVendorProductCertificate (const UaByteString &vendorProductCertificate)
	The DER encoded form of the X.509 Certificate which is assigned to the product by the vendor. More...

void	setSoftwareVersion (const UaString &softwareVersion)
	Software version. More...

void	setBuildNumber (const UaString &buildNumber)
	Build number. More...

void	setBuildDate (const UaDateTime &buildDate)
	Date and time of the build. More...

void	setIssuedBy (const UaString &issuedBy)
	URI of the certifying authority. More...

void	setIssueDate (const UaDateTime &issueDate)
	Specifies when the Certificate was issued by the certifying authority. More...

void	setSupportedProfiles (const UaSupportedProfiles &supportedProfiles)
	List of supported Profiles.

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.

A Certificate describing a product.

Constructor & Destructor Documentation

UaSoftwareCertificate::UaSoftwareCertificate ( const UaSoftwareCertificate & other )

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

Parameters

other the 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

other the 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

extensionObject the 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

extensionObject the extension object containing the SoftwareCertificate

Member Function Documentation

void UaSoftwareCertificate::attach ( OpcUa_SoftwareCertificate * pValue )

Attaches to an existing OpcUa_SoftwareCertificate structure.

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

Parameters

pValue [in] Parameter 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

source Source to clone.

Returns: pointer to a newly allocated OpcUa_SoftwareCertificate.

void UaSoftwareCertificate::cloneTo	(	const OpcUa_SoftwareCertificate &	source,
		OpcUa_SoftwareCertificate &	copy
	)

static

Copy OpcUa_SoftwareCertificate data to an existing OpcUa_SoftwareCertificate structure.

Parameters

source	the source of the clone operation.
copy	the destination of the clone operation.

OpcUa_SoftwareCertificate * UaSoftwareCertificate::copy ( ) const

Copy UaSoftwareCertificate data to a newly allocated OpcUa_SoftwareCertificate.

Returns: pointer to a newly allocated OpcUa_SoftwareCertificate.

void UaSoftwareCertificate::copyTo ( OpcUa_SoftwareCertificate * pDst ) const

Copy UaSoftwareCertificate data to an existing OpcUa_SoftwareCertificate structure.

Parameters

pDst	the 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 freeing the SoftwareCertificate data. If more than one reference exists, the data is copied to pDst instead of being detached.

Parameters

pDst	[out] Pointer to an OpcUa_SoftwareCertificate structure that receives the SoftwareCertificate data.

Returns: If the function succeeds, pDst is returned, otherwise 0 is returned.

UaDateTime UaSoftwareCertificate::getBuildDate ( ) const

Date and time of the build.

This field shall be specified.

UaString UaSoftwareCertificate::getBuildNumber ( ) const

Build number.

This field shall be specified.

UaDateTime UaSoftwareCertificate::getIssueDate ( ) const

Specifies when the Certificate was issued by the certifying authority.

This field shall be specified.

UaString UaSoftwareCertificate::getIssuedBy ( ) const

URI of the certifying authority.

This field shall be specified.

UaString UaSoftwareCertificate::getProductName ( ) const

The name of the product that is certified.

This field shall be specified.

UaString UaSoftwareCertificate::getProductUri ( ) const

A globally unique identifier for the product that is certified.

This field shall be specified.

UaString UaSoftwareCertificate::getSoftwareVersion ( ) const

Software version.

This field shall be specified.

UaString UaSoftwareCertificate::getVendorName ( ) const

The name of the vendor responsible for the product.

This field shall be specified.

UaByteString UaSoftwareCertificate::getVendorProductCertificate ( ) const

The DER encoded form of the X.509 Certificate which is assigned to the product by the vendor.

This field may be omitted.

bool UaSoftwareCertificate::operator!= ( const UaSoftwareCertificate & other ) const

Compare two UaSoftwareCertificate for inequality.

See also: operator==

Parameters

other the UaSoftwareCertificate to compare with.

Returns: true if not equal, false otherwise.

UaSoftwareCertificate & UaSoftwareCertificate::operator= ( const UaSoftwareCertificate & other )

Assignment operator.

Parameters

other the UaSoftwareCertificate to assign.

Returns: reference to itself.

bool UaSoftwareCertificate::operator== ( const UaSoftwareCertificate & other ) const

Compare two UaSoftwareCertificate for equality.

Parameters

other the UaSoftwareCertificate to compare with.

Returns: true if equal, false if not.

void UaSoftwareCertificate::setBuildDate ( const UaDateTime & buildDate )

Date and time of the build.

This field shall be specified.

void UaSoftwareCertificate::setBuildNumber ( const UaString & buildNumber )

Build number.

This field shall be specified.

void UaSoftwareCertificate::setIssueDate ( const UaDateTime & issueDate )

Specifies when the Certificate was issued by the certifying authority.

This field shall be specified.

void UaSoftwareCertificate::setIssuedBy ( const UaString & issuedBy )

URI of the certifying authority.

This field shall be specified.

void UaSoftwareCertificate::setProductName ( const UaString & productName )

The name of the product that is certified.

This field shall be specified.

void UaSoftwareCertificate::setProductUri ( const UaString & productUri )

A globally unique identifier for the product that is certified.

This field shall be specified.

void UaSoftwareCertificate::setSoftwareVersion ( const UaString & softwareVersion )

Software version.

This field shall be specified.

void UaSoftwareCertificate::setVendorName ( const UaString & vendorName )

The name of the vendor responsible for the product.

This field shall be specified.

void UaSoftwareCertificate::setVendorProductCertificate ( const UaByteString & vendorProductCertificate )

The DER encoded form of the X.509 Certificate which is assigned to the product by the vendor.

This field may be omitted.

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

C:/work/uasdkcpp/src/uabase/uabasecpp/uasoftwarecertificate.h
C:/work/uasdkcpp/src/uabase/uabasecpp/uasoftwarecertificate.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation