C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
UaDoubleComplexNumberType Class Reference

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

#include <uadoublecomplexnumbertype.h>

Public Member Functions

 UaDoubleComplexNumberType ()
 Constructs an instance of the class UaDoubleComplexNumberType with empty default values.
 
 UaDoubleComplexNumberType (const UaDoubleComplexNumberType &other)
 Constructs an instance of the class UaDoubleComplexNumberType with values from another UaDoubleComplexNumberType object. More...
 
 UaDoubleComplexNumberType (const OpcUa_DoubleComplexNumberType &other)
 Constructs an instance of the class UaDoubleComplexNumberType with values from another OpcUa_DoubleComplexNumberType structure. More...
 
 UaDoubleComplexNumberType (OpcUa_Double real, OpcUa_Double imaginary)
 Constructs an instance of the class UaDoubleComplexNumberType with values provided in the constructor.
 
 UaDoubleComplexNumberType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaDoubleComplexNumberType initialized with value from a UaExtensionObject. More...
 
 UaDoubleComplexNumberType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaDoubleComplexNumberType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaDoubleComplexNumberType ()
 Destroys the UaDoubleComplexNumberType object.
 
void clear ()
 Clear the data of the UaDoubleComplexNumberType. More...
 
bool operator== (const UaDoubleComplexNumberType &other) const
 Compare two UaDoubleComplexNumberType for equality. More...
 
bool operator!= (const UaDoubleComplexNumberType &other) const
 Compare two UaDoubleComplexNumberType for inequality. More...
 
UaDoubleComplexNumberTypeoperator= (const UaDoubleComplexNumberType &other)
 Assignment operator. More...
 
OpcUa_DoubleComplexNumberType * copy () const
 Copy UaDoubleComplexNumberType data to a newly allocated OpcUa_DoubleComplexNumberType. More...
 
void copyTo (OpcUa_DoubleComplexNumberType *pDst) const
 Copy UaDoubleComplexNumberType data to an existing OpcUa_DoubleComplexNumberType structure. More...
 
void attach (OpcUa_DoubleComplexNumberType *pValue)
 Attaches to an existing OpcUa_DoubleComplexNumberType structure. More...
 
OpcUa_DoubleComplexNumberType * detach (OpcUa_DoubleComplexNumberType *pDst)
 Detaches the internal DoubleComplexNumberType structure from this class. More...
 
OpcUa_Double getReal () const
 Returns the Real.
 
OpcUa_Double getImaginary () const
 Returns the Imaginary.
 
void setReal (OpcUa_Double real)
 Sets the Real.
 
void setImaginary (OpcUa_Double imaginary)
 Sets the Imaginary.
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_DoubleComplexNumberType.

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

Constructor & Destructor Documentation

UaDoubleComplexNumberType::UaDoubleComplexNumberType ( const UaDoubleComplexNumberType other)

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

Parameters
otherthe other UaDoubleComplexNumberType used to initialize the object
UaDoubleComplexNumberType::UaDoubleComplexNumberType ( const OpcUa_DoubleComplexNumberType &  other)

Constructs an instance of the class UaDoubleComplexNumberType with values from another OpcUa_DoubleComplexNumberType structure.

Parameters
otherthe other OpcUa_DoubleComplexNumberType used to initialize the object
UaDoubleComplexNumberType::UaDoubleComplexNumberType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the DoubleComplexNumberType
UaDoubleComplexNumberType::UaDoubleComplexNumberType ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the DoubleComplexNumberType

Member Function Documentation

void UaDoubleComplexNumberType::attach ( OpcUa_DoubleComplexNumberType *  pValue)

Attaches to an existing OpcUa_DoubleComplexNumberType structure.

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

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

Clear the data of the UaDoubleComplexNumberType.

OpcUa_DoubleComplexNumberType * UaDoubleComplexNumberType::clone ( const OpcUa_DoubleComplexNumberType &  source)
static

Copy OpcUa_DoubleComplexNumberType data to a newly allocated OpcUa_DoubleComplexNumberType.

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

Copy OpcUa_DoubleComplexNumberType data to an existing OpcUa_DoubleComplexNumberType structure.

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

Copy UaDoubleComplexNumberType data to a newly allocated OpcUa_DoubleComplexNumberType.

Returns
pointer to a newly allocated OpcUa_DoubleComplexNumberType.
void UaDoubleComplexNumberType::copyTo ( OpcUa_DoubleComplexNumberType *  pDst) const

Copy UaDoubleComplexNumberType data to an existing OpcUa_DoubleComplexNumberType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_DoubleComplexNumberType * UaDoubleComplexNumberType::detach ( OpcUa_DoubleComplexNumberType *  pDst)

Detaches the internal DoubleComplexNumberType structure from this class.

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

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

Compare two UaDoubleComplexNumberType for inequality.

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

Assignment operator.

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

Compare two UaDoubleComplexNumberType for equality.

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

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