com.dautelle.physics
Class Frequency

java.lang.Object
  java.lang.Number
      com.dautelle.math.numbers.RealtimeNumber
          com.dautelle.physics.Quantity
              com.dautelle.physics.Frequency

All Implemented Interfaces:

java.lang.Comparable, Operable, Realtime, Representable, java.io.Serializable

public class Frequency

extends Quantity

This class represents the number of times a specified phenomenon occurs within a specified interval. The system unit for this quantity is "1/s". By default, instances of this quantity are showed in Hertz ("Hz").

Version:

4.1, February 10, 2003

Author:

Jean-Marie Dautelle

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class com.dautelle.physics.Quantity

Quantity.Factory, Quantity.Value

Field Summary

static Frequency

ZERO Represents a Frequency amounting to nothing.

Constructor Summary

protected

Frequency() Default constructor (allows for derivation).

Method Summary

static Frequency	frequencyOf(Quantity quantity) Returns the Frequency corresponding to the specified quantity.
static void	showAs(Unit unit) Shows Frequency instances in the specified unit.

Methods inherited from class com.dautelle.physics.Quantity

abs, add, appendTo, approxEquals, approxEquals, compareTo, divide, divide, doubleValue, doubleValue, equals, floatValue, floatValue, getAbsoluteError, getMaximum, getMinimum, getOutputUnit, getRelativeError, getSystemUnit, hashCode, intValue, intValue, inverse, isPossiblyZero, longValue, longValue, multiply, multiply, negate, opposite, plus, pow, random, reciprocal, root, subtract, times, toString, toString, toXml, valueOf, valueOf, valueOf, valueOf

Methods inherited from class com.dautelle.math.numbers.RealtimeNumber

clone, export, isLocalObject, isPoolObject, pow, recycle, toHeap

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ZERO

public static final Frequency ZERO

Represents a Frequency amounting to nothing.

Constructor Detail

Frequency

protected Frequency()

Default constructor (allows for derivation).

Method Detail

frequencyOf

public static Frequency frequencyOf(Quantity quantity)

Returns the Frequency corresponding to the specified quantity.

Parameters:

quantity - a quantity compatible with Frequency.

Returns:

the specified quantity or a new Frequency instance.

Throws:

ConversionException - if the current model does not allow the specified quantity to be converted to Frequency.

showAs

public static void showAs(Unit unit)

Shows Frequency instances in the specified unit.

Parameters:

unit - the output unit for Frequency instances.

See Also:

Quantity.getOutputUnit()