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