Package etomica.units

Class PrefixedUnit

java.lang.Object

etomica.units.PrefixedUnit

All Implemented Interfaces:

Unit

public class PrefixedUnit
extends java.lang.Object
implements Unit

Implementation of the Unit interface formed from a base Unit (e. g., grams) and a Prefix (e. g., kilo). The base unit cannot be changed after construction. However, the prefix can be changed using the setPrefix method.

See Also:

SimpleUnit, Prefix

Constructor Summary

Constructors

Constructor	Description
PrefixedUnit(Prefix prefix, Unit base)	Constructs a PrefixedUnit using the given prefix and base.
PrefixedUnit(Unit base)	Constructs a PrefixedUnit using the given base and a Null prefix

Method Summary

Modifier and Type	Method	Description
Dimension	dimension()	Returns the dimension of this baseUnit.
double	fromSim(double x)	Takes the given value in simulation units and converts it to class units (considering prefix).
Prefix	getPrefix()
Prefix	prefix()
boolean	prefixAllowed()	Indicates if the unit is appropriate for use with a prefix.
void	setPrefix(Prefix pre)	Changes prefix to given instance if prefixAllowed flag is true.
java.lang.String	symbol()	Returns the symbol of unit, such as "g" for grams.
double	toSim(double x)	Takes the given value in class units (considering prefix) and converts it to simulation units.
java.lang.String	toString()
Unit	unit()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PrefixedUnit

public PrefixedUnit(Unit base)

Constructs a PrefixedUnit using the given base and a Null prefix

PrefixedUnit

public PrefixedUnit(Prefix prefix,
                    Unit base)

Constructs a PrefixedUnit using the given prefix and base. If base.prefixAllowed() is false, unit is constructed with Null prefix and given prefix is ignored.

Method Detail

dimension

public Dimension dimension()

Returns the dimension of this baseUnit. For example, the dimension of grams is mass.

Specified by:

dimension in interface Unit

setPrefix

public final void setPrefix(Prefix pre)

Changes prefix to given instance if prefixAllowed flag is true. If prefixAllowed is false, prefix is left as Prefix.NULL.

Parameters:

pre - the new prefix for the unit

getPrefix

public Prefix getPrefix()

Returns:

the prefix of the baseUnit.

prefix

public Prefix prefix()

Returns:

the prefix of the baseUnit. Equivalent to getPrefix().

unit

public Unit unit()

Returns:

the base baseUnit of the baseUnit.

toSim

public final double toSim(double x)

Takes the given value in class units (considering prefix) and converts it to simulation units.

Specified by:

toSim in interface Unit

Parameters:

x - a value in units of this class

Returns:

the value converted to simulation units

fromSim

public final double fromSim(double x)

Takes the given value in simulation units and converts it to class units (considering prefix).

Specified by:

fromSim in interface Unit

Parameters:

x - a value in simulation units

Returns:

the value converted to units of this class

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

the common name of baseUnit

symbol

public java.lang.String symbol()

Description copied from interface: Unit

Returns the symbol of unit, such as "g" for grams.

Specified by:

symbol in interface Unit

Returns:

the symbol of the baseUnit

prefixAllowed

public boolean prefixAllowed()

Description copied from interface: Unit

Indicates if the unit is appropriate for use with a prefix.

Specified by:

prefixAllowed in interface Unit

Returns:

false to indicate that a prefix cannot be applied to an already prefixed baseUnit.

See Also:

Unit.prefixAllowed()