at.borkowski.scovillej.simulation

Interface SimulationMember

All Known Subinterfaces:

ServiceProvider<T>

public interface SimulationMember

Represents a member of a simulation. A member is capable of creating events for ticks, and may also handle ticks on a periodic bases.

Method Summary

Modifier and Type	Method and Description
Collection<SimulationEvent>	generateEvents() This method is called by the simulation implementation in order to pre-create all events necessary for this member.
Collection<PhaseHandler>	getPhaseHandlers() Returns a collection of objects which handle phase events for the simulation necessary for this simulation member.
void	initialize(Simulation simulation, SimulationInitializationContext context) Called during the initialization phase of the simulation.

Method Detail

initialize

void initialize(Simulation simulation,
                SimulationInitializationContext context)

Called during the initialization phase of the simulation.

Parameters:

simulation - the owning simulation

context - a context object providing initialization functionality

generateEvents

Collection<SimulationEvent> generateEvents()

This method is called by the simulation implementation in order to pre-create all events necessary for this member. The method should be called only once, but it should also return the same events (not necessarily a deep copy) upon each call. This method may return null instead of an empty list.

Returns:

a collection of events for this member, or null if this member does not require events

getPhaseHandlers

Collection<PhaseHandler> getPhaseHandlers()

Returns a collection of objects which handle phase events for the simulation necessary for this simulation member. This collection may be empty, for example if the member only requires SimulationEvent objects to function. This method may return null instead of an empty list.

Returns:

a collection of phase handlers, or null if this member does not require phase handling.