FrequencyBase

java.lang.Object
- java.lang.Enum<FrequencyBase>
- - de.toem.impulse.domain.FrequencyBase

All Implemented Interfaces:

IDomainBase, IReaderDomainBaseProvider, Serializable, Comparable<FrequencyBase>
```
public enum FrequencyBase
extends Enum<FrequencyBase>
implements IDomainBase
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`aHz`
`aHz10`
`aHz100`
`EHz`
`EHz10`
`EHz100`
`fHz`
`fHz10`
`fHz100`
`GHz`
`GHz10`
`GHz100`
`Hz`
`Hz10`
`Hz100`
`kHz`
`kHz10`
`kHz100`
`mHz`
`MHz`
`mHz10`
`MHz10`
`mHz100`
`MHz100`
`nHz`
`nHz10`
`nHz100`
`pHz`
`PHz`
`pHz10`
`PHz10`
`pHz100`
`PHz100`
`THz`
`THz10`
`THz100`
`uHz`
`uHz10`
`uHz100`
`yHz`
`YHz`
`yHz10`
`yHz100`
`zHz`
`ZHz`
`zHz10`
`ZHz10`
`zHz100`
`ZHz100`

Field Summary

Fields
Modifier and Type Field and Description

static String DOMAIN_LABEL
- Fields inherited from interface de.toem.impulse.domain.IDomainBase
  STYLE_ALLOW_0_WITHOUT_UNITS, STYLE_AUTO_UNIT, STYLE_DEFAULT, STYLE_DELTA, STYLE_PREFFERED_UNIT, STYLE_REMOVE_TRAILING_ZEROS, UL0, UL1, UL2

Fields
Modifier and Type	Field and Description
`static String`	`DOMAIN_LABEL`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FrequencyBase`	`bestFit(double diff)`
`long`	`convertTo(IDomainBase base, long unit)`
`long[]`	`convertTo(IDomainBase base, long[] units)`
`String`	`getDomainLabel()`
`BigDecimal`	`getQuantum()`
`IDomainBase`	`getReaderBase(IDomainBase samplesBase)`
`boolean`	`isCompatible(IDomainBase base)`
`boolean`	`isFinerThan(IDomainBase base)`
`boolean`	`isPreferred()`
`static FrequencyBase`	`parse(String text)`
`long`	`parseUnits(String value)`
`static void`	`resetPreferred()`
`void`	`setPreferred(boolean preferred)`
`double`	`toCommonBase()`
`double`	`toCommonBase(long units)`
`double`	`toHertz()`
`String`	`toString()` Returns the name of this enum constant, as contained in the declaration.
`String`	`toString(long units)`
`String`	`toString(long units, int style)`
`int`	`userLevel()`
`static FrequencyBase`	`valueOf(int ordinal)`
`static FrequencyBase`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static FrequencyBase[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

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

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

Methods inherited from interface de.toem.impulse.domain.IDomainBase
ordinal

Enum Constant Detail

yHz
```
public static final FrequencyBase yHz
```

yHz10

public static final FrequencyBase yHz10

yHz100

public static final FrequencyBase yHz100

zHz
```
public static final FrequencyBase zHz
```

zHz10

public static final FrequencyBase zHz10

zHz100

public static final FrequencyBase zHz100

aHz
```
public static final FrequencyBase aHz
```

aHz10

public static final FrequencyBase aHz10

aHz100

public static final FrequencyBase aHz100

fHz
```
public static final FrequencyBase fHz
```

fHz10

public static final FrequencyBase fHz10

fHz100

public static final FrequencyBase fHz100

pHz
```
public static final FrequencyBase pHz
```

pHz10

public static final FrequencyBase pHz10

pHz100

public static final FrequencyBase pHz100

nHz
```
public static final FrequencyBase nHz
```

nHz10

public static final FrequencyBase nHz10

nHz100

public static final FrequencyBase nHz100

uHz
```
public static final FrequencyBase uHz
```

uHz10

public static final FrequencyBase uHz10

uHz100

public static final FrequencyBase uHz100

mHz
```
public static final FrequencyBase mHz
```

mHz10

public static final FrequencyBase mHz10

mHz100

public static final FrequencyBase mHz100

Hz
```
public static final FrequencyBase Hz
```

Hz10
```
public static final FrequencyBase Hz10
```

Hz100

public static final FrequencyBase Hz100

kHz
```
public static final FrequencyBase kHz
```

kHz10

public static final FrequencyBase kHz10

kHz100

public static final FrequencyBase kHz100

MHz
```
public static final FrequencyBase MHz
```

MHz10

public static final FrequencyBase MHz10

MHz100

public static final FrequencyBase MHz100

GHz
```
public static final FrequencyBase GHz
```

GHz10

public static final FrequencyBase GHz10

GHz100

public static final FrequencyBase GHz100

THz
```
public static final FrequencyBase THz
```

THz10

public static final FrequencyBase THz10

THz100

public static final FrequencyBase THz100

PHz
```
public static final FrequencyBase PHz
```

PHz10

public static final FrequencyBase PHz10

PHz100

public static final FrequencyBase PHz100

EHz
```
public static final FrequencyBase EHz
```

EHz10

public static final FrequencyBase EHz10

EHz100

public static final FrequencyBase EHz100

ZHz
```
public static final FrequencyBase ZHz
```

ZHz10

public static final FrequencyBase ZHz10

ZHz100

public static final FrequencyBase ZHz100

YHz
```
public static final FrequencyBase YHz
```

Field Detail
- DOMAIN_LABEL
```
public static final String DOMAIN_LABEL
```
  See Also:
  
  Constant Field Values

Method Detail
- values
```
public static FrequencyBase[] 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 (FrequencyBase c : FrequencyBase.values())
    System.out.println(c);
```
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static FrequencyBase valueOf(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:
  
  IllegalArgumentException - if this enum type has no constant with the specified name
  
  NullPointerException - if the argument is null
- userLevel
```
public int userLevel()
```
  Specified by:
  
  userLevel in interface IDomainBase
- resetPreferred
```
public static void resetPreferred()
```
- setPreferred
```
public void setPreferred(boolean preferred)
```
  Specified by:
  
  setPreferred in interface IDomainBase
- isPreferred
```
public boolean isPreferred()
```
  Specified by:
  
  isPreferred in interface IDomainBase
- toString
```
public String toString()
```
  Description copied from class: Enum
  
  Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum type should override this method when a more "programmer-friendly" string form exists.
  
  Overrides:
  
  toString in class Enum<FrequencyBase>
  
  Returns:
  
  the name of this enum constant
- toString
```
public String toString(long units)
```
  Specified by:
  
  toString in interface IDomainBase
- toString
```
public String toString(long units,
                       int style)
```
  Specified by:
  
  toString in interface IDomainBase
- getQuantum
```
public BigDecimal getQuantum()
```
  Specified by:
  
  getQuantum in interface IDomainBase
- toHertz
```
public double toHertz()
```
- toCommonBase
```
public double toCommonBase()
```
  Specified by:
  
  toCommonBase in interface IDomainBase
- toCommonBase
```
public double toCommonBase(long units)
```
  Specified by:
  
  toCommonBase in interface IDomainBase
- parse
```
public static FrequencyBase parse(String text)
```
- bestFit
```
public static FrequencyBase bestFit(double diff)
```
- valueOf
```
public static FrequencyBase valueOf(int ordinal)
```
- isCompatible
```
public boolean isCompatible(IDomainBase base)
```
  Specified by:
  
  isCompatible in interface IDomainBase
- convertTo
```
public long[] convertTo(IDomainBase base,
                        long[] units)
```
  Specified by:
  
  convertTo in interface IDomainBase
- convertTo
```
public long convertTo(IDomainBase base,
                      long unit)
```
  Specified by:
  
  convertTo in interface IDomainBase
- getDomainLabel
```
public String getDomainLabel()
```
  Specified by:
  
  getDomainLabel in interface IDomainBase
- parseUnits
```
public long parseUnits(String value)
                throws NumberFormatException
```
  Specified by:
  
  parseUnits in interface IDomainBase
  
  Throws:
  
  NumberFormatException
- isFinerThan
```
public boolean isFinerThan(IDomainBase base)
```
  Specified by:
  
  isFinerThan in interface IDomainBase
- getReaderBase
```
public IDomainBase getReaderBase(IDomainBase samplesBase)
```
  Specified by:
  
  getReaderBase in interface IReaderDomainBaseProvider

Enum FrequencyBase

Enum Constant Summary

Field Summary

Fields inherited from interface de.toem.impulse.domain.IDomainBase

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface de.toem.impulse.domain.IDomainBase

Enum Constant Detail

yHz

yHz10

yHz100

zHz

zHz10

zHz100

aHz

aHz10

aHz100

fHz

fHz10

fHz100

pHz

pHz10

pHz100

nHz

nHz10

nHz100

uHz

uHz10

uHz100

mHz

mHz10

mHz100

Hz

Hz10

Hz100

kHz

kHz10

kHz100

MHz

MHz10

MHz100

GHz

GHz10

GHz100

THz

THz10

THz100

PHz

PHz10

PHz100

EHz

EHz10

EHz100

ZHz

ZHz10

ZHz100

YHz

Field Detail

DOMAIN_LABEL

Method Detail

values

valueOf

userLevel

resetPreferred

setPreferred

isPreferred

toString

toString

toString

getQuantum

toHertz

toCommonBase

toCommonBase

parse

bestFit

valueOf

isCompatible

convertTo

convertTo