fr.cnes.genius.unit

Class GMetricUnit

java.lang.Object

fr.cnes.genius.unit.GMetricUnit

All Implemented Interfaces:

GUnit

public class GMetricUnit
extends Object
implements GUnit

Cette classe gére la saisie et les conversions d'unités.

Le propos de cette classe est de fournir à l'utilisateur la possibilité de saisir des unités basées sur le Système International ainsi que les méthodes de conversion. Les unitès composées sont séparées par des "." ou des "/". La puissance s'exprime par le caractère ^. La puissance peut être négative. Ainsi km/s est équivalent à km.s^-1 et 1/s est égal à s-1

Les unités de bases prises en comptes sont :

• kg : kilogramme
• m : mètre
• s : secondes
• K : kelvin
• A : ampères

Aux unités de base ont été ajouté les radians (rad) pour la conversion en degréés.

Les unités composées avec leur définition par rapport aux unités de bases sont :

• sr : steradians (m2.m-2)
• Hz : hertz (s-1)
• N : Newton (kg.m.s-2)
• Pa : Pascal (N.m-2)
• J : Joules (N.m)
• W : watts (J.s-1)
• C : Coulomb (A.s)
• V : Volt (W.A-1)
• F : Farad (C.V-1)
• R : Ohm (V.A-1)

Ont été ajoutés :

• t : tonne = 1000 kg
• mn : minutes = 60 s
• h : heures = 3600 s
• j : jours = 86400 s
• d : days = 86400 s
• mo : mois = 2629800 s
• a : annee = 31557600 s
• y : year = 31557600 s

Les multiples et sous muiltiples pris en comptes sont :

• T : Tera = 10^12
• G : Giga = 10^9
• M : Mega = 10^6
• k : kilo = 10^3
• h : hecto = 10^2
• da : deca = 10
• d : deci = 10^-1
• c : centi = 10^-2
• m : mili = 10^-3
• u : micro = 10^-6
• n : nano = 10^-9
• p : pico = 10^-12

Version:

$Revision:1 $ $Date:2011-02-11 $

Author:

Jean Fourcade

Constructor Summary

Constructors

Constructor and Description
GMetricUnit(String unitName) Constructeur par defaut.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

GMetricUnit

public GMetricUnit(String unitName)

Constructeur par defaut. Construit une nouvelle unité à partir de sa description.

Parameters:

unitName - nom composé de l'unité

Method Detail

isValidUnitName

public boolean isValidUnitName(String unitName)

Verify if a unit name string represents a valid unit.

Specified by:

isValidUnitName in interface GUnit

Parameters:

unitName - unit name string to test.

Returns:

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

isCompatible

public boolean isCompatible(GUnit unit)

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

Specified by:

isCompatible in interface GUnit

Parameters:

unit - to check if it is compatible.

Returns:

true if the unit is compatible, false otherwise.

convertToUnit

public 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.

Specified by:

convertToUnit in interface GUnit

Parameters:

value - to convert.

destUnit - the destination unit.

Returns:

the converted value.

Throws:

GException - in case of an error performing the conversion.

convertToMemory

public double convertToMemory(double value)

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

Specified by:

convertToMemory in interface GUnit

Parameters:

value - to convert.

Returns:

the converted value.

convertFromMemory

public 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.

Specified by:

convertFromMemory in interface GUnit

Parameters:

value - to convert.

Returns:

the converted value.

getName

public String getName()

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

Specified by:

getName in interface GUnit

Returns:

the string representing the unit name.

getCompactedName

public String getCompactedName()

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

Specified by:

getCompactedName in interface GUnit

Returns:

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

convertToUnit

public 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.

Specified by:

convertToUnit in interface GUnit

Parameters:

value - to convert.

destUnit - the destination unit.

Returns:

the converted value.

Throws:

GException - in case of an error performing the conversion.

convertToMemory

public BigDecimal convertToMemory(BigDecimal value)

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

Specified by:

convertToMemory in interface GUnit

Parameters:

value - to convert.

Returns:

the converted value.

convertFromMemory

public 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.

Specified by:

convertFromMemory in interface GUnit

Parameters:

value - to convert.

Returns:

the converted value.