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

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 if they are similar. More...
 
bool operator!= (const UaSupportedProfile &other) const
 Returns true if the other UaSupportedProfile is not equal to this. More...
 
UaSupportedProfileoperator= (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 the data of the parameter pValue. More...
 
OpcUa_SupportedProfile * detach (OpcUa_SupportedProfile *pDst)
 Detaches the internal SupportedProfile structure from this class. More...
 

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
otherthe 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
otherthe 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
extensionObjectthe 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
extensionObjectthe extension object containing the SupportedProfile

Member Function Documentation

void UaSupportedProfile::attach ( OpcUa_SupportedProfile *  pValue)

Attaches the data of the parameter pValue.

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

Parameters
[in]pValueParameter 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
sourceSource to clone.
Returns
new copy.
void UaSupportedProfile::cloneTo ( const OpcUa_SupportedProfile &  source,
OpcUa_SupportedProfile &  copy 
)
static

Copy OpcUa_SupportedProfile data to an existing OpcUa_SupportedProfile structure.

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

Copy UaSupportedProfile data to a newly allocated OpcUa_SupportedProfile.

Returns
data to a newly allocated OpcUa_SupportedProfile.
void UaSupportedProfile::copyTo ( OpcUa_SupportedProfile *  pDst) const

Copy UaSupportedProfile data to an existing OpcUa_SupportedProfile structure.

Parameters
pDstthe 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 releasing the SupportedProfile 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_SupportedProfile structure that receives the SupportedProfile data.
bool UaSupportedProfile::operator!= ( const UaSupportedProfile other) const

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

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

Assignment operator.

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

Compare two UaSupportedProfile if they are similar.

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

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