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

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

#include <uaaggregateconfiguration.h>

Public Member Functions

 UaAggregateConfiguration ()
 Constructs an instance of the class UaAggregateConfiguration with empty default values.
 
 UaAggregateConfiguration (const UaAggregateConfiguration &other)
 Constructs an instance of the class UaAggregateConfiguration with values from another UaAggregateConfiguration object. More...
 
 UaAggregateConfiguration (const OpcUa_AggregateConfiguration &other)
 Constructs an instance of the class UaAggregateConfiguration with values from another OpcUa_AggregateConfiguration structure. More...
 
 UaAggregateConfiguration (OpcUa_Boolean useServerCapabilitiesDefaults, OpcUa_Boolean treatUncertainAsBad, OpcUa_Byte percentDataBad, OpcUa_Byte percentDataGood, OpcUa_Boolean useSlopedExtrapolation)
 Constructs an instance of the class UaAggregateConfiguration with values provided in the constructor.
 
 UaAggregateConfiguration (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaAggregateConfiguration initialized with value from a UaExtensionObject. More...
 
 UaAggregateConfiguration (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaAggregateConfiguration initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaAggregateConfiguration ()
 Destroys the UaAggregateConfiguration object.
 
void clear ()
 Clear the data of the UaAggregateConfiguration. More...
 
bool operator== (const UaAggregateConfiguration &other) const
 Compare two UaAggregateConfiguration if they are similar. More...
 
bool operator!= (const UaAggregateConfiguration &other) const
 Returns true if the other UaAggregateConfiguration is not equal to this. More...
 
UaAggregateConfigurationoperator= (const UaAggregateConfiguration &other)
 Assignment operator. More...
 
OpcUa_AggregateConfiguration * copy () const
 Copy UaAggregateConfiguration data to a newly allocated OpcUa_AggregateConfiguration. More...
 
void copyTo (OpcUa_AggregateConfiguration *pDst) const
 Copy UaAggregateConfiguration data to an existing OpcUa_AggregateConfiguration structure. More...
 
void attach (OpcUa_AggregateConfiguration *pValue)
 Attaches the data of the parameter pValue. More...
 
OpcUa_AggregateConfiguration * detach (OpcUa_AggregateConfiguration *pDst)
 Detaches the internal AggregateConfiguration structure from this class. More...
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_AggregateConfiguration.

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

Constructor & Destructor Documentation

UaAggregateConfiguration::UaAggregateConfiguration ( const UaAggregateConfiguration other)

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

Parameters
otherthe other UaAggregateConfiguration used to initialize the object
UaAggregateConfiguration::UaAggregateConfiguration ( const OpcUa_AggregateConfiguration &  other)

Constructs an instance of the class UaAggregateConfiguration with values from another OpcUa_AggregateConfiguration structure.

Parameters
otherthe other OpcUa_AggregateConfiguration used to initialize the object
UaAggregateConfiguration::UaAggregateConfiguration ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the AggregateConfiguration
UaAggregateConfiguration::UaAggregateConfiguration ( const OpcUa_ExtensionObject &  extensionObject)

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

Parameters
extensionObjectthe extension object containing the AggregateConfiguration

Member Function Documentation

void UaAggregateConfiguration::attach ( OpcUa_AggregateConfiguration *  pValue)

Attaches the data of the parameter pValue.

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

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

Clear the data of the UaAggregateConfiguration.

OpcUa_AggregateConfiguration * UaAggregateConfiguration::clone ( const OpcUa_AggregateConfiguration &  source)
static

Copy OpcUa_AggregateConfiguration data to a newly allocated OpcUa_AggregateConfiguration.

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

Copy OpcUa_AggregateConfiguration data to an existing OpcUa_AggregateConfiguration structure.

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

Copy UaAggregateConfiguration data to a newly allocated OpcUa_AggregateConfiguration.

Returns
data to a newly allocated OpcUa_AggregateConfiguration.
void UaAggregateConfiguration::copyTo ( OpcUa_AggregateConfiguration *  pDst) const

Copy UaAggregateConfiguration data to an existing OpcUa_AggregateConfiguration structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_AggregateConfiguration * UaAggregateConfiguration::detach ( OpcUa_AggregateConfiguration *  pDst)

Detaches the internal AggregateConfiguration structure from this class.

This way you take over the control of releasing the AggregateConfiguration 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_AggregateConfiguration structure that receives the AggregateConfiguration data.
bool UaAggregateConfiguration::operator!= ( const UaAggregateConfiguration other) const

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

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

Assignment operator.

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

Compare two UaAggregateConfiguration if they are similar.

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

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