|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--feynman.framework.simulation.Simulation
Bean that represents a simulation in the framework. Many of the attributes of the simulation bean are defined in the Simulation.properties file by the user of the framework.
The Controller class uses the simulation bean to control the creation of the correct classes for the simulation.
Method Summary | |
boolean |
doFinalReport()
Alternative query to produce a final report or not. |
java.lang.String |
getDataStore()
Use this method to get the DateStore. |
java.lang.String |
getDataStoreFile()
Use this method to get the DateStoreFile. |
boolean |
getDoFinalReport()
Use this method to query whether to produce a final report or not. |
java.lang.String |
getFinalReportClass()
Use this method to get the class for the final report. |
static Simulation |
getInstance()
Use this method to get an instance of the Simulation class. |
double |
getInterval()
Use this method to get the interval which is usually a timestep. |
int |
getIterations()
Use this method to get the iterations the simulation will perform. |
int |
getNumberMeasurements()
Use this method to get the number of measurements the simulation is to perform. |
int |
getNumberPhysicalObjects()
Use this method to get the number of PhyscialObjects to create. |
boolean |
getPerformMeasurement()
Use this method to get the PerformMeasurement value. |
java.lang.String |
getPhysicalAlgorithmClass()
Use this method to get the PhysicalAlgorithmClass. |
java.lang.String |
getPhysicalConfigurationClass()
Use this method to get the PhysicalConfigurationClass. |
java.lang.String |
getPhysicalMeasurementClass()
Use this method to get the PhysicalMeasurementClass. |
java.lang.String |
getPhysicalObjectClass()
Use this method to get the PhysicalObjectClass. |
java.lang.String |
getPhysicalObjectFactoryClass()
Use this method to get the PhysicalObjectFactoryClass. |
java.lang.String |
getPhysicalSystemClass()
Use this method to get the PhysicalSystemClass. |
boolean |
getRunning()
Use this method to get the boolean value for if the simulation is running. |
double |
getStartTime()
Use this method to get the start time of the simulation. |
double |
getTime()
Use this method to get the current value of the time in the simulation. |
boolean |
isRunning()
Method to test whether the simulation should still be running or not. |
void |
setDataStore(java.lang.String dataStore)
Use this method to specify the DataStore. |
void |
setDataStoreFile(java.lang.String dataStoreFile)
Use this method to specify the DataStoreFile. |
void |
setDoFinalReport(boolean doFinalReport)
Use this method to indicate a final report should be produced. |
void |
setFinalReportClass(java.lang.String finalReportClass)
Use this method to define a class that performs a summary report of the simulation. |
void |
setInterval(double interval)
Use this method to specify the timestep interval to be used to calculate the running time. |
void |
setIterations(int iterations)
Use this method to specify the number of iterations to perform. |
void |
setNumberMeasurements(int numberMeasurements)
Use this method to specify the number of Measurements to make if PerformMeasurement is set to true. |
void |
setNumberPhysicalObjects(int numberPhysicalObjects)
Use this method to specify the number of physical objects to be created and used in the simulation. |
void |
setPerformMeasurement(boolean performMeasurement)
Use this method to specify to PerformMeasurement on/off. |
void |
setPhysicalAlgorithmClass(java.lang.String physicalAlgorithmClass)
Use this method to specify the PhysicalAlgorithmClass. |
void |
setPhysicalConfigurationClass(java.lang.String physicalConfigurationClass)
Use this method to specify the PhysicalConfigurationClass. |
void |
setPhysicalMeasurementClass(java.lang.String physicalMeasurementClass)
Use this method to specify the PhysicalMeasurementClass. |
void |
setPhysicalObjectClass(java.lang.String physicalObjectClass)
Use this method to specify the PhysicalObjectClass. |
void |
setPhysicalObjectFactoryClass(java.lang.String physicalObjectFactoryClass)
Use this method to specify the PhysicalObjectFactoryClass. |
void |
setPhysicalSystemClass(java.lang.String physicalSystemClass)
Use this method to specify the PhysicalSystemClass. |
void |
setRunning(boolean running)
Use this method to specify that the simulation is running and should continue to run. |
void |
setStartTime(double startTime)
Use this method to specify the time at the start of the simulation. |
void |
setTime(double time)
Use this method to specify the time during any point during the simulation. |
java.lang.String |
toString()
Get a string representation of the object. |
void |
updateTime()
Use this method to update the time during any point during the simulation. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public static Simulation getInstance()
public void setPhysicalSystemClass(java.lang.String physicalSystemClass)
physicalSystemClass
- The name of the PhysicalSystem classpublic java.lang.String getPhysicalSystemClass()
public void setPhysicalObjectClass(java.lang.String physicalObjectClass)
physicalSystemClass
- The name of the PhysicalObject classpublic java.lang.String getPhysicalObjectClass()
public void setPhysicalObjectFactoryClass(java.lang.String physicalObjectFactoryClass)
physicalObjectFactoryClass
- The name of the PhysicalObjectFactory classpublic java.lang.String getPhysicalObjectFactoryClass()
public void setPhysicalConfigurationClass(java.lang.String physicalConfigurationClass)
physicalConfigurationClass
- The name of the PhysicalConfiguration classpublic java.lang.String getPhysicalConfigurationClass()
public void setPhysicalAlgorithmClass(java.lang.String physicalAlgorithmClass)
physicalAlgorithmClass
- The name of the PhysicalAlgorithm classpublic java.lang.String getPhysicalAlgorithmClass()
public void setPhysicalMeasurementClass(java.lang.String physicalMeasurementClass)
physicalMeasurementClass
- The name of the PhysicalMeasurement classpublic java.lang.String getPhysicalMeasurementClass()
public void setFinalReportClass(java.lang.String finalReportClass)
physicalSystemReportClass
- The class implementing PhysicalSystemReport.public java.lang.String getFinalReportClass()
public void setDoFinalReport(boolean doFinalReport)
public boolean getDoFinalReport()
public boolean doFinalReport()
public void setDataStore(java.lang.String dataStore)
dataStore
- The name of the DataStore type to use.public java.lang.String getDataStore()
public void setDataStoreFile(java.lang.String dataStoreFile)
dataStoreFile
- The name of the DataStore output file if the
FileDataStore class is specified.public java.lang.String getDataStoreFile()
public void setPerformMeasurement(boolean performMeasurement)
performMeasurement
- true or false boolean value for on/off.public boolean getPerformMeasurement()
public void setNumberMeasurements(int numberMeasurements)
numberMeasurements
- The number of measurements to take during the simulation.public int getNumberMeasurements()
public void setNumberPhysicalObjects(int numberPhysicalObjects)
numberPhysicalObjects
- The number of physical objects to create.public int getNumberPhysicalObjects()
public void setIterations(int iterations)
iterations
- The number of iterations to perform.public int getIterations()
public void setInterval(double interval)
interval
- The interval to be used in the simulation.public double getInterval()
public void setStartTime(double startTime)
startTime
- The time at the start of the simulation.public double getStartTime()
public void setTime(double time)
time
- The current time in the simulation.public double getTime()
public void updateTime()
public void setRunning(boolean running)
This method is typically updated in the calculate method implementation of the PhysicalAlgorithm class.
running
- Boolean that indicates the simulation is running and should
continue to run. Set to true or false to indicate on or off.public boolean getRunning()
public boolean isRunning()
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |