Package org.goplanit.utils.unit

Interface Unit

All Known Implementing Classes:

DistanceUnit, GroupUnit, NoneUnit, SimpleUnit, SrsUnit, TimeUnit, VehiclesUnit

public interface Unit

Lightweight Unit interface to define units and allow for conversions between them

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
static TimeUnit	HOUR	predefined HOUR TimeUnit
static DistanceUnit	KM	predefined KM DistanceUnit
static Unit	KM_HOUR	predefined KM/HOUR Unit
static DistanceUnit	METER	predefined METER DistanceUnit
static Unit	METER_SECOND	predefined METER/SECOND Unit
static TimeUnit	MINUTE	predefined MINUTE TimeUnit
static Unit	NONE
static VehiclesUnit	PCU	predefined PCU VehiclesUnit
static Unit	PCU_HOUR	predefined PCU/HOUR Unit
static Unit	PCU_KM	predefined PCU/KM Unit
static TimeUnit	SECOND	predefined SECOND TimeUnit
static Unit	SRS	predefined SRS SRSUnit
static VehiclesUnit	VEH	predefined VEHICLE VehiclesUnit
static Unit	VEH_HOUR	predefined VEH/HOUR Unit
static Unit	VEH_KM	predefined VEH/KM Unit

Method Summary

Modifier and Type	Method	Description
boolean	canConvertTo(Unit to)	Verify if unit can be converted to the desired unit
double	convertTo(Unit to, double value)	Convert one unit to the other for a given value
boolean	isCombinedUnit()	Is the unit a single or combined unit
static SimpleUnit	of(UnitType type)	Create unit based on given type
static GroupUnit	of(UnitType[] numeratorUnits, UnitType[] denominatorUnits)	Create unit based on given types

Field Detail

NONE

static final Unit NONE

HOUR

static final TimeUnit HOUR

predefined HOUR TimeUnit

MINUTE

static final TimeUnit MINUTE

predefined MINUTE TimeUnit

SECOND

static final TimeUnit SECOND

predefined SECOND TimeUnit

KM

static final DistanceUnit KM

predefined KM DistanceUnit

METER

static final DistanceUnit METER

predefined METER DistanceUnit

PCU

static final VehiclesUnit PCU

predefined PCU VehiclesUnit

VEH

static final VehiclesUnit VEH

predefined VEHICLE VehiclesUnit

SRS

static final Unit SRS

predefined SRS SRSUnit

KM_HOUR

static final Unit KM_HOUR

predefined KM/HOUR Unit

METER_SECOND

static final Unit METER_SECOND

predefined METER/SECOND Unit

PCU_HOUR

static final Unit PCU_HOUR

predefined PCU/HOUR Unit

PCU_KM

static final Unit PCU_KM

predefined PCU/KM Unit

VEH_HOUR

static final Unit VEH_HOUR

predefined VEH/HOUR Unit

VEH_KM

static final Unit VEH_KM

predefined VEH/KM Unit

Method Detail

isCombinedUnit

boolean isCombinedUnit()

Is the unit a single or combined unit

Returns:

false when single, true when combined

convertTo

double convertTo(Unit to,
                 double value)
          throws PlanItException

Convert one unit to the other for a given value

Parameters:

to - to unit

value - value to convert

Returns:

converted value

Throws:

PlanItException - thrown if not possible to perform conversion

canConvertTo

boolean canConvertTo(Unit to)

Verify if unit can be converted to the desired unit

Parameters:

to - to unit

Returns:

true when compatible, false otherwise

of

static SimpleUnit of(UnitType type)

Create unit based on given type

Parameters:

type - to use

Returns:

unit created

of

static GroupUnit of(UnitType[] numeratorUnits,
                    UnitType[] denominatorUnits)

Create unit based on given types

Parameters:

numeratorUnits - to use

denominatorUnits - to use

Returns:

combined unit created