C++ Based OPC UA Client/Server/PubSub SDK
1.7.8.584
|
Wrapper class for the UA stack structure OpcUa_StructureDescription. More...
#include <uastructuredescription.h>
Public Member Functions | |
UaStructureDescription () | |
Constructs an instance of the class UaStructureDescription with empty default values. | |
UaStructureDescription (const UaStructureDescription &other) | |
Constructs an instance of the class UaStructureDescription with values from another UaStructureDescription object. More... | |
UaStructureDescription (const OpcUa_StructureDescription &other) | |
Constructs an instance of the class UaStructureDescription with values from another OpcUa_StructureDescription structure. More... | |
UaStructureDescription (const UaNodeId &dataTypeId, const UaQualifiedName &name, const UaStructureDefinitionDataType &structureDefinition) | |
Constructs an instance of the class UaStructureDescription with values provided in the constructor. | |
UaStructureDescription (const UaExtensionObject &extensionObject) | |
Constructs an instance of the class UaStructureDescription initialized with value from a UaExtensionObject. More... | |
UaStructureDescription (const OpcUa_ExtensionObject &extensionObject) | |
Constructs an instance of the class UaStructureDescription initialized with value from an OpcUa_ExtensionObject structure. More... | |
~UaStructureDescription () | |
Destroys the UaStructureDescription object. | |
void | clear () |
Clear the data of the UaStructureDescription. More... | |
bool | operator== (const UaStructureDescription &other) const |
Compare two UaStructureDescription for equality. More... | |
bool | operator!= (const UaStructureDescription &other) const |
Compare two UaStructureDescription for inequality. More... | |
UaStructureDescription & | operator= (const UaStructureDescription &other) |
Assignment operator. More... | |
OpcUa_StructureDescription * | copy () const |
Copy UaStructureDescription data to a newly allocated OpcUa_StructureDescription. More... | |
void | copyTo (OpcUa_StructureDescription *pDst) const |
Copy UaStructureDescription data to an existing OpcUa_StructureDescription structure. More... | |
void | attach (OpcUa_StructureDescription *pValue) |
Attaches to an existing OpcUa_StructureDescription structure. More... | |
OpcUa_StructureDescription * | detach (OpcUa_StructureDescription *pDst) |
Detaches the internal StructureDescription structure from this class. More... | |
UaNodeId | getDataTypeId () const |
Returns the DataTypeId. | |
UaQualifiedName | getName () const |
Returns the Name. | |
UaStructureDefinitionDataType | getStructureDefinition () const |
Returns the StructureDefinition. | |
void | setDataTypeId (const UaNodeId &dataTypeId) |
Sets the DataTypeId. | |
void | setName (const UaQualifiedName &name) |
Sets the Name. | |
void | setStructureDefinition (const UaStructureDefinitionDataType &structureDefinition) |
Sets the StructureDefinition. | |
Static Public Member Functions | |
static OpcUa_StructureDescription * | clone (const OpcUa_StructureDescription &source) |
Copy OpcUa_StructureDescription data to a newly allocated OpcUa_StructureDescription. More... | |
static void | cloneTo (const OpcUa_StructureDescription &source, OpcUa_StructureDescription ©) |
Copy OpcUa_StructureDescription data to an existing OpcUa_StructureDescription structure. More... | |
Wrapper class for the UA stack structure OpcUa_StructureDescription.
This class encapsulates the native OpcUa_StructureDescription structure and handles memory allocation and cleanup for you. UaStructureDescription uses implicit sharing to avoid needless copying and to boost the performance. Only if you modify a shared StructureDescription it creates a copy for that (copy-on-write). So assigning another UaStructureDescription or passing it as parameter needs constant time and is nearly as fast as assigning a pointer.
UaStructureDescription::UaStructureDescription | ( | const UaStructureDescription & | other | ) |
Constructs an instance of the class UaStructureDescription with values from another UaStructureDescription object.
other | the other UaStructureDescription used to initialize the object |
UaStructureDescription::UaStructureDescription | ( | const OpcUa_StructureDescription & | other | ) |
Constructs an instance of the class UaStructureDescription with values from another OpcUa_StructureDescription structure.
other | the other OpcUa_StructureDescription used to initialize the object |
UaStructureDescription::UaStructureDescription | ( | const UaExtensionObject & | extensionObject | ) |
Constructs an instance of the class UaStructureDescription initialized with value from a UaExtensionObject.
extensionObject | the extension object containing the StructureDescription |
UaStructureDescription::UaStructureDescription | ( | const OpcUa_ExtensionObject & | extensionObject | ) |
Constructs an instance of the class UaStructureDescription initialized with value from an OpcUa_ExtensionObject structure.
extensionObject | the extension object containing the StructureDescription |
void UaStructureDescription::attach | ( | OpcUa_StructureDescription * | pValue | ) |
Attaches to an existing OpcUa_StructureDescription structure.
Don't manually free the attached structure afterwards, because UaStructureDescription is responsible for it now.
pValue | [in] Parameter to attach to. |
void UaStructureDescription::clear | ( | ) |
Clear the data of the UaStructureDescription.
|
static |
Copy OpcUa_StructureDescription data to a newly allocated OpcUa_StructureDescription.
source | Source to clone. |
|
static |
Copy OpcUa_StructureDescription data to an existing OpcUa_StructureDescription structure.
source | the source of the clone operation. |
copy | the destination of the clone operation. |
OpcUa_StructureDescription * UaStructureDescription::copy | ( | ) | const |
Copy UaStructureDescription data to a newly allocated OpcUa_StructureDescription.
void UaStructureDescription::copyTo | ( | OpcUa_StructureDescription * | pDst | ) | const |
Copy UaStructureDescription data to an existing OpcUa_StructureDescription structure.
pDst | the destination of this copy operation. |
OpcUa_StructureDescription * UaStructureDescription::detach | ( | OpcUa_StructureDescription * | pDst | ) |
Detaches the internal StructureDescription structure from this class.
This way you take over the control of freeing the StructureDescription data. If more than one reference exists, the data is copied to pDst instead of being detached.
pDst | [out] Pointer to an OpcUa_StructureDescription structure that receives the StructureDescription data. |
bool UaStructureDescription::operator!= | ( | const UaStructureDescription & | other | ) | const |
Compare two UaStructureDescription for inequality.
other | the UaStructureDescription to compare with. |
UaStructureDescription & UaStructureDescription::operator= | ( | const UaStructureDescription & | other | ) |
Assignment operator.
other | the UaStructureDescription to assign. |
bool UaStructureDescription::operator== | ( | const UaStructureDescription & | other | ) | const |
Compare two UaStructureDescription for equality.
other | the UaStructureDescription to compare with. |