Package net.simplace.sim.util

Enum Class FWSimVariable.MODE_TYPE

java.lang.Object

java.lang.Enum<FWSimVariable.MODE_TYPE>

net.simplace.sim.util.FWSimVariable.MODE_TYPE

All Implemented Interfaces:

Serializable, Comparable<FWSimVariable.MODE_TYPE>, Constable

Enclosing class:

FWSimVariable<T>

public static enum FWSimVariable.MODE_TYPE
extends Enum<FWSimVariable.MODE_TYPE>

Mode is used for Output Variables to define the way they are generalized if Frequence is no daily step.

Author:

Andreas Enders

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AVG	Average of all values ignoring null values
COUNT	Average of all values ignoring null values
FIRST	First - first value taken
IGNORE	Ignored - last value taken
ITE	if true sets the value, false sets the default
LAST	Last - last value taken
MAX	Maximum of all values
MIN	Minimum of all values
RESET	if true sets the default value, else nothing
SET	if true sets the value, else nothing
SUM	Sum of all values
VAR	Variance of all values ignoring null values

Method Summary

Modifier and Type	Method	Description
static FWSimVariable.MODE_TYPE	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FWSimVariable.MODE_TYPE[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUM

public static final FWSimVariable.MODE_TYPE SUM

Sum of all values

MAX

public static final FWSimVariable.MODE_TYPE MAX

Maximum of all values

MIN

public static final FWSimVariable.MODE_TYPE MIN

Minimum of all values

AVG

public static final FWSimVariable.MODE_TYPE AVG

Average of all values ignoring null values

COUNT

public static final FWSimVariable.MODE_TYPE COUNT

Average of all values ignoring null values

VAR

public static final FWSimVariable.MODE_TYPE VAR

Variance of all values ignoring null values

IGNORE

public static final FWSimVariable.MODE_TYPE IGNORE

Ignored - last value taken

FIRST

public static final FWSimVariable.MODE_TYPE FIRST

First - first value taken

LAST

public static final FWSimVariable.MODE_TYPE LAST

Last - last value taken

RESET

public static final FWSimVariable.MODE_TYPE RESET

if true sets the default value, else nothing

SET

public static final FWSimVariable.MODE_TYPE SET

if true sets the value, else nothing

ITE

public static final FWSimVariable.MODE_TYPE ITE

if true sets the value, false sets the default

Method Details

values

public static FWSimVariable.MODE_TYPE[] 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

public static FWSimVariable.MODE_TYPE valueOf(String name)

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 name

NullPointerException - if the argument is null