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

---

org.mrd.models.example
Class ExampleModel  

java.lang.Object
  SimModelImpl
      org.mrd.models.example.ExampleModel

---

public class ExampleModel

extends SimModelImpl

This is a simple example layout for a RePast Model, All the basic requirements are available plus 3 added features. 1.) The Stepable interface provides one method "step" to place code which will happen every interation of the model. 2.) The MaxIterations property provides a means to have the model stop after a specific set of iterations have past. 3.) the "log" property is added to allow easly dumping of messages to the console window.

Version:

0.1

---

Nested Class Summary
class	ExampleModel.Bar
class	ExampleModel.Foo

 

Field Summary
private  ExampleModel.Bar[]	bar           Holds value of property bar.
private  boolean[]	booleanArray           Holds value of property booleanArray.
private  java.lang.Boolean[]	booleanObjectArray           Holds value of property booleanObjectArray.
private  byte[]	byteArray           Holds value of property byteArray.
private  java.lang.Byte[]	byteObjectArray           Holds value of property byteObjectArray.
private  char[]	charArray           Holds value of property charArray.
private  java.lang.Character[]	charObjectArray           Holds value of property charObjectArray.
private  double[]	doubleArray           Holds value of property doubleArray.
private  java.lang.Double[]	doubleObjectArray           Holds value of property doubleObjectArray.
private  float[]	floatArray           Holds value of property floatArray.
private  java.lang.Float[]	floatObjectArray           Holds value of property floatObjectArray.
private  ExampleModel.Foo[]	foo           Holds value of property foo.
private  int[]	intArray           Holds value of property intArray.
private  java.lang.Integer[]	intObjectArray           Holds value of property intObjectArray.
protected  org.apache.commons.logging.Log	log
private  long[]	longArray           Holds value of property longArray.
private  java.lang.Long[]	longObjectArray           Holds value of property longObjectArray.
protected  double	maxIterations           Holds value of property maxIterations.
protected  Schedule	schedule           Every model must have a schedule
private  short[]	shortArray           Holds value of property shortArray.
private  java.lang.Short[]	shortObjectArray           Holds value of property shortObjectArray.
private  java.lang.String[]	stringArray           Holds value of property stringArray.

 

Constructor Summary

ExampleModel()

 

Method Summary
void	begin()
ExampleModel.Bar[]	getBar()           Getter for property bar.
boolean[]	getBooleanArray()           Getter for property booleanArray.
java.lang.Boolean[]	getBooleanObjectArray()           Getter for property booleanObjectArray.
byte[]	getByteArray()           Getter for property byteArray.
java.lang.Byte[]	getByteObjectArray()           Getter for property byteObjectArray.
char[]	getCharArray()           Getter for property charArray.
java.lang.Character[]	getCharObjectArray()           Getter for property charObjectArray.
double[]	getDoubleArray()           Getter for property doubleArray.
java.lang.Double[]	getDoubleObjectArray()           Getter for property doubleObjectArray.
float[]	getFloatArray()           Getter for property floatArray.
java.lang.Float[]	getFloatObjectArray()           Getter for property floatObjectArray.
ExampleModel.Foo[]	getFoo()           Getter for property foo.
java.lang.String[]	getInitParam()
int[]	getIntArray()           Getter for property intArray.
java.lang.Integer[]	getIntObjectArray()           Getter for property intObjectArray.
long[]	getLongArray()           Getter for property longArray.
java.lang.Long[]	getLongObjectArray()           Getter for property longObjectArray.
double	getMaxIterations()           Getter for property maxIterations.
java.lang.String	getName()
Schedule	getSchedule()           Getter for property schedule.
short[]	getShortArray()           Getter for property shortArray.
java.lang.Short[]	getShortObjectArray()           Getter for property shortObjectArray.
java.lang.String[]	getStringArray()           Getter for property stringArray.
void	setBar(ExampleModel.Bar[] bar)           Setter for property bar.
void	setBooleanArray(boolean[] booleanArray)           Setter for property booleanArray.
void	setBooleanObjectArray(java.lang.Boolean[] booleanObjectArray)           Setter for property booleanObjectArray.
void	setByteArray(byte[] byteArray)           Setter for property byteArray.
void	setByteObjectArray(java.lang.Byte[] byteObjectArray)           Setter for property byteObjectArray.
void	setCharArray(char[] charArray)           Setter for property charArray.
void	setCharObjectArray(java.lang.Character[] charObjectArray)           Setter for property charObjectArray.
void	setDoubleArray(double[] doubleArray)           Setter for property doubleArray.
void	setDoubleObjectArray(java.lang.Double[] doubleObjectArray)           Setter for property doubleObjectArray.
void	setFloatArray(float[] floatArray)           Setter for property floatArray.
void	setFloatObjectArray(java.lang.Float[] floatObjectArray)           Setter for property floatObjectArray.
void	setFoo(ExampleModel.Foo[] foo)           Setter for property foo.
void	setIntArray(int[] intArray)           Setter for property intArray.
void	setIntObjectArray(java.lang.Integer[] intObjectArray)           Setter for property intObjectArray.
void	setLongArray(long[] longArray)           Setter for property longArray.
void	setLongObjectArray(java.lang.Long[] longObjectArray)           Setter for property longObjectArray.
void	setSchedule(Schedule schedule)           Setter for property schedule.
void	setShortArray(short[] shortArray)           Setter for property shortArray.
void	setShortObjectArray(java.lang.Short[] shortObjectArray)           Setter for property shortObjectArray.
void	setStringArray(java.lang.String[] stringArray)           Setter for property stringArray.
void	setup()
void	step()

 

Methods inherited from class java.lang.Object

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

 

Field Detail

log

protected org.apache.commons.logging.Log log

---

schedule

protected Schedule schedule

Every model must have a schedule

---

maxIterations

protected double maxIterations

Holds value of property maxIterations.

---

charArray

private char[] charArray

Holds value of property charArray.

---

byteArray

private byte[] byteArray

Holds value of property byteArray.

---

byteObjectArray

private java.lang.Byte[] byteObjectArray

Holds value of property byteObjectArray.

---

charObjectArray

private java.lang.Character[] charObjectArray

Holds value of property charObjectArray.

---

intArray

private int[] intArray

Holds value of property intArray.

---

intObjectArray

private java.lang.Integer[] intObjectArray

Holds value of property intObjectArray.

---

doubleArray

private double[] doubleArray

Holds value of property doubleArray.

---

doubleObjectArray

private java.lang.Double[] doubleObjectArray

Holds value of property doubleObjectArray.

---

longArray

private long[] longArray

Holds value of property longArray.

---

longObjectArray

private java.lang.Long[] longObjectArray

Holds value of property longObjectArray.

---

shortArray

private short[] shortArray

Holds value of property shortArray.

---

shortObjectArray

private java.lang.Short[] shortObjectArray

Holds value of property shortObjectArray.

---

floatArray

private float[] floatArray

Holds value of property floatArray.

---

floatObjectArray

private java.lang.Float[] floatObjectArray

Holds value of property floatObjectArray.

---

stringArray

private java.lang.String[] stringArray

Holds value of property stringArray.

---

booleanArray

private boolean[] booleanArray

Holds value of property booleanArray.

---

booleanObjectArray

private java.lang.Boolean[] booleanObjectArray

Holds value of property booleanObjectArray.

---

foo

private ExampleModel.Foo[] foo

Holds value of property foo.

---

bar

private ExampleModel.Bar[] bar

Holds value of property bar.

Constructor Detail

ExampleModel

public ExampleModel()

Method Detail

getInitParam

public java.lang.String[] getInitParam()

---

getName

public java.lang.String getName()

---

setup

public void setup()

---

begin

public void begin()

---

step

public void step()

---

getMaxIterations

public double getMaxIterations()

Getter for property maxIterations.

---

getSchedule

public Schedule getSchedule()

Getter for property schedule.

---

setSchedule

public void setSchedule(Schedule schedule)

Setter for property schedule.

---

getCharArray

public char[] getCharArray()

Getter for property charArray.

---

setCharArray

public void setCharArray(char[] charArray)

Setter for property charArray.

---

getByteArray

public byte[] getByteArray()

Getter for property byteArray.

---

setByteArray

public void setByteArray(byte[] byteArray)

Setter for property byteArray.

---

getByteObjectArray

public java.lang.Byte[] getByteObjectArray()

Getter for property byteObjectArray.

---

setByteObjectArray

public void setByteObjectArray(java.lang.Byte[] byteObjectArray)

Setter for property byteObjectArray.

---

getCharObjectArray

public java.lang.Character[] getCharObjectArray()

Getter for property charObjectArray.

---

setCharObjectArray

public void setCharObjectArray(java.lang.Character[] charObjectArray)

Setter for property charObjectArray.

---

getIntArray

public int[] getIntArray()

Getter for property intArray.

---

setIntArray

public void setIntArray(int[] intArray)

Setter for property intArray.

---

getIntObjectArray

public java.lang.Integer[] getIntObjectArray()

Getter for property intObjectArray.

---

setIntObjectArray

public void setIntObjectArray(java.lang.Integer[] intObjectArray)

Setter for property intObjectArray.

---

getDoubleArray

public double[] getDoubleArray()

Getter for property doubleArray.

---

setDoubleArray

public void setDoubleArray(double[] doubleArray)

Setter for property doubleArray.

---

getDoubleObjectArray

public java.lang.Double[] getDoubleObjectArray()

Getter for property doubleObjectArray.

---

setDoubleObjectArray

public void setDoubleObjectArray(java.lang.Double[] doubleObjectArray)

Setter for property doubleObjectArray.

---

getLongArray

public long[] getLongArray()

Getter for property longArray.

---

setLongArray

public void setLongArray(long[] longArray)

Setter for property longArray.

---

getLongObjectArray

public java.lang.Long[] getLongObjectArray()

Getter for property longObjectArray.

---

setLongObjectArray

public void setLongObjectArray(java.lang.Long[] longObjectArray)

Setter for property longObjectArray.

---

getShortArray

public short[] getShortArray()

Getter for property shortArray.

---

setShortArray

public void setShortArray(short[] shortArray)

Setter for property shortArray.

---

getShortObjectArray

public java.lang.Short[] getShortObjectArray()

Getter for property shortObjectArray.

---

setShortObjectArray

public void setShortObjectArray(java.lang.Short[] shortObjectArray)

Setter for property shortObjectArray.

---

getFloatArray

public float[] getFloatArray()

Getter for property floatArray.

---

setFloatArray

public void setFloatArray(float[] floatArray)

Setter for property floatArray.

---

getFloatObjectArray

public java.lang.Float[] getFloatObjectArray()

Getter for property floatObjectArray.

---

setFloatObjectArray

public void setFloatObjectArray(java.lang.Float[] floatObjectArray)

Setter for property floatObjectArray.

---

getStringArray

public java.lang.String[] getStringArray()

Getter for property stringArray.

---

setStringArray

public void setStringArray(java.lang.String[] stringArray)

Setter for property stringArray.

---

getBooleanArray

public boolean[] getBooleanArray()

Getter for property booleanArray.

---

setBooleanArray

public void setBooleanArray(boolean[] booleanArray)

Setter for property booleanArray.

---

getBooleanObjectArray

public java.lang.Boolean[] getBooleanObjectArray()

Getter for property booleanObjectArray.

---

setBooleanObjectArray

public void setBooleanObjectArray(java.lang.Boolean[] booleanObjectArray)

Setter for property booleanObjectArray.

---

getFoo

public ExampleModel.Foo[] getFoo()

Getter for property foo.

---

setFoo

public void setFoo(ExampleModel.Foo[] foo)

Setter for property foo.

---

getBar

public ExampleModel.Bar[] getBar()

Getter for property bar.

---

setBar

public void setBar(ExampleModel.Bar[] bar)

Setter for property bar.

---

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

---