org.volante.abm.output

Class TakeoverCellOutputter

java.lang.Object

org.volante.abm.output.AbstractOutputter

org.volante.abm.output.TableOutputter<TakeoverCellOutputter.RegionPotentialAgent>

org.volante.abm.output.TakeoverCellOutputter

All Implemented Interfaces:

TakeoverObserver, Outputter, GloballyInitialisable

public class TakeoverCellOutputter
extends TableOutputter<TakeoverCellOutputter.RegionPotentialAgent>
implements GloballyInitialisable, TakeoverObserver

Uses Observer pattern: Registers at those AllocationModels that implement TakeoverMessenger. This is useful since the component that knows about take-overs is an exchangeable component and this way not every AllocationModel is required to implement the service. Furthermore, this way take-overs only need to be reported in case there is a TakeoverObserver registered. NOTE: There is one instance of TakeoverCellOutputter that handles all regions, even if perRegion == true. NOTE: If perRegion == false there are columns for each AFT per region, even if regions share the same set of AFTs. NOTE: Assumes that AFT IDs do not leave out any number (i.e. max(AFT-ID) == length(AFTs))

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TakeoverCellOutputter.RegionPotentialAgent
class	TakeoverCellOutputter.TakeOverAftColumn
class	TakeoverCellOutputter.TakeOverColumn

Nested classes/interfaces inherited from class org.volante.abm.output.TableOutputter

TableOutputter.RegionsColumn<T>, TableOutputter.TickColumn<T>

Field Summary

Fields inherited from class org.volante.abm.output.AbstractOutputter

disabled, endYear, everyNYears, log, modelData, outputs, persister, runInfo, startYear

Constructor Summary

Constructors

Constructor and Description
TakeoverCellOutputter()

Method Summary

Modifier and Type	Method and Description
Iterable<TakeoverCellOutputter.RegionPotentialAgent>	getData(Regions r)
String	getDefaultOutputName()
void	initialise(ModelData data, RunInfo info, Regions regions)
void	initTakeOvers(Region region) To be called before the first output.
void	setOutputManager(Outputs outputs)
void	setTakeover(Region region, Agent previousAgent, Agent newAgent)
void	startFile(String filename, Regions regions)
void	writeData(Iterable<TakeoverCellOutputter.RegionPotentialAgent> data, Regions r)

Methods inherited from class org.volante.abm.output.TableOutputter

addColumn, close, doOutput, endFile, filePerTick, writeFile

Methods inherited from class org.volante.abm.output.AbstractOutputter

disable, filename, getEndYear, getEveryNYears, getExtension, getOutputName, getStartYear, initialise, open, setOutputName, tickFilename

Methods inherited from class java.lang.Object

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

Constructor Detail

TakeoverCellOutputter

public TakeoverCellOutputter()

Method Detail

initialise

public void initialise(ModelData data,
                       RunInfo info,
                       Regions regions)
                throws Exception

Specified by:

initialise in interface GloballyInitialisable

Parameters:

data - model data

info - run information

Throws:

Exception

See Also:

GloballyInitialisable.initialise(org.volante.abm.data.ModelData, org.volante.abm.schedule.RunInfo, org.volante.abm.data.Regions)

startFile

public void startFile(String filename,
                      Regions regions)
               throws IOException

Overrides:

startFile in class TableOutputter<TakeoverCellOutputter.RegionPotentialAgent>

Throws:

IOException

setOutputManager

public void setOutputManager(Outputs outputs)

Specified by:

setOutputManager in interface Outputter

Overrides:

setOutputManager in class AbstractOutputter

See Also:

AbstractOutputter.setOutputManager(org.volante.abm.output.Outputs)

initTakeOvers

public void initTakeOvers(Region region)

Description copied from interface: TakeoverObserver

To be called before the first output.

Specified by:

initTakeOvers in interface TakeoverObserver

setTakeover

public void setTakeover(Region region,
                        Agent previousAgent,
                        Agent newAgent)

Specified by:

setTakeover in interface TakeoverObserver

See Also:

TakeoverObserver.setTakeover(org.volante.abm.data.Region, org.volante.abm.agent.Agent, org.volante.abm.agent.Agent)

getData

public Iterable<TakeoverCellOutputter.RegionPotentialAgent> getData(Regions r)

Specified by:

getData in class TableOutputter<TakeoverCellOutputter.RegionPotentialAgent>

See Also:

TableOutputter.getData(org.volante.abm.data.Regions)

getDefaultOutputName

public String getDefaultOutputName()

Specified by:

getDefaultOutputName in class AbstractOutputter

See Also:

AbstractOutputter.getDefaultOutputName()

writeData

public void writeData(Iterable<TakeoverCellOutputter.RegionPotentialAgent> data,
                      Regions r)
               throws IOException

Overrides:

writeData in class TableOutputter<TakeoverCellOutputter.RegionPotentialAgent>

Throws:

IOException

See Also:

TableOutputter.writeData(java.lang.Iterable, org.volante.abm.data.Regions)