RePast
v. 2.0

uchicago.src.sim.analysis
Class SequenceGraph

java.lang.Object
  |
  +--uchicago.src.sim.analysis.SimGraph
        |
        +--uchicago.src.sim.analysis.SequenceGraph

public class SequenceGraph
extends SimGraph

A graph that displays a connected series of points (a sequence). Encapsulates a sequence statistic class that manages the data. This statistic class can also be set. Typically, a time series updated every tick of the main schedule.


Field Summary
 
Fields inherited from class uchicago.src.sim.analysis.SimGraph
chart, f
 
Constructor Summary
SequenceGraph(SimModel model)
          Deprecated. Constructs a SeqenceGraph with no title.
SequenceGraph(String title, SimModel model)
          Deprecated. Constructs a SequenceGraph with the specified a title and model.
SequenceGraph(String title, SimModel model, String fileName, int fileFormat)
          Deprecated. Constructs a SequenceGraph with the specified title, file name, and file format, and model.
 
Method Summary
 void addSequence(String name, Sequence sequence)
          Deprecated. Adds the specified sequence with the specified name.
 void createAverageSequence(String name, ArrayList feedFrom, String methodName)
          Deprecated. Creates an Average sequence with the specified name, using data from the specified list attained through the specified method name.
 void createSequence(String name, Object feedFrom, String methodName)
          Deprecated. Creates a sequence with the specified name, using data from the specified object attained through the specified method name.
 Statistics getModel()
          Deprecated. Returns the model for this SequenceGraph
 void record()
          Deprecated. Records the new sequence data but do not plot.
 void step()
          Deprecated. Records and plots the new sequence data on the graph
 void writeToFile()
          Deprecated. Write the sequence data to a file.
 
Methods inherited from class uchicago.src.sim.analysis.SimGraph
addDataSource, display, dispose, getChart, setAxisTitles, setFooter, setGraphBackground, setGraphForeground, setHeader, setTitle, setXAxisMax, setXAxisMin, setXAxisMinMax, setXAxisTitle, setYAxisMax, setYAxisMin, setYAxisMinMax, setYAxisTitle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SequenceGraph

public SequenceGraph(SimModel model)
Deprecated. 
Constructs a SeqenceGraph with no title.


SequenceGraph

public SequenceGraph(String title,
                     SimModel model)
Deprecated. 
Constructs a SequenceGraph with the specified a title and model.

Parameters:
title - the title of the graph
model - the model

SequenceGraph

public SequenceGraph(String title,
                     SimModel model,
                     String fileName,
                     int fileFormat)
Deprecated. 
Constructs a SequenceGraph with the specified title, file name, and file format, and model.

Parameters:
title - the title of the graph
model - the model
fileName - the name of the file to write the sequence data to
fileFormat - the format of the file - i.e. Statistics.CSV
Method Detail

createSequence

public void createSequence(String name,
                           Object feedFrom,
                           String methodName)
Deprecated. 
Creates a sequence with the specified name, using data from the specified object attained through the specified method name.

Parameters:
name - of the sequence
feedFrom - the object from which to collect the sequence data
methodName - the name of the method to call on the object to get the data. This method must return a number (int etc.) or a Number (Integer etc.)

addSequence

public void addSequence(String name,
                        Sequence sequence)
Deprecated. 
Adds the specified sequence with the specified name.

Parameters:
name - the name of the sequence
sequence - the sequence to add

createAverageSequence

public void createAverageSequence(String name,
                                  ArrayList feedFrom,
                                  String methodName)
Deprecated. 
Creates an Average sequence with the specified name, using data from the specified list attained through the specified method name. Each object in the list has the named method called on it, the resulting data is averaged, and this average constitutes the data for the sequence.

Parameters:
name - of the sequence
feedFrom - the list from which to collect the sequence data
methodName - the name of the method to call on the object to get the data. This method must return a number (int etc.) or a Number (Integer etc.)

getModel

public Statistics getModel()
Deprecated. 
Returns the model for this SequenceGraph

Specified by:
getModel in class SimGraph

step

public void step()
Deprecated. 
Records and plots the new sequence data on the graph


record

public void record()
Deprecated. 
Records the new sequence data but do not plot.


writeToFile

public void writeToFile()
Deprecated. 
Write the sequence data to a file. This can be done incrementally without overwriting previous data, or more efficiently when the simulation ends.


RePast
v. 2.0

Bug reports and feature requests to RePast