agentgui.simulationService.time

Class TimeModelDiscrete

java.lang.Object

agentgui.simulationService.time.TimeModel

agentgui.simulationService.time.TimeModelDateBased

agentgui.simulationService.time.TimeModelDiscrete

All Implemented Interfaces:

java.io.Serializable

public class TimeModelDiscrete
extends TimeModelDateBased

This is a discrete time model, which can either start from 0 or from a specified time. Additionally the step width in time has to be configured in order to allow a discrete temporal progression.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_DisplayUnitIndex
static java.lang.String	PROP_StepWidth
static java.lang.String	PROP_TimeCurrent
static java.lang.String	PROP_TimeFormat
static java.lang.String	PROP_TimeStart
static java.lang.String	PROP_TimeStop

Fields inherited from class agentgui.simulationService.time.TimeModelDateBased

DEFAULT_TIME_FORMAT, timeFormat, timeStart, timeStop

Constructor Summary

Constructors

Constructor and Description
TimeModelDiscrete() Instantiates a new time model discrete.
TimeModelDiscrete(long stepInTime) Instantiates a new time model discrete.
TimeModelDiscrete(long startTime, long stopTime, long stepInTime) Instantiates a new time model discrete.

Method Summary

Modifier and Type	Method and Description
TimeModel	getCopy() Returns a copy of the current TimeModel.
TimeModelBaseExecutionElements	getDisplayElements4Execution() Returns a DisplayJToolBar4Execution (an extended JToolBar) that consists of the necessary tools to handle a TimeModel during execution.
JPanel4TimeModelConfiguration	getJPanel4Configuration(Project project) Returns the DisplayJPanel4Configuration.java (an extended JPanel) for the configuration of a TimeModel (before the agency is executed).
long	getStep() Returns the step width as long.
int	getStepDisplayUnitAsIndexOfTimeUnitVector() Returns the step display unit as index of the TimeUnitVector.
long	getTime()
java.util.HashMap<java.lang.String,java.lang.String>	getTimeModelSetting() Returns the setup configuration of the TimeModel as HashSet consisting of (property, value).
void	setStep(long step) Sets the step width.
void	setStepDisplayUnitAsIndexOfTimeUnitVector(int stepDisplayUnitAsIndexOfTimeUnitVector) Sets the step display unit as index of the TimeUnitVector.
void	setTime(long counter) Sets the current time of the model.
void	setTimeModelSettings(java.util.HashMap<java.lang.String,java.lang.String> timeModelSettings) Sets the setup configuration as HashSet (property, value) to the TimeModel.
void	step() Steps the time with the given time step.
void	stepBack() Steps back the time with the given time step.

Methods inherited from class agentgui.simulationService.time.TimeModelDateBased

getDateForMidnight, getDateForMidnight, getTimeFormat, getTimeStart, getTimeStop, setTimeFormat, setTimeStart, setTimeStop

Methods inherited from class agentgui.simulationService.time.TimeModel

getStopWatch, setStopWatch

Methods inherited from class java.lang.Object

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

Field Detail

PROP_TimeCurrent

public static final java.lang.String PROP_TimeCurrent

See Also:

Constant Field Values

PROP_TimeStart

public static final java.lang.String PROP_TimeStart

See Also:

Constant Field Values

PROP_TimeStop

public static final java.lang.String PROP_TimeStop

See Also:

Constant Field Values

PROP_StepWidth

public static final java.lang.String PROP_StepWidth

See Also:

Constant Field Values

PROP_DisplayUnitIndex

public static final java.lang.String PROP_DisplayUnitIndex

See Also:

Constant Field Values

PROP_TimeFormat

public static final java.lang.String PROP_TimeFormat

See Also:

Constant Field Values

Constructor Detail

TimeModelDiscrete

public TimeModelDiscrete()

Instantiates a new time model discrete.

TimeModelDiscrete

public TimeModelDiscrete(long stepInTime)

Instantiates a new time model discrete.

Parameters:

stepInTime - the step width in time

TimeModelDiscrete

public TimeModelDiscrete(long startTime,
                         long stopTime,
                         long stepInTime)

Instantiates a new time model discrete.

Parameters:

stepInTime - the step width in time

startTime - the start time

Method Detail

getCopy

public TimeModel getCopy()

Description copied from class: TimeModel

Returns a copy of the current TimeModel.

Specified by:

getCopy in class TimeModel

Returns:

the copy of the current TimeModel

setTime

public void setTime(long counter)

Sets the current time of the model.

Parameters:

counter - the counter to set

getTime

public long getTime()

Specified by:

getTime in class TimeModelDateBased

step

public void step()

Steps the time with the given time step.

Specified by:

step in class TimeModel

stepBack

public void stepBack()

Steps back the time with the given time step.

Specified by:

stepBack in class TimeModel

getStep

public long getStep()

Returns the step width as long.

Returns:

the step

setStep

public void setStep(long step)

Sets the step width.

Parameters:

step - the step width as long

setStepDisplayUnitAsIndexOfTimeUnitVector

public void setStepDisplayUnitAsIndexOfTimeUnitVector(int stepDisplayUnitAsIndexOfTimeUnitVector)

Sets the step display unit as index of the TimeUnitVector.

Parameters:

stepDisplayUnitAsIndexOfTimeUnitVector - the new step display unit as index of the TimeUnitVector

See Also:

TimeUnitVector

getStepDisplayUnitAsIndexOfTimeUnitVector

public int getStepDisplayUnitAsIndexOfTimeUnitVector()

Returns the step display unit as index of the TimeUnitVector.

Returns:

the step display unit as index of the TimeUnitVector

See Also:

TimeUnitVector

getJPanel4Configuration

public JPanel4TimeModelConfiguration getJPanel4Configuration(Project project)

Description copied from class: TimeModel

Returns the DisplayJPanel4Configuration.java (an extended JPanel) for the configuration of a TimeModel (before the agency is executed).

Specified by:

getJPanel4Configuration in class TimeModel

Parameters:

project - the current Agent.GUI Project

Returns:

the DisplayJPanel4Configuration.java for the TimeModel configuration

getDisplayElements4Execution

public TimeModelBaseExecutionElements getDisplayElements4Execution()

Description copied from class: TimeModel

Returns a DisplayJToolBar4Execution (an extended JToolBar) that consists of the necessary tools to handle a TimeModel during execution.

Specified by:

getDisplayElements4Execution in class TimeModel

Returns:

the DisplayJToolBar4Execution with tools that can be used during the runtime of the agency

setTimeModelSettings

public void setTimeModelSettings(java.util.HashMap<java.lang.String,java.lang.String> timeModelSettings)

Description copied from class: TimeModel

Sets the setup configuration as HashSet (property, value) to the TimeModel.

Specified by:

setTimeModelSettings in class TimeModel

Parameters:

timeModelSettings - the time model setup configuration as HashSet (property, value)

getTimeModelSetting

public java.util.HashMap<java.lang.String,java.lang.String> getTimeModelSetting()

Description copied from class: TimeModel

Returns the setup configuration of the TimeModel as HashSet consisting of (property, value).

Specified by:

getTimeModelSetting in class TimeModel

Returns:

the setup configuration as HashSet consisting of (property, value)