MATSIM
Public Member Functions | List of all members
org.matsim.core.replanning.modules.GenericPlanStrategyModule< T extends BasicPlan > Interface Template Reference
Inheritance diagram for org.matsim.core.replanning.modules.GenericPlanStrategyModule< T extends BasicPlan >:
Inheritance graph
[legend]

Public Member Functions

void prepareReplanning (ReplanningContext replanningContext)
 
void handlePlan (T plan)
 
void finishReplanning ()
 

Detailed Description

Definition at line 27 of file GenericPlanStrategyModule.java.

Member Function Documentation

◆ prepareReplanning()

void org.matsim.core.replanning.modules.GenericPlanStrategyModule< T extends BasicPlan >.prepareReplanning ( ReplanningContext  replanningContext)

Initializes this module before handling plans. Modules using an external routine could e.g. open a file here to write the plans out and pass them to the external routines. Multi-threaded modules could initialize and start their threads in this method.

Parameters
replanningContextTODO

Implemented in org.matsim.api.core.v01.replanning.PlanStrategyModule, and org.matsim.core.replanning.modules.ModeAndRouteConsistencyChecker.

Referenced by org.matsim.core.replanning.GenericPlanStrategyImpl< Plan, Person >.init().

◆ handlePlan()

Tells this module to handle the specified plan. It is not required that the plan must immediately be handled, e.g. modules calling external routines could just collect the plans here and start the external routine in finishReplanning(), or multi-threaded modules could just add the plan to a synchronized queue for the threads.

Parameters
plan
See also
finishReplanning()

Referenced by org.matsim.core.replanning.GenericPlanStrategyImpl< Plan, Person >.run().

◆ finishReplanning()

Indicates that no additional plans will be handed to this module and waits until this module has finished handling all plans. Modules calling external routines can call those here, or multi-threaded modules can wait here until all threads are finished with their work.

See also
handlePlan(T)

Implemented in org.matsim.api.core.v01.replanning.PlanStrategyModule, and org.matsim.core.replanning.modules.ModeAndRouteConsistencyChecker.

Referenced by org.matsim.core.replanning.GenericPlanStrategyImpl< Plan, Person >.finish().


The documentation for this interface was generated from the following file: