UA Server SDK C++ Bundle  1.4.0.258
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
UaSamplingIntervalDiagnosticsDataType Class Reference

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

#include <uasamplingintervaldiagnosticsdatatype.h>

Public Member Functions

 UaSamplingIntervalDiagnosticsDataType ()
 Constructs an instance of the class UaSamplingIntervalDiagnosticsDataType with empty default values.
 
 UaSamplingIntervalDiagnosticsDataType (const UaSamplingIntervalDiagnosticsDataType &other)
 Constructs an instance of the class UaSamplingIntervalDiagnosticsDataType with values from another UaSamplingIntervalDiagnosticsDataType object. More...
 
 UaSamplingIntervalDiagnosticsDataType (const OpcUa_SamplingIntervalDiagnosticsDataType &other)
 Constructs an instance of the class UaSamplingIntervalDiagnosticsDataType with values from another OpcUa_SamplingIntervalDiagnosticsDataType structure. More...
 
 UaSamplingIntervalDiagnosticsDataType (OpcUa_Double samplingInterval, OpcUa_UInt32 monitoredItemCount, OpcUa_UInt32 maxMonitoredItemCount, OpcUa_UInt32 disabledMonitoredItemCount)
 Constructs an instance of the class UaSamplingIntervalDiagnosticsDataType with values provided in the constructor.
 
 UaSamplingIntervalDiagnosticsDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaSamplingIntervalDiagnosticsDataType initialized with value from a UaExtensionObject. More...
 
 UaSamplingIntervalDiagnosticsDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaSamplingIntervalDiagnosticsDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 UaSamplingIntervalDiagnosticsDataType (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
 UaSamplingIntervalDiagnosticsDataType (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
 ~UaSamplingIntervalDiagnosticsDataType ()
 Destroys the UaSamplingIntervalDiagnosticsDataType object.
 
void clear ()
 Clear the data of the UaSamplingIntervalDiagnosticsDataType. More...
 
bool operator== (const UaSamplingIntervalDiagnosticsDataType &other) const
 Compare two UaSamplingIntervalDiagnosticsDataType if they are similar. More...
 
bool operator!= (const UaSamplingIntervalDiagnosticsDataType &other) const
 Returns true if the other UaSamplingIntervalDiagnosticsDataType is not equal to this. More...
 
UaSamplingIntervalDiagnosticsDataTypeoperator= (const UaSamplingIntervalDiagnosticsDataType &other)
 Assignment operator. More...
 
OpcUa_SamplingIntervalDiagnosticsDataType * copy () const
 Copy UaSamplingIntervalDiagnosticsDataType data to a newly allocated OpcUa_SamplingIntervalDiagnosticsDataType. More...
 
void copyTo (OpcUa_SamplingIntervalDiagnosticsDataType *pDst) const
 Copy UaSamplingIntervalDiagnosticsDataType data to an existing OpcUa_SamplingIntervalDiagnosticsDataType structure. More...
 
void attach (const OpcUa_SamplingIntervalDiagnosticsDataType *pValue)
 Attaches the data of the parameter pValue. More...
 
OpcUa_SamplingIntervalDiagnosticsDataType * detach (OpcUa_SamplingIntervalDiagnosticsDataType *pDst)
 Detaches the internal SamplingIntervalDiagnosticsDataType structure from this class. More...
 
void toVariant (UaVariant &variant) const
 
void toVariant (OpcUa_Variant &variant) const
 
void toVariant (UaVariant &variant, OpcUa_Boolean bDetach)
 
void toVariant (OpcUa_Variant &variant, OpcUa_Boolean bDetach)
 
void toDataValue (UaDataValue &dataValue, OpcUa_Boolean updateTimeStamps) const
 
void toDataValue (OpcUa_DataValue &dataValue, OpcUa_Boolean updateTimeStamps) const
 
void toDataValue (UaDataValue &dataValue, OpcUa_Boolean bDetach, OpcUa_Boolean updateTimeStamps)
 
void toDataValue (OpcUa_DataValue &dataValue, OpcUa_Boolean bDetach, OpcUa_Boolean updateTimeStamps)
 
void toExtensionObject (UaExtensionObject &extensionObject) const
 
void toExtensionObject (OpcUa_ExtensionObject &extensionObject) const
 
void toExtensionObject (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
void toExtensionObject (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
OpcUa_StatusCode setSamplingIntervalDiagnosticsDataType (const UaExtensionObject &extensionObject)
 
OpcUa_StatusCode setSamplingIntervalDiagnosticsDataType (const OpcUa_ExtensionObject &extensionObject)
 
OpcUa_StatusCode setSamplingIntervalDiagnosticsDataType (UaExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
OpcUa_StatusCode setSamplingIntervalDiagnosticsDataType (OpcUa_ExtensionObject &extensionObject, OpcUa_Boolean bDetach)
 
void setSamplingIntervalDiagnosticsDataType (OpcUa_Double samplingInterval, OpcUa_UInt32 monitoredItemCount, OpcUa_UInt32 maxMonitoredItemCount, OpcUa_UInt32 disabledMonitoredItemCount)
 
OpcUa_Double getSamplingInterval () const
 
OpcUa_UInt32 getMonitoredItemCount () const
 
OpcUa_UInt32 getMaxMonitoredItemCount () const
 
OpcUa_UInt32 getDisabledMonitoredItemCount () const
 
void setSamplingInterval (OpcUa_Double samplingInterval)
 
void setMonitoredItemCount (OpcUa_UInt32 monitoredItemCount)
 
void setMaxMonitoredItemCount (OpcUa_UInt32 maxMonitoredItemCount)
 
void setDisabledMonitoredItemCount (OpcUa_UInt32 disabledMonitoredItemCount)
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_SamplingIntervalDiagnosticsDataType.

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

Constructor & Destructor Documentation

UaSamplingIntervalDiagnosticsDataType::UaSamplingIntervalDiagnosticsDataType ( const UaSamplingIntervalDiagnosticsDataType other)

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

Parameters
otherthe other UaSamplingIntervalDiagnosticsDataType used to initialize the object
UaSamplingIntervalDiagnosticsDataType::UaSamplingIntervalDiagnosticsDataType ( const OpcUa_SamplingIntervalDiagnosticsDataType &  other)

Constructs an instance of the class UaSamplingIntervalDiagnosticsDataType with values from another OpcUa_SamplingIntervalDiagnosticsDataType structure.

Parameters
otherthe other OpcUa_SamplingIntervalDiagnosticsDataType used to initialize the object
UaSamplingIntervalDiagnosticsDataType::UaSamplingIntervalDiagnosticsDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the SamplingIntervalDiagnosticsDataType
UaSamplingIntervalDiagnosticsDataType::UaSamplingIntervalDiagnosticsDataType ( const OpcUa_ExtensionObject &  extensionObject)

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

Parameters
extensionObjectthe extension object containing the SamplingIntervalDiagnosticsDataType

Member Function Documentation

void UaSamplingIntervalDiagnosticsDataType::attach ( const OpcUa_SamplingIntervalDiagnosticsDataType *  pValue)

Attaches the data of the parameter pValue.

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

Parameters
[in]pValueParameter to attach to.
void UaSamplingIntervalDiagnosticsDataType::clear ( )

Clear the data of the UaSamplingIntervalDiagnosticsDataType.

OpcUa_SamplingIntervalDiagnosticsDataType * UaSamplingIntervalDiagnosticsDataType::clone ( const OpcUa_SamplingIntervalDiagnosticsDataType &  source)
static

Copy OpcUa_SamplingIntervalDiagnosticsDataType data to a newly allocated OpcUa_SamplingIntervalDiagnosticsDataType.

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

Copy OpcUa_SamplingIntervalDiagnosticsDataType data to an existing OpcUa_SamplingIntervalDiagnosticsDataType structure.

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

Copy UaSamplingIntervalDiagnosticsDataType data to a newly allocated OpcUa_SamplingIntervalDiagnosticsDataType.

Returns
data to a newly allocated OpcUa_SamplingIntervalDiagnosticsDataType.
void UaSamplingIntervalDiagnosticsDataType::copyTo ( OpcUa_SamplingIntervalDiagnosticsDataType *  pDst) const

Copy UaSamplingIntervalDiagnosticsDataType data to an existing OpcUa_SamplingIntervalDiagnosticsDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_SamplingIntervalDiagnosticsDataType * UaSamplingIntervalDiagnosticsDataType::detach ( OpcUa_SamplingIntervalDiagnosticsDataType *  pDst)

Detaches the internal SamplingIntervalDiagnosticsDataType structure from this class.

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

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

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

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

Assignment operator.

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

Compare two UaSamplingIntervalDiagnosticsDataType if they are similar.

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

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