Package repast.simphony.engine.graph

Interface IGraphSchedule

All Superinterfaces:

IAction, ISchedule

All Known Implementing Classes:

DefaultGraphSchedule

public interface IGraphSchedule
extends ISchedule

A schedule that will schedule graphs. This currently is implemented on top of the general Repast schedule, with the nodes being executed at times according to their distance between each other.

Author:

Jerry Vos

See Also:

DefaultGraphSchedule

Method Summary

Modifier and Type	Method	Description
ISchedulableAction	schedule(ScheduleParameters baseParams, Object rootNode, GraphExecutor<?> executor)	Schedules the execution of a graph starting with the specified root node.
ISchedulableAction	schedule(ScheduleParameters baseParams, Object rootNode, Network topology, Executor<Object> nodeExecutor)	Schedules a Repast network to be executed.

Methods inherited from interface repast.simphony.engine.schedule.ISchedule

createAction, execute, executeEndActions, getActionCount, getModelActionCount, getTickCount, getTickCountInTimeQuantity, getTimeQuantity, isFinishing, removeAction, schedule, schedule, schedule, schedule, scheduleIterable, setFinishing, setTimeQuantity

Method Detail

schedule

ISchedulableAction schedule(ScheduleParameters baseParams,
                            Object rootNode,
                            GraphExecutor<?> executor)

Schedules the execution of a graph starting with the specified root node. The base parameters object is used to schedule the execution of the primary node, other nodes' execution should be based on these parameters but should not be scheduled as repeating actions. The base node itself can be scheduled as a repeating action, allowing for repeated execution of the graph.

Parameters:

baseParams - the parameters for scheduling the root node and a basis for the scheduling of the following nodes

rootNode - the node to start execution on

executor - the action that will execute the graph

Returns:

the action scheduled for the root node

schedule

ISchedulableAction schedule(ScheduleParameters baseParams,
                            Object rootNode,
                            Network topology,
                            Executor<Object> nodeExecutor)

Schedules a Repast network to be executed. This is functions the same as schedule(ScheduleParameters, Object, GraphExecutor) but automatically builds the GraphExecutor.

Parameters:

baseParams - the parameters for scheduling the root node and a basis for the scheduling of the following nodes

rootNode - the node to start execution on

topology - the topology to execute

nodeExecutor - the action that will execute nodes in the graph

Returns:

the action scheduled for executing the root node

See Also:

schedule(ScheduleParameters, Object, GraphExecutor)