Package repast.simphony.parameter

Interface ParameterSweeper

All Superinterfaces:

ParameterSetter

All Known Implementing Classes:

OptimizedParameterSweeper, ParameterTreeSweeper

public interface ParameterSweeper
extends ParameterSetter

An interface representing an object that will perform a sweep of a parameter space represented by a series of ParameterSetters.

Author:

Jerry Vos

Method Summary

Modifier and Type	Method	Description
void	add(ParameterSetter parent, ParameterSetter setter)	Adds the given ParameterSetter to be executed.
Collection<ParameterSetter>	getChildren(ParameterSetter parentSetter)	Retrieves the ParameterSetters that are direct children of the specified setter.
ParameterSetter	getRootParameterSetter()	Retrieves the root ParameterSetter, that all other setters are a child of.
void	remove(ParameterSetter setter)	Removes the given ParameterSetter from those to be executed

Methods inherited from interface repast.simphony.parameter.ParameterSetter

atEnd, next, reset

Method Detail

add

void add(ParameterSetter parent,
         ParameterSetter setter)

Adds the given ParameterSetter to be executed.

Parameters:

parent - the parent setter the new setter is a child of

setter - a parameter setter that will be executed

remove

void remove(ParameterSetter setter)

Removes the given ParameterSetter from those to be executed

Parameters:

setter - a parameter setter to remove

getRootParameterSetter

ParameterSetter getRootParameterSetter()

Retrieves the root ParameterSetter, that all other setters are a child of.

Returns:

the root ParameterSetter

getChildren

Collection<ParameterSetter> getChildren(ParameterSetter parentSetter)

Retrieves the ParameterSetters that are direct children of the specified setter.

Parameters:

parentSetter - the setter whose children to fetch

Returns:

the direct descendants of the specified setter