Package com.luciad.ais.model.util

Class TLcdFrequencyUnit

java.lang.Object

com.luciad.ais.model.util.TLcdFrequencyUnit

public class TLcdFrequencyUnit
extends Object

This class defines frequency unit constants.

Field Summary

Fields

Modifier and Type	Field	Description
static final TLcdFrequencyUnit	GHZ_UNIT	GigaHertz.
static final TLcdFrequencyUnit	HZ_UNIT	Hertz.
static final TLcdFrequencyUnit	KHZ_UNIT	KiloHertz.
static final TLcdFrequencyUnit	MHZ_UNIT	MegaHertz.

Method Summary

Modifier and Type	Method	Description
static TLcdFrequencyUnit[]	getAllFrequencyUnits()	Returns all TLcdFrequencyUnit objects to consider in a JVM session.
double	getToHertzFactor()	Returns the factor to apply to convert a frequency expressed in the TLcdFrequencyUnit into a frequency in hertz.
String	getUnitName()	Returns the name of the TLcdFrequencyUnit (e.g.
String	getUnitShortName()	Returns the short name of the TLcdFrequencyUnit (e.g.
static void	setAllFrequencyUnits(TLcdFrequencyUnit[] aAllFrequencyUnitArray)	Sets statically all TLcdFrequencyUnit objects to consider in a JVM session.
String	toString()	Returns the unit name.

Methods inherited from class java.lang.Object

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

Field Details

GHZ_UNIT

public static final TLcdFrequencyUnit GHZ_UNIT

GigaHertz.

MHZ_UNIT

public static final TLcdFrequencyUnit MHZ_UNIT

MegaHertz.

KHZ_UNIT

public static final TLcdFrequencyUnit KHZ_UNIT

KiloHertz.

HZ_UNIT

public static final TLcdFrequencyUnit HZ_UNIT

Hertz.

Method Details

getUnitName

public String getUnitName()

Returns the name of the TLcdFrequencyUnit (e.g. Hertz, Kilohertz, etc ...).

Returns:

the name of the TLcdFrequencyUnit (e.g. Hertz, Kilohertz, etc ...)

getUnitShortName

public String getUnitShortName()

Returns the short name of the TLcdFrequencyUnit (e.g. Hz, KHz, etc ...).

Returns:

the short name of the TLcdFrequencyUnit (e.g. Hz, KHz, etc ...)

getToHertzFactor

public double getToHertzFactor()

Returns the factor to apply to convert a frequency expressed in the TLcdFrequencyUnit into a frequency in hertz.

Returns:

the factor to apply to convert a frequency expressed in the TLcdFrequencyUnit into a frequency in hertz

getAllFrequencyUnits

public static TLcdFrequencyUnit[] getAllFrequencyUnits()

Returns all TLcdFrequencyUnit objects to consider in a JVM session.

Returns:

all TLcdFrequencyUnit objects to consider in a JVM session

setAllFrequencyUnits

public static void setAllFrequencyUnits(TLcdFrequencyUnit[] aAllFrequencyUnitArray)

Sets statically all TLcdFrequencyUnit objects to consider in a JVM session. Typically, this method should be called in the main of the application.

Parameters:

aAllFrequencyUnitArray - the frequency units to consider in a JVM session

toString

public String toString()

Returns the unit name.

Overrides:

toString in class Object

Returns:

the unit name.