UA Bundle SDK .NET  2.3.1.334
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
Public Member Functions | Properties | List of all members
UnifiedAutomation.UaBase.AggregateConfiguration Class Reference

Allows Clients to override the Aggregate configuration settings supplied by the AggregateConfiguration object on a per monitored item basis. More...

Inherits UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 AggregateConfiguration ()
 The default constructor. More...
 
virtual void Encode (IEncoder encoder)
 
 
virtual void Decode (IDecoder decoder)
 
 
virtual bool IsEqual (IEncodeable encodeable)
 Checks if encodeable is the same object or has the same content More...
 
virtual object Clone ()
 
 

Properties

bool UseServerCapabilitiesDefaults [get, set]
 A Boolean parameter indicating whether to use default aggregate configuration settings. More...
 
bool TreatUncertainAsBad [get, set]
 Indicates how the server treats data returned with a StatusCode severity Uncertain with respect to Aggregate calculations. More...
 
byte PercentDataBad [get, set]
 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...
 
byte PercentDataGood [get, set]
 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...
 
bool UseSlopedExtrapolation [get, set]
 Indicates how the server interpolates data when no boundary value exists (i.e. extrapolating into the future from the last known value). More...
 
virtual ExpandedNodeId TypeId [get]
 
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
 
virtual ExpandedNodeId XmlEncodingId [get]
 
 
- Properties inherited from UnifiedAutomation.UaBase.IEncodeable
ExpandedNodeId TypeId [get]
 Returns the UA type identifier for the encodable type. More...
 
ExpandedNodeId BinaryEncodingId [get]
 Returns the UA type identifier for the default binary encoding for the type. More...
 
ExpandedNodeId XmlEncodingId [get]
 Returns the UA type identifier for the default XML encoding for the type. More...
 

Detailed Description

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.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.AggregateConfiguration.AggregateConfiguration ( )
inline

The default constructor.

Member Function Documentation

virtual bool UnifiedAutomation.UaBase.AggregateConfiguration.IsEqual ( IEncodeable  encodeable)
inlinevirtual

Checks if encodeable is the same object or has the same content

Parameters
encodeable
Returns

Implements UnifiedAutomation.UaBase.IEncodeable.

Property Documentation

byte UnifiedAutomation.UaBase.AggregateConfiguration.PercentDataBad
getset

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. 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.

byte UnifiedAutomation.UaBase.AggregateConfiguration.PercentDataGood
getset

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.

bool UnifiedAutomation.UaBase.AggregateConfiguration.TreatUncertainAsBad
getset

Indicates how the server treats data returned with a StatusCode severity Uncertain with respect to Aggregate calculations.

It has the following values:

True
the server considers the severity equivalent to Bad,
False
indicates the server considers the severity equivalent to Good, unless the aggregate definition says otherwise.

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.

bool UnifiedAutomation.UaBase.AggregateConfiguration.UseServerCapabilitiesDefaults
getset

A Boolean parameter indicating whether to use default aggregate configuration settings.

TRUE
use aggregate configuration settings as outlined by the AggregateConfiguration object.
FALSE
use configuration settings as outlined in the following aggregate configuration parameters.
bool UnifiedAutomation.UaBase.AggregateConfiguration.UseSlopedExtrapolation
getset

Indicates how the server interpolates data when no boundary value exists (i.e. extrapolating into the future from the last known value).

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