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 ()
	Destroys the UaSamplingIntervalDiagnosticsDataType object.

void	clear ()
	Clear the data of the UaSamplingIntervalDiagnosticsDataType. More...

bool	operator== (const UaSamplingIntervalDiagnosticsDataType &other) const
	Compare two UaSamplingIntervalDiagnosticsDataType for equality. More...

bool	operator!= (const UaSamplingIntervalDiagnosticsDataType &other) const
	Compare two UaSamplingIntervalDiagnosticsDataType for inequality. More...

UaSamplingIntervalDiagnosticsDataType &	operator= (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 (OpcUa_SamplingIntervalDiagnosticsDataType *pValue)
	Attaches to an existing OpcUa_SamplingIntervalDiagnosticsDataType structure. More...

OpcUa_SamplingIntervalDiagnosticsDataType *	detach (OpcUa_SamplingIntervalDiagnosticsDataType *pDst)
	Detaches the internal SamplingIntervalDiagnosticsDataType structure from this class. More...

OpcUa_Double	getSamplingInterval () const
	Returns the SamplingInterval.

OpcUa_UInt32	getMonitoredItemCount () const
	Returns the MonitoredItemCount.

OpcUa_UInt32	getMaxMonitoredItemCount () const
	Returns the MaxMonitoredItemCount.

OpcUa_UInt32	getDisabledMonitoredItemCount () const
	Returns the DisabledMonitoredItemCount.

void	setSamplingInterval (OpcUa_Double samplingInterval)
	Sets the SamplingInterval.

void	setMonitoredItemCount (OpcUa_UInt32 monitoredItemCount)
	Sets the MonitoredItemCount.

void	setMaxMonitoredItemCount (OpcUa_UInt32 maxMonitoredItemCount)
	Sets the MaxMonitoredItemCount.

void	setDisabledMonitoredItemCount (OpcUa_UInt32 disabledMonitoredItemCount)
	Sets the 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.

Contains diagnostic information about the sampling rates currently used by the Server.

Constructor & Destructor Documentation

UaSamplingIntervalDiagnosticsDataType::UaSamplingIntervalDiagnosticsDataType ( const UaSamplingIntervalDiagnosticsDataType & other )

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

Parameters

other the 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

other the 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

extensionObject the 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

extensionObject the extension object containing the SamplingIntervalDiagnosticsDataType

Member Function Documentation

void UaSamplingIntervalDiagnosticsDataType::attach ( OpcUa_SamplingIntervalDiagnosticsDataType * pValue )

Attaches to an existing OpcUa_SamplingIntervalDiagnosticsDataType structure.

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

Parameters

pValue [in] Parameter 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

source Source to clone.

Returns: pointer to a newly allocated OpcUa_SamplingIntervalDiagnosticsDataType.

void UaSamplingIntervalDiagnosticsDataType::cloneTo	(	const OpcUa_SamplingIntervalDiagnosticsDataType &	source,
		OpcUa_SamplingIntervalDiagnosticsDataType &	copy
	)

static

Copy OpcUa_SamplingIntervalDiagnosticsDataType data to an existing OpcUa_SamplingIntervalDiagnosticsDataType structure.

Parameters

source	the source of the clone operation.
copy	the destination of the clone operation.

OpcUa_SamplingIntervalDiagnosticsDataType * UaSamplingIntervalDiagnosticsDataType::copy ( ) const

Copy UaSamplingIntervalDiagnosticsDataType data to a newly allocated OpcUa_SamplingIntervalDiagnosticsDataType.

Returns: pointer to a newly allocated OpcUa_SamplingIntervalDiagnosticsDataType.

void UaSamplingIntervalDiagnosticsDataType::copyTo ( OpcUa_SamplingIntervalDiagnosticsDataType * pDst ) const

Copy UaSamplingIntervalDiagnosticsDataType data to an existing OpcUa_SamplingIntervalDiagnosticsDataType structure.

Parameters

pDst	the 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 freeing the SamplingIntervalDiagnosticsDataType data. If more than one reference exists, the data is copied to pDst instead of being detached.

Parameters

pDst	[out] Pointer to an OpcUa_SamplingIntervalDiagnosticsDataType structure that receives the SamplingIntervalDiagnosticsDataType data.

Returns: If the function succeeds, pDst is returned, otherwise 0 is returned.

bool UaSamplingIntervalDiagnosticsDataType::operator!= ( const UaSamplingIntervalDiagnosticsDataType & other ) const

Compare two UaSamplingIntervalDiagnosticsDataType for inequality.

See also: operator==

Parameters

other the UaSamplingIntervalDiagnosticsDataType to compare with.

Returns: true if not equal, false otherwise.

UaSamplingIntervalDiagnosticsDataType & UaSamplingIntervalDiagnosticsDataType::operator= ( const UaSamplingIntervalDiagnosticsDataType & other )

Assignment operator.

Parameters

other the UaSamplingIntervalDiagnosticsDataType to assign.

Returns: reference to itself.

bool UaSamplingIntervalDiagnosticsDataType::operator== ( const UaSamplingIntervalDiagnosticsDataType & other ) const

Compare two UaSamplingIntervalDiagnosticsDataType for equality.

Parameters

other the UaSamplingIntervalDiagnosticsDataType to compare with.

Returns: true if equal, false if not.

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

C:/work/uasdkcpp/src/uabase/uabasecpp/uasamplingintervaldiagnosticsdatatype.h
C:/work/uasdkcpp/src/uabase/uabasecpp/uasamplingintervaldiagnosticsdatatype.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation