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

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

#include <uamodule_durablemonitoreditemdatatype.h>

Public Member Functions

 DurableMonitoredItemDataType ()
 Constructs an instance of the class DurableMonitoredItemDataType with empty default values.
 
 DurableMonitoredItemDataType (const DurableMonitoredItemDataType &other)
 Constructs an instance of the class DurableMonitoredItemDataType with values from another DurableMonitoredItemDataType object. More...
 
 DurableMonitoredItemDataType (const UaModule_DurableMonitoredItemDataType &other)
 Constructs an instance of the class DurableMonitoredItemDataType with values from another UaModule_DurableMonitoredItemDataType structure. More...
 
 DurableMonitoredItemDataType (const UaNodeId &ItemToMonitor, OpcUa_Int32 AttributeId, const UaString &IndexRange, OpcUa_Double SamplingInterval, OpcUa_Byte MonitoringMode, OpcUa_UInt32 ClientHandle, OpcUa_UInt32 ServerHandle, const UaVariant &Filter, OpcUa_UInt32 QueueSize, OpcUa_Boolean DiscardOldest, OpcUa_Byte TimestampsToReturn, OpcUa_UInt32 DurableItemHandle, OpcUa_Byte DeadbandType, OpcUa_Double DeadbandValue, OpcUa_Byte DataChangeTrigger)
 Constructs an instance of the class DurableMonitoredItemDataType with values provided in the constructor.
 
 DurableMonitoredItemDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class DurableMonitoredItemDataType initialized with value from a UaExtensionObject. More...
 
 DurableMonitoredItemDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class DurableMonitoredItemDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~DurableMonitoredItemDataType ()
 Destroys the DurableMonitoredItemDataType object.
 
void clear ()
 Clear the data of the DurableMonitoredItemDataType.
 
bool operator== (const DurableMonitoredItemDataType &other) const
 Compare two DurableMonitoredItemDataType if they are similar. More...
 
bool operator!= (const DurableMonitoredItemDataType &other) const
 Returns true if the other DurableMonitoredItemDataType is not equal to this. More...
 
DurableMonitoredItemDataTypeoperator= (const DurableMonitoredItemDataType &other)
 Assignment operator. More...
 
UaModule_DurableMonitoredItemDataType * copy () const
 Copy DurableMonitoredItemDataType data to a newly allocated UaModule_DurableMonitoredItemDataType. More...
 
void copyTo (UaModule_DurableMonitoredItemDataType *pDst) const
 Copy DurableMonitoredItemDataType data to an existing UaModule_DurableMonitoredItemDataType structure. More...
 
void attach (const UaModule_DurableMonitoredItemDataType *pValue)
 Attaches the data of the parameter pValue. More...
 
UaModule_DurableMonitoredItemDataType * detach (UaModule_DurableMonitoredItemDataType *pDst)
 Detaches the internal DurableMonitoredItemDataType structure from this class. More...
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure UaModule_DurableMonitoredItemDataType.

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

Constructor & Destructor Documentation

DurableMonitoredItemDataType::DurableMonitoredItemDataType ( const DurableMonitoredItemDataType other)

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

Parameters
otherthe other UaDurableMonitoredItemDataType used to initialize the object
DurableMonitoredItemDataType::DurableMonitoredItemDataType ( const UaModule_DurableMonitoredItemDataType &  other)

Constructs an instance of the class DurableMonitoredItemDataType with values from another UaModule_DurableMonitoredItemDataType structure.

Parameters
otherthe other UaModule_DurableMonitoredItemDataType used to initialize the object
DurableMonitoredItemDataType::DurableMonitoredItemDataType ( const UaExtensionObject extensionObject)

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

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

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

Parameters
extensionObjectthe extension object containing the DurableMonitoredItemDataType

Member Function Documentation

void DurableMonitoredItemDataType::attach ( const UaModule_DurableMonitoredItemDataType *  pValue)

Attaches the data of the parameter pValue.

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

Parameters
[in]pValueParameter to attach to.
UaModule_DurableMonitoredItemDataType * DurableMonitoredItemDataType::clone ( const UaModule_DurableMonitoredItemDataType &  source)
static

Copy UaModule_DurableMonitoredItemDataType data to a newly allocated UaModule_DurableMonitoredItemDataType.

Parameters
sourceSource to clone.
Returns
new copy.
void DurableMonitoredItemDataType::cloneTo ( const UaModule_DurableMonitoredItemDataType &  source,
UaModule_DurableMonitoredItemDataType &  copy 
)
static

Copy UaModule_DurableMonitoredItemDataType data to an existing UaModule_DurableMonitoredItemDataType structure.

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

Copy DurableMonitoredItemDataType data to a newly allocated UaModule_DurableMonitoredItemDataType.

Returns
data to a newly allocated UaModule_DurableMonitoredItemDataType.
void DurableMonitoredItemDataType::copyTo ( UaModule_DurableMonitoredItemDataType *  pDst) const

Copy DurableMonitoredItemDataType data to an existing UaModule_DurableMonitoredItemDataType structure.

Parameters
pDstthe destination of this copy operation.
UaModule_DurableMonitoredItemDataType * DurableMonitoredItemDataType::detach ( UaModule_DurableMonitoredItemDataType *  pDst)

Detaches the internal DurableMonitoredItemDataType structure from this class.

This way you take over the control of releasing the DurableMonitoredItemDataType data. If more than one references exist, the data is copied to pDst instead of being detached.

Returns
If the functions succeeds pDst is returned, otherwise 0 is returned.
Parameters
[out]pDstPointer to UaModule_DurableMonitoredItemDataType structure that receives the DurableMonitoredItemDataType data.
bool DurableMonitoredItemDataType::operator!= ( const DurableMonitoredItemDataType other) const

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

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

Assignment operator.

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

Compare two DurableMonitoredItemDataType if they are similar.

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

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