java.lang.Object
- java.lang.Enum<ArchiveStatisticalFunction>
- - sk.ipesoft.d2000.d2japi.ArchiveStatisticalFunction

public enum ArchiveStatisticalFunction
extends java.lang.Enum<ArchiveStatisticalFunction>

Enum Constant Summary

Enum Constants
Enum Constant	Description
`average`	Arithmetic mean of archived values.
`averageOfNegativeValues`
`averageOfPositiveValues`
`count`	Number of archived values.
`delta`	Difference between two consecutive values.
`deltaParametrised`
`ecoAverage`
`filter`	Filter out non significant changes of archived value.
`increment`	Difference between two consecutive values.
`incrementParametrised`
`integral`	Integral of archived values.
`max`	Maximum of archived values.
`maxt`	Deprecated.
`min`	Minimum of archived values.
`mint`	Deprecated.
`numberOfPeeks`
`numberOfPits`
`sampleDeviation`
`sum`	Sum of archived values.
`sumOfIncrements`
`sumOfIncrementsParametrised`
`sumOfNegativeValues`
`sumOfPositiveValues`
`timeOfGreaterOrEqualValue`
`timeOfGreaterValue`
`timeOfLesserOrEqualValue`
`timeOfLesserValue`
`timeslice`
`weightedAverage`	Weighted arithmetic mean of archived values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getValue()`
`static ArchiveStatisticalFunction`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static ArchiveStatisticalFunction[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

average
```
public static final ArchiveStatisticalFunction average
```
Arithmetic mean of archived values. Plain arithmetic average is sufficient for periodic archive. Use weightedAverage for non-periodic archive instead.

weightedAverage
```
public static final ArchiveStatisticalFunction weightedAverage
```
Weighted arithmetic mean of archived values. Weight of a value is proportional with length of corresponding time interval - that is difference between timestamps of two consecutive values. Weighted arithmetic mean is appropriate for non-periodic archive. Use average for periodic archive instead.

integral

public static final ArchiveStatisticalFunction integral

Integral of archived values.

sum

public static final ArchiveStatisticalFunction sum

Sum of archived values.

max

public static final ArchiveStatisticalFunction max

Maximum of archived values.

min

public static final ArchiveStatisticalFunction min

Minimum of archived values.

count

public static final ArchiveStatisticalFunction count

Number of archived values.

filter
```
public static final ArchiveStatisticalFunction filter
```
Filter out non significant changes of archived value.

increment

public static final ArchiveStatisticalFunction increment

Difference between two consecutive values.

delta

public static final ArchiveStatisticalFunction delta

Difference between two consecutive values.

ecoAverage

public static final ArchiveStatisticalFunction ecoAverage

timeOfGreaterValue

public static final ArchiveStatisticalFunction timeOfGreaterValue

timeOfGreaterOrEqualValue

public static final ArchiveStatisticalFunction timeOfGreaterOrEqualValue

timeOfLesserValue

public static final ArchiveStatisticalFunction timeOfLesserValue

timeOfLesserOrEqualValue

public static final ArchiveStatisticalFunction timeOfLesserOrEqualValue

maxt

@Deprecated
public static final ArchiveStatisticalFunction maxt

Deprecated.

mint

@Deprecated
public static final ArchiveStatisticalFunction mint

Deprecated.

numberOfPeeks

public static final ArchiveStatisticalFunction numberOfPeeks

sumOfPositiveValues

public static final ArchiveStatisticalFunction sumOfPositiveValues

sumOfNegativeValues

public static final ArchiveStatisticalFunction sumOfNegativeValues

averageOfPositiveValues

public static final ArchiveStatisticalFunction averageOfPositiveValues

averageOfNegativeValues

public static final ArchiveStatisticalFunction averageOfNegativeValues

sumOfIncrements

public static final ArchiveStatisticalFunction sumOfIncrements

timeslice

public static final ArchiveStatisticalFunction timeslice

numberOfPits

public static final ArchiveStatisticalFunction numberOfPits

sampleDeviation

public static final ArchiveStatisticalFunction sampleDeviation

sumOfIncrementsParametrised

public static final ArchiveStatisticalFunction sumOfIncrementsParametrised

incrementParametrised

public static final ArchiveStatisticalFunction incrementParametrised

deltaParametrised

public static final ArchiveStatisticalFunction deltaParametrised

Method Detail
- values
```
public static ArchiveStatisticalFunction[] values()
```
  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ArchiveStatisticalFunction c : ArchiveStatisticalFunction.values())
    System.out.println(c);
```
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static ArchiveStatisticalFunction valueOf(java.lang.String name)
```
  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
  
  java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
  
  java.lang.NullPointerException - if the argument is null
- getValue
```
public int getValue()
```

Enum ArchiveStatisticalFunction