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

#include <uasupportedprofile.h>

Public Member Functions
	UaSupportedProfile ()
	Constructs an instance of the class UaSupportedProfile with empty default values.

	UaSupportedProfile (const UaSupportedProfile &other)
	Constructs an instance of the class UaSupportedProfile with values from another UaSupportedProfile object. More...

	UaSupportedProfile (const OpcUa_SupportedProfile &other)
	Constructs an instance of the class UaSupportedProfile with values from another OpcUa_SupportedProfile structure. More...

	UaSupportedProfile (const UaString &organizationUri, const UaString &profileId, const UaString &complianceTool, const UaDateTime &complianceDate, OpcUa_ComplianceLevel complianceLevel, const UaStringArray &unsupportedUnitIds)
	Constructs an instance of the class UaSupportedProfile with values provided in the constructor.

	UaSupportedProfile (const UaExtensionObject &extensionObject)
	Constructs an instance of the class UaSupportedProfile initialized with value from a UaExtensionObject. More...

	UaSupportedProfile (const OpcUa_ExtensionObject &extensionObject)
	Constructs an instance of the class UaSupportedProfile initialized with value from an OpcUa_ExtensionObject structure. More...

	~UaSupportedProfile ()
	Destroys the UaSupportedProfile object.

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

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

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

UaSupportedProfile &	operator= (const UaSupportedProfile &other)
	Assignment operator. More...

OpcUa_SupportedProfile *	copy () const
	Copy UaSupportedProfile data to a newly allocated OpcUa_SupportedProfile. More...

void	copyTo (OpcUa_SupportedProfile *pDst) const
	Copy UaSupportedProfile data to an existing OpcUa_SupportedProfile structure. More...

void	attach (OpcUa_SupportedProfile *pValue)
	Attaches to an existing OpcUa_SupportedProfile structure. More...

OpcUa_SupportedProfile *	detach (OpcUa_SupportedProfile *pDst)
	Detaches the internal SupportedProfile structure from this class. More...

UaString	getOrganizationUri () const
	A URI that identifies the organization that defined the profile.

UaString	getProfileId () const
	A string that identifies the Profile.

UaString	getComplianceTool () const
	A string that identifies the tool or certification method used for compliance testing.

UaDateTime	getComplianceDate () const
	Date and time of the compliance test.

OpcUa_ComplianceLevel	getComplianceLevel () const
	Specifies the compliance level of the Profile.

void	getUnsupportedUnitIds (UaStringArray &unsupportedUnitIds) const
	The identifiers for the optional conformance units that were not tested.

void	setOrganizationUri (const UaString &organizationUri)
	A URI that identifies the organization that defined the profile.

void	setProfileId (const UaString &profileId)
	A string that identifies the Profile.

void	setComplianceTool (const UaString &complianceTool)
	A string that identifies the tool or certification method used for compliance testing.

void	setComplianceDate (const UaDateTime &complianceDate)
	Date and time of the compliance test.

void	setComplianceLevel (OpcUa_ComplianceLevel complianceLevel)
	Specifies the compliance level of the Profile.

void	setUnsupportedUnitIds (const UaStringArray &unsupportedUnitIds)
	The identifiers for the optional conformance units that were not tested.

Static Public Member Functions
static OpcUa_SupportedProfile *	clone (const OpcUa_SupportedProfile &source)
	Copy OpcUa_SupportedProfile data to a newly allocated OpcUa_SupportedProfile. More...

static void	cloneTo (const OpcUa_SupportedProfile &source, OpcUa_SupportedProfile &copy)
	Copy OpcUa_SupportedProfile data to an existing OpcUa_SupportedProfile structure. More...

Detailed Description

Wrapper class for the UA stack structure OpcUa_SupportedProfile.

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

Constructor & Destructor Documentation

UaSupportedProfile::UaSupportedProfile ( const UaSupportedProfile & other )

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

Parameters

other the other UaSupportedProfile used to initialize the object

UaSupportedProfile::UaSupportedProfile ( const OpcUa_SupportedProfile & other )

Constructs an instance of the class UaSupportedProfile with values from another OpcUa_SupportedProfile structure.

Parameters

other the other OpcUa_SupportedProfile used to initialize the object

UaSupportedProfile::UaSupportedProfile ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the SupportedProfile

UaSupportedProfile::UaSupportedProfile ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the SupportedProfile

Member Function Documentation

void UaSupportedProfile::attach ( OpcUa_SupportedProfile * pValue )

Attaches to an existing OpcUa_SupportedProfile structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaSupportedProfile::clear ( )

Clear the data of the UaSupportedProfile.

OpcUa_SupportedProfile * UaSupportedProfile::clone ( const OpcUa_SupportedProfile & source )

static

Copy OpcUa_SupportedProfile data to a newly allocated OpcUa_SupportedProfile.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_SupportedProfile.

void UaSupportedProfile::cloneTo	(	const OpcUa_SupportedProfile &	source,
		OpcUa_SupportedProfile &	copy
	)

static

Copy OpcUa_SupportedProfile data to an existing OpcUa_SupportedProfile structure.

Parameters

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

OpcUa_SupportedProfile * UaSupportedProfile::copy ( ) const

Copy UaSupportedProfile data to a newly allocated OpcUa_SupportedProfile.

Returns: pointer to a newly allocated OpcUa_SupportedProfile.

void UaSupportedProfile::copyTo ( OpcUa_SupportedProfile * pDst ) const

Copy UaSupportedProfile data to an existing OpcUa_SupportedProfile structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_SupportedProfile * UaSupportedProfile::detach ( OpcUa_SupportedProfile * pDst )

Detaches the internal SupportedProfile structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_SupportedProfile structure that receives the SupportedProfile data.

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

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

Compare two UaSupportedProfile for inequality.

See also: operator==

Parameters

other the UaSupportedProfile to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaSupportedProfile to assign.

Returns: reference to itself.

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

Compare two UaSupportedProfile for equality.

Parameters

other the UaSupportedProfile to compare with.

Returns: true if equal, false if not.

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation