The CogStatistics type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | BufferLength | Returns/sets the number of values to buffer. |
| ChangedEventSuspended | If nonzero, indicates that the raising of the Changed event has been suspended. This value is incremented when SuspendChangedEvent is called and decremented when ResumeAndRaiseChangedEvent is called. |
| CurrentValue | Returns/sets the value that will be used by Execute to compute the tolerance status for this channel. If the value is invalid (it hasn't been updated since the last call to Execute), the status will be set to cogDataAnalysisToleranceStatusInvalidValue. |
| CurrentValueIsInvalid | Returns the flag that specifies whether or not the CurrentValue has been used by Execute. If true, the status for the channel will be set to cogDataAnalysisToleranceStatusInvalidValue. |
| Description | Returns/sets a description string for the object. The Description may be optionally set to store a readable description of the use of the channel. |
| HasChanged | If true, the serializable state of this object has changed since the last time it was serialized. |
| Name | Returns the name of the channel. This is the same as the Key that was used when the channel was created via AddNew. |
| NominalValue | Returns/sets the nominal or expected value of the current value. This value is not used to produce the tolerance result, but is merely provided as a reference for the expected value. |
| NumBufferedValues | Returns the number of values that are currently held in the buffer. Entries that are marked with No Value (by calling AddEmptyValue) will be included in this count. This count will not exceed BufferLength. |
| RejectHighLimit | Returns/sets the tolerance limit that triggers a reject-high status, if enabled and the value exceeds it. Setting may cause the other limit values to be adjusted so that the RejectHighLimit remains the highest limit. |
| RejectHighLimitEnabled | Returns/sets the use of the RejectHighLimit to generate a tolerance status. |
| RejectLowLimit | Returns/sets the tolerance limit that triggers a reject-low status, if enabled and the value falls below it. Setting may cause the other limit values to be adjusted so that the RejectLowLimit remains the lowest limit. |
| RejectLowLimitEnabled | Returns/sets the use of the RejectLowLimit to generate a tolerance status. |
| RunningMaxValue | Returns the maximum value sampled since last reset. Calling ResetRunningStatistics() will restart this calculation. |
| RunningMean | Returns the mean (average) value generated from sampled data since last reset. Calling ResetRunningStatistics() will restart this calculation. |
| RunningMinValue | Returns the minimum value sampled since last reset. Calling ResetRunningStatistics() will restart this calculation. |
| RunningNumSamples | Returns the number of samples (valid values) used to compute the running statistics. Running statistics are not affected by the buffer size; they are calculated from all samples since last reset. Calling ResetRunningStatistics() will set this to zero. |
| RunningStandardDeviation | Returns the standard deviation value generated from sampled data since last reset. Calling ResetRunningStatistics() will restart this calculation. |
| WarnHighLimit | Returns/sets the tolerance limit that triggers a warn-high status, if enabled and the value exceeds it but does not exceed the RejectHighLimit. Setting may cause the other limit values to be adjusted so that the limit values remain consistent. |
| WarnHighLimitEnabled | Returns/sets the use of the WarnHighLimit to generate a tolerance status. |
| WarnLowLimit | Returns/sets the tolerance limit that triggers a warn-low status, if enabled and the value falls below it but does not fall below the RejectLowLimit. Setting may cause the other limit values to be adjusted so that the limit values remain consistent. |
| WarnLowLimitEnabled | Returns/sets the use of the WarnLowLimit to generate a tolerance status. |
See Also