org.volante.abm.output

Class GivingInStatisticsOutputter

java.lang.Object

org.volante.abm.output.AbstractOutputter

org.volante.abm.output.TableOutputter<Integer>

org.volante.abm.output.GivingInStatisticsOutputter

All Implemented Interfaces:

GivingInStatisticsObserver, Outputter, GloballyInitialisable

public class GivingInStatisticsOutputter
extends TableOutputter<Integer>
implements GloballyInitialisable, GivingInStatisticsObserver

Records number of searches that end up with a certain number of trials (rows) for every region (columns) and every AFT (column) within a region. Optionally per tick (rows). The messenger only reports take overs that occur. Therefore, this class must check whether there are only take overs for a specific AFT in a particular region.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GivingInStatisticsOutputter.NumberColumn
class	GivingInStatisticsOutputter.SearchedCellsAftColumn

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
GivingInStatisticsOutputter()

Method Summary

Modifier and Type	Method and Description
Iterable<Integer>	getData(Regions r)
String	getDefaultOutputName()
void	initGivingInStatistic(Region region)
void	initialise(ModelData data, RunInfo info, Regions regions)
void	setNumberSearchedCells(Region region, PotentialAgent pa, int number)
void	setOutputManager(Outputs outputs)
void	startFile(String filename, Regions regions) Filter out SearchedCellsAftColumn that are not among requested regions (important for region-specific files)
void	writeData(Iterable<Integer> 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

GivingInStatisticsOutputter

public GivingInStatisticsOutputter()

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

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)

initGivingInStatistic

public void initGivingInStatistic(Region region)

Specified by:

initGivingInStatistic in interface GivingInStatisticsObserver

getData

public Iterable<Integer> getData(Regions r)

Specified by:

getData in class TableOutputter<Integer>

getDefaultOutputName

public String getDefaultOutputName()

Specified by:

getDefaultOutputName in class AbstractOutputter

startFile

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

Filter out SearchedCellsAftColumn that are not among requested regions (important for region-specific files)

Overrides:

startFile in class TableOutputter<Integer>

Throws:

IOException

See Also:

TableOutputter.startFile(java.lang.String, org.volante.abm.data.Regions)

writeData

public void writeData(Iterable<Integer> data,
                      Regions r)
               throws IOException

Overrides:

writeData in class TableOutputter<Integer>

Throws:

IOException

See Also:

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

setNumberSearchedCells

public void setNumberSearchedCells(Region region,
                                   PotentialAgent pa,
                                   int number)

Specified by:

setNumberSearchedCells in interface GivingInStatisticsObserver