Enum Class StandardAggregates
java.lang.Object
java.lang.Enum<StandardAggregates>
com.inductiveautomation.historian.common.model.StandardAggregates
- All Implemented Interfaces:
AggregationType, Serializable, Comparable<StandardAggregates>, Constable
The platform's aggregates: the only list the platform owns. Every entry has a gateway fold, so it
exists on every provider; an engine that declares an entry by reference computes it under these
semantics. Any other id an engine declares is the engine's own.
-
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E>Nested classes/interfaces inherited from interface AggregationType
AggregationType.EmptyWindowBound -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionDuration in milliseconds the signal was false (step-function integral).Duration in milliseconds the signal was true (step-function integral). -
Method Summary
Modifier and TypeMethodDescriptionReturns the input types this aggregate accepts.booleancounter()Returns whether the aggregate counts samples or transitions, so a window with none counts zero.dataType()The output type; empty where the answer keeps the tag's own type.Returns the aggregate's description.static booleanfoldsOnPlatform(AggregationType form, DataType inputType) Whether the platform folds an engine'sformon aninputTypekey.static Optional<StandardAggregates> fromId(AggregateId id) id()Returns this aggregate's identity.The interpolations this aggregate offers, its default first.static booleanisCounter(AggregateId id) Whetheridcounts samples or transitions, so a window with none counts zero.The classic tag history calculation's fills: Auto and Omit, plus Linear and Previous where it reads them as the interpolation (the value aggregates and simple_average).booleanWhether a window holding one sample has that sample's value.booleanWhether an empty window may take a constant: the value aggregates and sum, not a spread, a count, a duration or a quality share.booleanWhether a window without samples may be filled from the neighbouring windows' results.booleanWhether the aggregate reads the signal's values at its window edges.static StandardAggregatesReturns the enum constant of this class with the specified name.static StandardAggregates[]values()Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOfMethods inherited from interface AggregationType
applicableFillModes, applicableFills, approximate, emptyWindowBound, entry, interpolations, name, offeredInputTypes, parameterSchema, resolveInterpolation
-
Enum Constant Details
-
AVERAGE
-
SIMPLE_AVERAGE
-
MIN_MAX
-
MINIMUM
-
MAXIMUM
-
RANGE
-
SUM
-
COUNT
-
LAST_VALUE
-
COUNT_ON
-
COUNT_OFF
-
DURATION_ON
Duration in milliseconds the signal was true (step-function integral). -
DURATION_OFF
Duration in milliseconds the signal was false (step-function integral). -
VARIANCE
-
STD_DEV
-
PCT_GOOD
-
PCT_BAD
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
id
Description copied from interface:AggregationTypeReturns this aggregate's identity. A protocol bridge that needs a numeric id keeps it on its own type (seeLegacyAggregateAdapter).- Specified by:
idin interfaceAggregationType- Returns:
- the id.
-
description
Description copied from interface:AggregationTypeReturns the aggregate's description.- Specified by:
descriptionin interfaceAggregationType- Returns:
- the description.
-
dataType
The output type; empty where the answer keeps the tag's own type.- Specified by:
dataTypein interfaceAggregationType- Returns:
- the type, or empty when the result takes the type of the tag it was computed over.
-
acceptedInputTypes
Description copied from interface:AggregationTypeReturns the input types this aggregate accepts. The default is the numeric types plusDataType.Boolean, which is stored as an integer and reads back as 0/1, so a time-weighted average of a boolean is its duty cycle. An aggregate that acceptsDataType.Stringdeclares it here. An engine answers an input type outside this set with the node's own last value.- Specified by:
acceptedInputTypesin interfaceAggregationType- Returns:
- the accepted input types.
-
interpolations
The interpolations this aggregate offers, its default first. Minimum, maximum, range, min_max and last_value offer the edge forms and None; average the edge forms only. The sample statistics read no edges, so they are None only; durations, quality shares and transition counts read the value carried in, so they are Auto only.- Specified by:
interpolationsin interfaceAggregationType
-
counter
public boolean counter()Description copied from interface:AggregationTypeReturns whether the aggregate counts samples or transitions, so a window with none counts zero.- Specified by:
counterin interfaceAggregationType
-
usesBounds
public boolean usesBounds()Whether the aggregate reads the signal's values at its window edges.- Specified by:
usesBoundsin interfaceAggregationType
-
oneSampleIsSample
public boolean oneSampleIsSample()Whether a window holding one sample has that sample's value.- Specified by:
oneSampleIsSamplein interfaceAggregationType
-
takesWindowFill
public boolean takesWindowFill()Whether a window without samples may be filled from the neighbouring windows' results.- Specified by:
takesWindowFillin interfaceAggregationType
-
legacyFills
The classic tag history calculation's fills: Auto and Omit, plus Linear and Previous where it reads them as the interpolation (the value aggregates and simple_average). Never a constant.- Specified by:
legacyFillsin interfaceAggregationType
-
takesConstant
public boolean takesConstant()Whether an empty window may take a constant: the value aggregates and sum, not a spread, a count, a duration or a quality share.- Specified by:
takesConstantin interfaceAggregationType
-
isCounter
Whetheridcounts samples or transitions, so a window with none counts zero. -
foldsOnPlatform
Whether the platform folds an engine'sformon aninputTypekey. The min/max envelopes, the Power Chart's default pen, never take an engine's substitute for a type the form does not reduce; every other form the engine lists is the engine's to answer. -
fromId
-