fr.cnes.genius.unit

Interface GUnit

All Known Implementing Classes:

GMetricUnit, GPercentUnit, GTemperatureUnit

public interface GUnit

It defines the interface from which all other units have to inherit. It allows that implementation of classes GEntryReal and GEntryRealVector, is independent of units that are really used by the application maker. It allows also definition of new units without modification of existing classes which use the units.

Author:

fourcadej

Method Summary

Modifier and Type	Method and Description
BigDecimal	convertFromMemory(BigDecimal value) Converts the value from the memory unit.
double	convertFromMemory(double value) Converts the value from the memory unit.
BigDecimal	convertToMemory(BigDecimal value) Converts the value to the memory unit.
double	convertToMemory(double value) Converts the value to the memory unit.
BigDecimal	convertToUnit(BigDecimal value, GUnit destUnit) Converts the units of value to unit.
double	convertToUnit(double value, GUnit destUnit) Converts the units of value to unit.
String	getCompactedName() Returns the name of the unit decomposed in basicUnits, without multipliers and sorted.
String	getName() Get the string representing the unit name.
boolean	isCompatible(GUnit unit) Determines if unit is compatible with the GUnit object.
boolean	isValidUnitName(String unitName) Verify if a unit name string represents a valid unit.

Method Detail

isValidUnitName

boolean isValidUnitName(String unitName)

Verify if a unit name string represents a valid unit.

Parameters:

unitName - unit name string to test.

Returns:

true if the unit name represents a valid unit, false otherwise.

isCompatible

boolean isCompatible(GUnit unit)

Determines if unit is compatible with the GUnit object. Allows to verify compatibility between 2 units.

Parameters:

unit - to check if it is compatible.

Returns:

true if the unit is compatible, false otherwise.

convertToUnit

BigDecimal convertToUnit(BigDecimal value,
                         GUnit destUnit)
                  throws GException

Converts the units of value to unit. The conversion is done passing converting to and from the memory unit.

Parameters:

value - to convert.

destUnit - the destination unit.

Returns:

the converted value.

Throws:

GException - in case of an error performing the conversion.

convertToUnit

double convertToUnit(double value,
                     GUnit destUnit)
              throws GException

Converts the units of value to unit. The conversion is done passing converting to and from the memory unit.

Parameters:

value - to convert.

destUnit - the destination unit.

Returns:

the converted value.

Throws:

GException - in case of an error performing the conversion.

convertToMemory

BigDecimal convertToMemory(BigDecimal value)

Converts the value to the memory unit. Convert the present value of unit to unit used in the configuration file.

Parameters:

value - to convert.

Returns:

the converted value.

convertToMemory

double convertToMemory(double value)

Converts the value to the memory unit. Convert the present value of unit to unit used in the configuration file.

Parameters:

value - to convert.

Returns:

the converted value.

convertFromMemory

BigDecimal convertFromMemory(BigDecimal value)

Converts the value from the memory unit. Convert the value of unit used in the configuration file to unit selected at present.

Parameters:

value - to convert.

Returns:

the converted value.

convertFromMemory

double convertFromMemory(double value)

Converts the value from the memory unit. Convert the value of unit used in the configuration file to unit selected at present.

Parameters:

value - to convert.

Returns:

the converted value.

getName

String getName()

Get the string representing the unit name. Name of unit for display.

Returns:

the string representing the unit name.

getCompactedName

String getCompactedName()

Returns the name of the unit decomposed in basicUnits, without multipliers and sorted. Used to verify the compatibility between units.

Returns:

the name of the unit decomposed in basicUnits, without multipliers and sorted.