at.borkowski.scovillej.impl

Class SimulationImpl

java.lang.Object

at.borkowski.scovillej.impl.SimulationImpl

All Implemented Interfaces:

Simulation

public class SimulationImpl
extends Object
implements Simulation

An implementation for Simulation.

Field Summary

Fields inherited from interface at.borkowski.scovillej.simulation.Simulation

TICK_PHASE

Constructor Summary

Constructors

Constructor and Description
SimulationImpl(long totalTicks, List<String> phases, List<SimulationMember> members, Map<String,SeriesProvider<?>> series, Set<ServiceProvider<?>> services) Creates a new simulation.

Method Summary

Modifier and Type	Method and Description
void	executeAndIncreaseTick() Executes the current tick and advanced to the next tick.
void	executeCurrentTick() Executes the current tick.
boolean	executedCurrentTick() Determines whether the current tick has been prepared (return value is false) or has already been processed (returned value is true).
void	executeToEnd() Executes the simulation from the current tick until the total number of ticks defined (see Simulation.getTotalTicks()).
void	executeUpToTick(long tick) Executes the simulation up to the given tick, stopping at this tick in a non-processed state (Simulation.executedCurrentTick() is false).
long	getCurrentTick() Returns the current tick.
List<String>	getPhases() Returns the phases used in this simulation.
<T> SeriesResult<T>	getSeries(String symbol, Class<T> clazz) Returns the series result for a given series.
long	getTotalTicks() Returns the number of ticks this simulation has been configured to process.
void	increaseTick() Advances to the next tick.
void	increaseTickStrictly() Advances to the next tick.
Map<Long,List<SimulationEvent>>	test__getEventsMap() Testability method only.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimulationImpl

public SimulationImpl(long totalTicks,
                      List<String> phases,
                      List<SimulationMember> members,
                      Map<String,SeriesProvider<?>> series,
                      Set<ServiceProvider<?>> services)

Creates a new simulation. The returned simulation is standing at tick 0 before processing.

Parameters:

totalTicks - the total ticks this simulation must run for

phases - a list of phases to be used

members - a list of members to be serviced

series - a list of series to be recorded

services - a list of services to be provided

Method Detail

executeToEnd

public void executeToEnd()

Description copied from interface: Simulation

Executes the simulation from the current tick until the total number of ticks defined (see Simulation.getTotalTicks()).

Specified by:

executeToEnd in interface Simulation

executeUpToTick

public void executeUpToTick(long tick)

Description copied from interface: Simulation

Executes the simulation up to the given tick, stopping at this tick in a non-processed state (Simulation.executedCurrentTick() is false).

Specified by:

executeUpToTick in interface Simulation

Parameters:

tick - the tick to stop before

executeCurrentTick

public void executeCurrentTick()

Description copied from interface: Simulation

Executes the current tick. This method may only be called if the simulation has not executed the current tick yet. Otherwise, an IllegalStateException is thrown.

Specified by:

executeCurrentTick in interface Simulation

getCurrentTick

public long getCurrentTick()

Description copied from interface: Simulation

Returns the current tick. This tick is either ready for processing ( Simulation.executedCurrentTick() is false) or has already been processed ( Simulation.executedCurrentTick() is true).

Specified by:

getCurrentTick in interface Simulation

Returns:

the current tick

executeAndIncreaseTick

public void executeAndIncreaseTick()

Description copied from interface: Simulation

Executes the current tick and advanced to the next tick. This method may only be called if the simulation has not executed the current tick yet. Otherwise, an IllegalStateException is thrown.

Specified by:

executeAndIncreaseTick in interface Simulation

increaseTick

public void increaseTick()

Description copied from interface: Simulation

Advances to the next tick. This method may only be called if the simulation has already executed the current tick. If this method is called and the simulation has finished processing the last tick, no action is taken. See Simulation.increaseTickStrictly() for a version where this behavior is different.

Specified by:

increaseTick in interface Simulation

increaseTickStrictly

public void increaseTickStrictly()

Description copied from interface: Simulation

Advances to the next tick. This method may only be called if the simulation has already executed the current tick. If this method is called and the simulation has finished processing the last tick, IllegalStateException is thrown. See Simulation.increaseTickStrictly() for a version where this behavior is different.

Specified by:

increaseTickStrictly in interface Simulation

executedCurrentTick

public boolean executedCurrentTick()

Description copied from interface: Simulation

Determines whether the current tick has been prepared (return value is false) or has already been processed (returned value is true).

Specified by:

executedCurrentTick in interface Simulation

Returns:

whether the current tick has already been processed

getTotalTicks

public long getTotalTicks()

Description copied from interface: Simulation

Returns the number of ticks this simulation has been configured to process.

Specified by:

getTotalTicks in interface Simulation

Returns:

the total number of ticks for this simulation

getSeries

public <T> SeriesResult<T> getSeries(String symbol,
                                     Class<T> clazz)

Description copied from interface: Simulation

Returns the series result for a given series. Note that while this method may be called mid-simulation and will return correct results for the current tick, advancing by ticks may render the returned object unusable or have it provide invalid results. Generally, the returned object is value only until the next advancing in the simulation. If the symbol is not known of the class does not match the originally created series, null is returned.

Specified by:

getSeries in interface Simulation

Type Parameters:

T - the type of series to reutrn

Parameters:

symbol - the symbol to return the series result for

clazz - the class of the series

Returns:

the series result

test__getEventsMap

public Map<Long,List<SimulationEvent>> test__getEventsMap()

Testability method only.

Returns:

the internal events map

getPhases

public List<String> getPhases()

Description copied from interface: Simulation

Returns the phases used in this simulation.

Specified by:

getPhases in interface Simulation

Returns:

the phases used in this simulation.