C++ UA Server SDK
1.5.0.318
|
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 for equality. More... | |
bool | operator!= (const UaAggregateConfiguration &other) const |
Compare two UaAggregateConfiguration for inequality. More... | |
UaAggregateConfiguration & | operator= (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 to an existing OpcUa_AggregateConfiguration structure. More... | |
OpcUa_AggregateConfiguration * | detach (OpcUa_AggregateConfiguration *pDst) |
Detaches the internal AggregateConfiguration structure from this class. More... | |
OpcUa_Boolean | getUseServerCapabilitiesDefaults () const |
A Boolean parameter indicating whether to use default aggregate configuration settings. More... | |
OpcUa_Boolean | getTreatUncertainAsBad () const |
Indicates how the server treats data returned with a StatusCode severity Uncertain with respect to Aggregate calculations. More... | |
OpcUa_Byte | getPercentDataBad () const |
Indicates the minimum percentage of bad data in a given interval required for the StatusCode for the given interval for processed data request to be set to Bad. More... | |
OpcUa_Byte | getPercentDataGood () const |
Indicates the minimum percentage of Good data in a given interval required for the StatusCode for the given interval for the processed data requests to be set to Good. More... | |
OpcUa_Boolean | getUseSlopedExtrapolation () const |
Indicates how the server interpolates data when no boundary value exists (i.e. More... | |
void | setUseServerCapabilitiesDefaults (OpcUa_Boolean useServerCapabilitiesDefaults) |
A Boolean parameter indicating whether to use default aggregate configuration settings. More... | |
void | setTreatUncertainAsBad (OpcUa_Boolean treatUncertainAsBad) |
Indicates how the server treats data returned with a StatusCode severity Uncertain with respect to Aggregate calculations. More... | |
void | setPercentDataBad (OpcUa_Byte percentDataBad) |
Indicates the minimum percentage of bad data in a given interval required for the StatusCode for the given interval for processed data request to be set to Bad. More... | |
void | setPercentDataGood (OpcUa_Byte percentDataGood) |
Indicates the minimum percentage of Good data in a given interval required for the StatusCode for the given interval for the processed data requests to be set to Good. More... | |
void | setUseSlopedExtrapolation (OpcUa_Boolean useSlopedExtrapolation) |
Indicates how the server interpolates data when no boundary value exists (i.e. 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 OpcUa_AggregateConfiguration data to an existing OpcUa_AggregateConfiguration structure. More... | |
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.
Allows Clients to override the Aggregate configuration settings supplied by the AggregateConfiguration object on a per monitored item basis.
See Part 13 of the OPC UA Specification for more information on Aggregate configurations. If the Server does not support the ability to override the Aggregate configuration settings it shall return a StatusCode of Bad_AggregateListMismatch.
UaAggregateConfiguration::UaAggregateConfiguration | ( | const UaAggregateConfiguration & | other | ) |
Constructs an instance of the class UaAggregateConfiguration with values from another UaAggregateConfiguration object.
other | the 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.
other | the 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.
extensionObject | the 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.
extensionObject | the extension object containing the AggregateConfiguration |
void UaAggregateConfiguration::attach | ( | OpcUa_AggregateConfiguration * | pValue | ) |
Attaches to an existing OpcUa_AggregateConfiguration structure.
Don't manually free the attached structure afterwards, because UaAggregateConfiguration is responsible for it now.
pValue | [in] Parameter to attach to. |
void UaAggregateConfiguration::clear | ( | ) |
Clear the data of the UaAggregateConfiguration.
|
static |
Copy OpcUa_AggregateConfiguration data to a newly allocated OpcUa_AggregateConfiguration.
source | Source to clone. |
|
static |
Copy OpcUa_AggregateConfiguration data to an existing OpcUa_AggregateConfiguration structure.
source | the source of the clone operation. |
copy | the destination of the clone operation. |
OpcUa_AggregateConfiguration * UaAggregateConfiguration::copy | ( | ) | const |
Copy UaAggregateConfiguration data to a newly allocated OpcUa_AggregateConfiguration.
void UaAggregateConfiguration::copyTo | ( | OpcUa_AggregateConfiguration * | pDst | ) | const |
Copy UaAggregateConfiguration data to an existing OpcUa_AggregateConfiguration structure.
pDst | the 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 freeing the AggregateConfiguration data. If more than one reference exists, the data is copied to pDst instead of being detached.
pDst | [out] Pointer to an OpcUa_AggregateConfiguration structure that receives the AggregateConfiguration data. |
OpcUa_Byte UaAggregateConfiguration::getPercentDataBad | ( | ) | const |
Indicates the minimum percentage of bad data in a given interval required for the StatusCode for the given interval for processed data request to be set to Bad.
Uncertain is treated as defined in OpcUa_AggregateConfiguration::TreatUncertainAsBad. For details on which Aggregates use the PercentDataBad Variable, see the definition of each Aggregate. The default value is 100.
The PercentDataGood and PercentDataBad must follow the following relationship
PercentDataGood >= (100 – PercentDataBad).
If they are equal, the result of the PercentDataGood calculation is used.
OpcUa_Byte UaAggregateConfiguration::getPercentDataGood | ( | ) | const |
Indicates the minimum percentage of Good data in a given interval required for the StatusCode for the given interval for the processed data requests to be set to Good.
For details on which Aggregates use the PercentDataGood Variable, see the definition of each Aggregate. The default value is 100.
The PercentDataGood and PercentDataBad must follow the following relationship
PercentDataGood >= (100 – PercentDataBad).
If they are equal, the result of the PercentDataGood calculation is used.
OpcUa_Boolean UaAggregateConfiguration::getTreatUncertainAsBad | ( | ) | const |
Indicates how the server treats data returned with a StatusCode severity Uncertain with respect to Aggregate calculations.
It has the following values:
A value of True indicates the server
The default value is True. Note that the value is still treated as Uncertain when the StatusCode for the result is calculated.
OpcUa_Boolean UaAggregateConfiguration::getUseServerCapabilitiesDefaults | ( | ) | const |
A Boolean parameter indicating whether to use default aggregate configuration settings.
OpcUa_Boolean UaAggregateConfiguration::getUseSlopedExtrapolation | ( | ) | const |
Indicates how the server interpolates data when no boundary value exists (i.e.
extrapolating into the future from the last known value).
The default value is False. For SimpleBounds this value is ignored.
bool UaAggregateConfiguration::operator!= | ( | const UaAggregateConfiguration & | other | ) | const |
Compare two UaAggregateConfiguration for inequality.
other | the UaAggregateConfiguration to compare with. |
UaAggregateConfiguration & UaAggregateConfiguration::operator= | ( | const UaAggregateConfiguration & | other | ) |
Assignment operator.
other | the UaAggregateConfiguration to assign. |
bool UaAggregateConfiguration::operator== | ( | const UaAggregateConfiguration & | other | ) | const |
Compare two UaAggregateConfiguration for equality.
other | the UaAggregateConfiguration to compare with. |
void UaAggregateConfiguration::setPercentDataBad | ( | OpcUa_Byte | percentDataBad | ) |
Indicates the minimum percentage of bad data in a given interval required for the StatusCode for the given interval for processed data request to be set to Bad.
Uncertain is treated as defined in OpcUa_AggregateConfiguration::TreatUncertainAsBad. For details on which Aggregates use the PercentDataBad Variable, see the definition of each Aggregate. The default value is 100.
The PercentDataGood and PercentDataBad must follow the following relationship
PercentDataGood >= (100 – PercentDataBad).
If they are equal, the result of the PercentDataGood calculation is used.
void UaAggregateConfiguration::setPercentDataGood | ( | OpcUa_Byte | percentDataGood | ) |
Indicates the minimum percentage of Good data in a given interval required for the StatusCode for the given interval for the processed data requests to be set to Good.
For details on which Aggregates use the PercentDataGood Variable, see the definition of each Aggregate. The default value is 100.
The PercentDataGood and PercentDataBad must follow the following relationship
PercentDataGood >= (100 – PercentDataBad).
If they are equal, the result of the PercentDataGood calculation is used.
void UaAggregateConfiguration::setTreatUncertainAsBad | ( | OpcUa_Boolean | treatUncertainAsBad | ) |
Indicates how the server treats data returned with a StatusCode severity Uncertain with respect to Aggregate calculations.
It has the following values:
A value of True indicates the server
The default value is True. Note that the value is still treated as Uncertain when the StatusCode for the result is calculated.
void UaAggregateConfiguration::setUseServerCapabilitiesDefaults | ( | OpcUa_Boolean | useServerCapabilitiesDefaults | ) |
A Boolean parameter indicating whether to use default aggregate configuration settings.
void UaAggregateConfiguration::setUseSlopedExtrapolation | ( | OpcUa_Boolean | useSlopedExtrapolation | ) |
Indicates how the server interpolates data when no boundary value exists (i.e.
extrapolating into the future from the last known value).
The default value is False. For SimpleBounds this value is ignored.