Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mrd >> [ model overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.mrd.model
Class ModelBase  

java.lang.Object
  uchicago.src.sim.engine.SimModelImpl
      org.mrd.model.ModelBase

---

public abstract class ModelBase

extends uchicago.src.sim.engine.SimModelImpl

Version:

---

Field Summary
private  org.mrd.analysis.BatchRecorder	batch_recorder           Holds A DataRecorder allows data generated by a simulation to be written to a file.
private  java.lang.String	batchRecordFile           Holds value of property batchRecordFile.
protected  boolean	display           Holds value of property display.
protected  java.util.Vector	graphs
protected  java.lang.String	habitatSpaceFile           Holds value of property habitatSpaceFile.
protected  Landscape	landscape           The surface on which the agents and their environment are displayed
private  org.apache.commons.logging.Log	log
protected  int	modelMaxIterations           Holds value of property modelMaxIterations.
private  DataRecorder	recorder           Holds A DataRecorder allows data generated by a simulation to be written to a file.
protected  Schedule	schedule           Every model must have a schedule

 

Constructor Summary

ModelBase()           Creates new ModelBase

 

Method Summary
protected  void	addGraph(uchicago.src.sim.analysis.plot.OpenGraph graphic)
void	begin()
abstract  Agent	buildAgent(java.lang.Class agentClass)
private  void	buildDataCollectors()
private  void	buildSchedule()
protected  double[]	chop(java.lang.String str)           Utility method for parsing a string into a double[]
java.lang.String	getBatchRecordFile()           Getter for property batchRecordFile.
java.lang.String	getHabitatSpaceFile()           Getter for property habitatSpace.
abstract  java.lang.String[]	getInitParam()
int	getModelMaxIterations()           Getter for property modelMaxIterations.
abstract  java.lang.String	getName()
Schedule	getSchedule()
protected abstract  void	initialize()
boolean	isDisplay()           Getter for property display.
protected  java.lang.String	mush(double[] table)           Utility method for displaying a double[] as a string
void	setBatchRecordFile(java.lang.String batchRecordFile)           Setter for property batchRecordFile.
void	setDisplay(boolean display)           Setter for property display.
void	setHabitatSpaceFile(java.lang.String habitatSpaceFile)           Setter for property habitatSpace.
void	setModelMaxIterations(int modelMaxIterations)           Setter for property modelMaxIterations.
void	setSchedule(Schedule schedule)           Setter for property schedule.
void	setup()
protected abstract  void	step()

 

Methods inherited from class java.lang.Object

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

 

Field Detail

landscape

protected Landscape landscape

The surface on which the agents and their environment are displayed

---

recorder

private DataRecorder recorder

Holds A DataRecorder allows data generated by a simulation to be written to a file.

---

batch_recorder

private org.mrd.analysis.BatchRecorder batch_recorder

Holds A DataRecorder allows data generated by a simulation to be written to a file.

---

habitatSpaceFile

protected java.lang.String habitatSpaceFile

Holds value of property habitatSpaceFile.

---

schedule

protected Schedule schedule

Every model must have a schedule

---

log

private org.apache.commons.logging.Log log

---

modelMaxIterations

protected int modelMaxIterations

Holds value of property modelMaxIterations.

---

display

protected boolean display

Holds value of property display.

---

graphs

protected java.util.Vector graphs

---

batchRecordFile

private java.lang.String batchRecordFile

Holds value of property batchRecordFile.

Constructor Detail

ModelBase

public ModelBase()

Creates new ModelBase

Method Detail

initialize

protected abstract void initialize()

---

step

protected abstract void step()

---

buildAgent

public abstract Agent buildAgent(java.lang.Class agentClass)

---

buildDataCollectors

private void buildDataCollectors()

---

buildSchedule

private void buildSchedule()

---

setup

public void setup()

---

addGraph

protected void addGraph(uchicago.src.sim.analysis.plot.OpenGraph graphic)

---

begin

public void begin()

---

getSchedule

public Schedule getSchedule()

---

getInitParam

public abstract java.lang.String[] getInitParam()

---

getName

public abstract java.lang.String getName()

---

getHabitatSpaceFile

public java.lang.String getHabitatSpaceFile()

Getter for property habitatSpace.

---

setHabitatSpaceFile

public void setHabitatSpaceFile(java.lang.String habitatSpaceFile)

Setter for property habitatSpace.

---

getModelMaxIterations

public int getModelMaxIterations()

Getter for property modelMaxIterations.

---

setModelMaxIterations

public void setModelMaxIterations(int modelMaxIterations)

Setter for property modelMaxIterations.

---

isDisplay

public boolean isDisplay()

Getter for property display.

---

setDisplay

public void setDisplay(boolean display)

Setter for property display.

---

chop

protected double[] chop(java.lang.String str)

Utility method for parsing a string into a double[]

---

mush

protected java.lang.String mush(double[] table)

Utility method for displaying a double[] as a string

---

setSchedule

public void setSchedule(Schedule schedule)

Setter for property schedule.

---

getBatchRecordFile

public java.lang.String getBatchRecordFile()

Getter for property batchRecordFile.

---

setBatchRecordFile

public void setBatchRecordFile(java.lang.String batchRecordFile)

Setter for property batchRecordFile.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mrd >> [ model overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---