A C D E F G I M O P R S T U

A

add(Object) - Method in class feynman.framework.system.PhysicalSystem

Override this method to add an object of your defined type to the system.

C

calculate(Simulation, PhysicalSystem) - Method in interface feynman.framework.system.PhysicalAlgorithm

Implement this method to define the algorithm to be used in the Simulation.

CartesianObject - class feynman.framework.system.CartesianObject.

Sub-class to define a PhysicalObject for the CartesianSystem.

CartesianObject() - Constructor for class feynman.framework.system.CartesianObject

CartesianObjectFactory - class feynman.framework.system.CartesianObjectFactory.

Factory class that implements PhysicalObjectFactory.

close() - Method in interface feynman.framework.datastore.DataStore

Method to close the connection to the data store.

close() - Method in class feynman.framework.datastore.FileDataStore

Method to close the PhysicalMeasurement data file for writing.

close() - Method in class feynman.framework.datastore.DbmsDataStore

configure(PhysicalSystem) - Method in interface feynman.framework.system.PhysicalConfiguration

Implement this method to define how to configure the system.

ConnectionException - exception feynman.framework.datastore.ConnectionException.

Generic Exception to catch dbms connection or file IO exceptions.

ConnectionException() - Constructor for class feynman.framework.datastore.ConnectionException

ConnectionException(String) - Constructor for class feynman.framework.datastore.ConnectionException

contains(Object) - Method in class feynman.framework.system.PhysicalSystem

Use this method to query if a Object is part of the system.

Controller - class feynman.framework.controller.Controller.

This class sets up the simulation from the properties file and then runs it based on the configuration classes.

Controller() - Constructor for class feynman.framework.controller.Controller

ControllerException - exception feynman.framework.controller.ControllerException.

This excpetion is generally invoked when the user has either configured the properties file incorrectly or invoked the feynman.jar file with an incorrect command line.

create(Simulation) - Static method in class feynman.framework.system.PhysicalSystemFactory

Note: This method is used by the feynman.framework.Controller.

create(Simulation) - Method in interface feynman.framework.system.PhysicalObjectFactory

create(Simulation) - Method in class feynman.framework.system.CartesianObjectFactory

Factory method for generating PhysicalObjects in the Cartesian Coordinate System.

create(String) - Method in class feynman.framework.datastore.DataStoreFactory

Method to create the DataStore object that has been specified in the Simulation.properties file in the following manner:

D

DataStore - interface feynman.framework.datastore.DataStore.

Interface for defining data store capabilities within the framework for the PhysicalMeasurement bean.

DataStoreFactory - class feynman.framework.datastore.DataStoreFactory.

Factory class for the creation of particular DataStore implementation.

DbmsDataStore - class feynman.framework.datastore.DbmsDataStore.

doFinalReport() - Method in class feynman.framework.simulation.Simulation

Alternative query to produce a final report or not.

E

equals(PhysicalObject) - Method in class feynman.framework.system.PhysicalObject

Use this method to test if the PhysicalObject you are working with is equal to another that you are using.

F

feynman.framework.controller - package feynman.framework.controller

feynman.framework.datastore - package feynman.framework.datastore

feynman.framework.simulation - package feynman.framework.simulation

feynman.framework.system - package feynman.framework.system

FileDataStore - class feynman.framework.datastore.FileDataStore.

File based implementation of the DataStore interface.

FinalReport - interface feynman.framework.system.FinalReport.

This interface defines a simple way of reporting final statistics or calculations that occured in the simulation.

G

getDataStore() - Method in class feynman.framework.simulation.Simulation

Use this method to get the DateStore.

getDataStoreFile() - Method in class feynman.framework.simulation.Simulation

Use this method to get the DateStoreFile.

getDoFinalReport() - Method in class feynman.framework.simulation.Simulation

Use this method to query whether to produce a final report or not.

getFinalReportClass() - Method in class feynman.framework.simulation.Simulation

Use this method to get the class for the final report.

getId() - Method in class feynman.framework.system.PhysicalObject

Use this method to get the unique identifier.

getInstance() - Static method in class feynman.framework.datastore.DataStoreFactory

Method to retrieve an instance of the class.

getInstance() - Static method in class feynman.framework.simulation.Simulation

Use this method to get an instance of the Simulation class.

getInstance() - Static method in class feynman.framework.system.PhysicalSystemFactory

Method used to retrieve an instance of the factory class.

getInstance() - Static method in class feynman.framework.system.CartesianObjectFactory

Use this method to retrieve an instance of the Factory.

getInterval() - Method in class feynman.framework.simulation.Simulation

Use this method to get the interval which is usually a timestep.

getIterations() - Method in class feynman.framework.simulation.Simulation

Use this method to get the iterations the simulation will perform.

getNumberMeasurements() - Method in class feynman.framework.simulation.Simulation

Use this method to get the number of measurements the simulation is to perform.

getNumberPhysicalObjects() - Method in class feynman.framework.simulation.Simulation

Use this method to get the number of PhyscialObjects to create.

getPerformMeasurement() - Method in class feynman.framework.simulation.Simulation

Use this method to get the PerformMeasurement value.

getPhysicalAlgorithmClass() - Method in class feynman.framework.simulation.Simulation

Use this method to get the PhysicalAlgorithmClass.

getPhysicalConfigurationClass() - Method in class feynman.framework.simulation.Simulation

Use this method to get the PhysicalConfigurationClass.

getPhysicalMeasurementClass() - Method in class feynman.framework.simulation.Simulation

Use this method to get the PhysicalMeasurementClass.

getPhysicalObjectClass() - Method in class feynman.framework.simulation.Simulation

Use this method to get the PhysicalObjectClass.

getPhysicalObjectFactoryClass() - Method in class feynman.framework.simulation.Simulation

Use this method to get the PhysicalObjectFactoryClass.

getPhysicalSystemClass() - Method in class feynman.framework.simulation.Simulation

Use this method to get the PhysicalSystemClass.

getRunning() - Method in class feynman.framework.simulation.Simulation

Use this method to get the boolean value for if the simulation is running.

getStartTime() - Method in class feynman.framework.simulation.Simulation

Use this method to get the start time of the simulation.

getTime() - Method in class feynman.framework.simulation.Simulation

Use this method to get the current value of the time in the simulation.

getX() - Method in class feynman.framework.system.CartesianObject

Use this method to retrieve the X coordinate value of the object.

getY() - Method in class feynman.framework.system.CartesianObject

Use this method to retrieve the Y coordinate value of the object.

getZ() - Method in class feynman.framework.system.CartesianObject

Use this method to retrieve the Z coordinate value of the object.

I

InvalidDataStoreException - exception feynman.framework.datastore.InvalidDataStoreException.

Exception for when the user specifies and invalid data store type.

InvalidDataStoreException() - Constructor for class feynman.framework.datastore.InvalidDataStoreException

InvalidDataStoreException(String) - Constructor for class feynman.framework.datastore.InvalidDataStoreException

isEmpty() - Method in class feynman.framework.system.PhysicalSystem

Use this method to query the system to see if there are any objects in it.

isRunning() - Method in class feynman.framework.simulation.Simulation

Method to test whether the simulation should still be running or not.

iterator() - Method in class feynman.framework.system.PhysicalSystem

Use this method to get and iterator over all objects in the system.

M

main(String[]) - Static method in class feynman.framework.controller.Controller

marshall(Simulation, String) - Static method in class feynman.framework.simulation.Marshaller

Method to save a serialized version of the simulation object.

Marshaller - class feynman.framework.simulation.Marshaller.

Utility class to load the properties file that the user has defined.

MarshallingException - exception feynman.framework.simulation.MarshallingException.

General exception that can occurr while marshalling and unmarshalling the simulation object.

MarshallingException() - Constructor for class feynman.framework.simulation.MarshallingException

MarshallingException(String) - Constructor for class feynman.framework.simulation.MarshallingException

O

open(String) - Method in interface feynman.framework.datastore.DataStore

Method to open a connection to the data store.

open(String) - Method in class feynman.framework.datastore.FileDataStore

Method to open a file for writing PhysicalMeasurement data to.

open(String) - Method in class feynman.framework.datastore.DbmsDataStore

P

PhysicalAlgorithm - interface feynman.framework.system.PhysicalAlgorithm.

This interface defines the mechanism for implementing a numerical algorithm for the simulation.

PhysicalConfiguration - interface feynman.framework.system.PhysicalConfiguration.

Interface for defining the configuration of a physical system before any operations or measurements are performed on the physical system.

PhysicalMeasurement - interface feynman.framework.system.PhysicalMeasurement.

This interface defines the required method for the Measurement bean.

PhysicalObject - class feynman.framework.system.PhysicalObject.

The class is really just a symbolic name that means more to physicists than the default Java Object class name means.

PhysicalObject() - Constructor for class feynman.framework.system.PhysicalObject

PhysicalObjectFactory - interface feynman.framework.system.PhysicalObjectFactory.

Factory to define the creation of Physical Objects to be used in the system of study.

PhysicalObjectFactoryException - exception feynman.framework.system.PhysicalObjectFactoryException.

This excpetion is generally invoked when the user has either configured the properties file incorrectly by specifying not specifying a sub-class of the PhysicalObjectthat cannot be created by the Factory.

PhysicalObjectFactoryException() - Constructor for class feynman.framework.system.PhysicalObjectFactoryException

PhysicalObjectFactoryException(String) - Constructor for class feynman.framework.system.PhysicalObjectFactoryException

PhysicalSystem - class feynman.framework.system.PhysicalSystem.

A ObjectSystem is a collection of Objects that are being studied.

PhysicalSystemFactory - class feynman.framework.system.PhysicalSystemFactory.

Factory to create differenct types of PhysicalSystems.

PhysicalSystemFactoryException - exception feynman.framework.system.PhysicalSystemFactoryException.

This excpetion is generally invoked when the user has either configured the properties file incorrectly by specifying a sub-class of the PhysicalObject that cannot be created by the Factory.

PhysicalSystemFactoryException() - Constructor for class feynman.framework.system.PhysicalSystemFactoryException

PhysicalSystemFactoryException(String) - Constructor for class feynman.framework.system.PhysicalSystemFactoryException

R

remove(Object) - Method in class feynman.framework.system.PhysicalSystem

Use this method to remove a Object from the system.

report(Simulation, PhysicalSystem) - Method in interface feynman.framework.system.FinalReport

Use this method to write any final data or calculation to stdout for the user of the simulation.

S

save(PhysicalMeasurement) - Method in interface feynman.framework.datastore.DataStore

Method to save the PhysicalMeasurement bean to the data store.

save(PhysicalMeasurement) - Method in class feynman.framework.datastore.FileDataStore

Method to write the PhysicalMeasurement data to the file.

save(PhysicalMeasurement) - Method in class feynman.framework.datastore.DbmsDataStore

setDataStore(String) - Method in class feynman.framework.simulation.Simulation

Use this method to specify the DataStore.

setDataStoreFile(String) - Method in class feynman.framework.simulation.Simulation

Use this method to specify the DataStoreFile.

setDoFinalReport(boolean) - Method in class feynman.framework.simulation.Simulation

Use this method to indicate a final report should be produced.

setFinalReportClass(String) - Method in class feynman.framework.simulation.Simulation

Use this method to define a class that performs a summary report of the simulation.

setId(int) - Method in class feynman.framework.system.PhysicalObject

Use this method to assign a unique identifier.

setInterval(double) - Method in class feynman.framework.simulation.Simulation

Use this method to specify the timestep interval to be used to calculate the running time.

setIterations(int) - Method in class feynman.framework.simulation.Simulation

Use this method to specify the number of iterations to perform.

setNumberMeasurements(int) - Method in class feynman.framework.simulation.Simulation

Use this method to specify the number of Measurements to make if PerformMeasurement is set to true.

setNumberPhysicalObjects(int) - Method in class feynman.framework.simulation.Simulation

Use this method to specify the number of physical objects to be created and used in the simulation.

setPerformMeasurement(boolean) - Method in class feynman.framework.simulation.Simulation

Use this method to specify to PerformMeasurement on/off.

setPhysicalAlgorithmClass(String) - Method in class feynman.framework.simulation.Simulation

Use this method to specify the PhysicalAlgorithmClass.

setPhysicalConfigurationClass(String) - Method in class feynman.framework.simulation.Simulation

Use this method to specify the PhysicalConfigurationClass.

setPhysicalMeasurementClass(String) - Method in class feynman.framework.simulation.Simulation

Use this method to specify the PhysicalMeasurementClass.

setPhysicalObjectClass(String) - Method in class feynman.framework.simulation.Simulation

Use this method to specify the PhysicalObjectClass.

setPhysicalObjectFactoryClass(String) - Method in class feynman.framework.simulation.Simulation

Use this method to specify the PhysicalObjectFactoryClass.

setPhysicalSystemClass(String) - Method in class feynman.framework.simulation.Simulation

Use this method to specify the PhysicalSystemClass.

setRunning(boolean) - Method in class feynman.framework.simulation.Simulation

Use this method to specify that the simulation is running and should continue to run.

setStartTime(double) - Method in class feynman.framework.simulation.Simulation

Use this method to specify the time at the start of the simulation.

setTime(double) - Method in class feynman.framework.simulation.Simulation

Use this method to specify the time during any point during the simulation.

setX(double) - Method in class feynman.framework.system.CartesianObject

Method to define the X coordinate of the object.

setY(double) - Method in class feynman.framework.system.CartesianObject

Method to define the Y coordinate of the object.

setZ(double) - Method in class feynman.framework.system.CartesianObject

Method to define the Z coordinate of the object.

Simulation - class feynman.framework.simulation.Simulation.

Bean that represents a simulation in the framework.

size() - Method in class feynman.framework.system.PhysicalSystem

Use this method to determine the number of Objects in the system.

T

take(Simulation, PhysicalSystem) - Method in interface feynman.framework.system.PhysicalMeasurement

Define this method for taking a measurement of the PhysicalSystem during the simulation.

toSql() - Method in interface feynman.framework.system.PhysicalMeasurement

Define this method in order to use the DbmsDataStore.

toString() - Method in class feynman.framework.simulation.Simulation

Get a string representation of the object.

toString() - Method in interface feynman.framework.system.PhysicalMeasurement

Define this method in order to use the FileDataStore.

U

unmarshall(String) - Static method in class feynman.framework.simulation.Marshaller

Method to create a simulation object with attribute values specified by the properties file description of the object.

updateTime() - Method in class feynman.framework.simulation.Simulation

Use this method to update the time during any point during the simulation.

A C D E F G I M O P R S T U