org.jeospace.simulation
Class ChronPeriod

java.lang.Object
  org.jeospace.simulation.ChronPeriod

public class ChronPeriod

extends java.lang.Object

Object for defining periods of virtual time used in simulation control. Used for getting and setting the Chronometer's rate of time passage.

Version:

$Revision: 1.1.1.1 $

Author:

Rex Melton

See Also:

Chronometer

Constructor Summary

ChronPeriod(ChronPeriod cp)
Construct a ChronPeriod object.

ChronPeriod(int multiplier, TimeUnit timeUnit)
Construct a ChronPeriod object.

Method Summary

int	getMultiplier() Return the multiplier component of the ChronPeriod.
TimeUnit	getTimeUnit() Return the TimeUnit component of the ChronPeriod.
void	setMultiplier(int multiplier) Set the multiplier component of the ChronPeriod.
void	setTimeUnit(TimeUnit timeUnit) Set the TimeUnit component of the ChronPeriod.
java.lang.String	toString() Return the String representation of the ChronPeriod.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChronPeriod

public ChronPeriod(int multiplier,
                   TimeUnit timeUnit)

Construct a ChronPeriod object.

Parameters:

multiplier - the multiplier of the TimeUnit

timeUnit - the base chronometer time period.

ChronPeriod

public ChronPeriod(ChronPeriod cp)

Construct a ChronPeriod object.

Parameters:

cp - a ChronPeriod object to duplicate.

Method Detail

getMultiplier

public int getMultiplier()

Return the multiplier component of the ChronPeriod.

Returns:

the multiplier

setMultiplier

public void setMultiplier(int multiplier)

Set the multiplier component of the ChronPeriod.

Parameters:

multiplier - the multiplier

getTimeUnit

public TimeUnit getTimeUnit()

Return the TimeUnit component of the ChronPeriod.

Returns:

the TimeUnit

setTimeUnit

public void setTimeUnit(TimeUnit timeUnit)

Set the TimeUnit component of the ChronPeriod.

Parameters:

timeUnit - the TimeUnit

toString

public java.lang.String toString()

Return the String representation of the ChronPeriod.

Returns:

the String representation of the ChronPeriod.