C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537

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

#include <uaenumdescription.h>

Public Member Functions

 UaEnumDescription ()
 Constructs an instance of the class UaEnumDescription with empty default values.
 
 UaEnumDescription (const UaEnumDescription &other)
 Constructs an instance of the class UaEnumDescription with values from another UaEnumDescription object. More...
 
 UaEnumDescription (const OpcUa_EnumDescription &other)
 Constructs an instance of the class UaEnumDescription with values from another OpcUa_EnumDescription structure. More...
 
 UaEnumDescription (const UaNodeId &dataTypeId, const UaQualifiedName &name, const UaEnumDefinitionDataType &enumDefinition, OpcUa_Byte builtInType)
 Constructs an instance of the class UaEnumDescription with values provided in the constructor.
 
 UaEnumDescription (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaEnumDescription initialized with value from a UaExtensionObject. More...
 
 UaEnumDescription (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaEnumDescription initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaEnumDescription ()
 Destroys the UaEnumDescription object.
 
void clear ()
 Clear the data of the UaEnumDescription. More...
 
bool operator== (const UaEnumDescription &other) const
 Compare two UaEnumDescription for equality. More...
 
bool operator!= (const UaEnumDescription &other) const
 Compare two UaEnumDescription for inequality. More...
 
UaEnumDescriptionoperator= (const UaEnumDescription &other)
 Assignment operator. More...
 
OpcUa_EnumDescription * copy () const
 Copy UaEnumDescription data to a newly allocated OpcUa_EnumDescription. More...
 
void copyTo (OpcUa_EnumDescription *pDst) const
 Copy UaEnumDescription data to an existing OpcUa_EnumDescription structure. More...
 
void attach (OpcUa_EnumDescription *pValue)
 Attaches to an existing OpcUa_EnumDescription structure. More...
 
OpcUa_EnumDescription * detach (OpcUa_EnumDescription *pDst)
 Detaches the internal EnumDescription structure from this class. More...
 
UaNodeId getDataTypeId () const
 Returns the DataTypeId.
 
UaQualifiedName getName () const
 Returns the Name.
 
UaEnumDefinitionDataType getEnumDefinition () const
 Returns the EnumDefinition.
 
OpcUa_Byte getBuiltInType () const
 Returns the BuiltInType.
 
void setDataTypeId (const UaNodeId &dataTypeId)
 Sets the DataTypeId.
 
void setName (const UaQualifiedName &name)
 Sets the Name.
 
void setEnumDefinition (const UaEnumDefinitionDataType &enumDefinition)
 Sets the EnumDefinition.
 
void setBuiltInType (OpcUa_Byte builtInType)
 Sets the BuiltInType.
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_EnumDescription.

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

Constructor & Destructor Documentation

UaEnumDescription::UaEnumDescription ( const UaEnumDescription other)

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

Parameters
otherthe other UaEnumDescription used to initialize the object
UaEnumDescription::UaEnumDescription ( const OpcUa_EnumDescription &  other)

Constructs an instance of the class UaEnumDescription with values from another OpcUa_EnumDescription structure.

Parameters
otherthe other OpcUa_EnumDescription used to initialize the object
UaEnumDescription::UaEnumDescription ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the EnumDescription
UaEnumDescription::UaEnumDescription ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the EnumDescription

Member Function Documentation

void UaEnumDescription::attach ( OpcUa_EnumDescription *  pValue)

Attaches to an existing OpcUa_EnumDescription structure.

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

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

Clear the data of the UaEnumDescription.

OpcUa_EnumDescription * UaEnumDescription::clone ( const OpcUa_EnumDescription &  source)
static

Copy OpcUa_EnumDescription data to a newly allocated OpcUa_EnumDescription.

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

Copy OpcUa_EnumDescription data to an existing OpcUa_EnumDescription structure.

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

Copy UaEnumDescription data to a newly allocated OpcUa_EnumDescription.

Returns
pointer to a newly allocated OpcUa_EnumDescription.
void UaEnumDescription::copyTo ( OpcUa_EnumDescription *  pDst) const

Copy UaEnumDescription data to an existing OpcUa_EnumDescription structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_EnumDescription * UaEnumDescription::detach ( OpcUa_EnumDescription *  pDst)

Detaches the internal EnumDescription structure from this class.

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

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

Compare two UaEnumDescription for inequality.

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

Assignment operator.

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

Compare two UaEnumDescription for equality.

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

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