appeng.api.config

Enum PowerUnits

java.lang.Object

java.lang.Enum<PowerUnits>

appeng.api.config.PowerUnits

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PowerUnits>

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
AE
EU
RF

Field Summary

Fields

Modifier and Type	Field and Description
double	conversionRatio please do not edit this value, it is set when AE loads its config files.
java.lang.String	unlocalizedName unlocalized name for the power unit.

Method Summary

Modifier and Type	Method and Description
double	convertTo(PowerUnits target, double value) do power conversion using AE's conversion rates.
static PowerUnits	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PowerUnits[]	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

AE

public static final PowerUnits AE

EU

public static final PowerUnits EU

RF

public static final PowerUnits RF

Field Detail

unlocalizedName

public final java.lang.String unlocalizedName

unlocalized name for the power unit.

conversionRatio

public double conversionRatio

please do not edit this value, it is set when AE loads its config files.

Method Detail

values

public static PowerUnits[] 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 (PowerUnits c : PowerUnits.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PowerUnits 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

convertTo

public double convertTo(PowerUnits target,
                        double value)

do power conversion using AE's conversion rates. Example: PowerUnits.EU.convertTo( PowerUnits.AE, 32 ); will normally returns 64, as it will convert the EU, to AE with AE's power settings.

Parameters:

target - target power unit

value - value

Returns:

value converted to target units, from this units.