biouml.plugins.simulation
Class SimulationEngine

|
+--biouml.plugins.simulation.SimulationEngine

Direct Known Subclasses:

MatlabSimulationEngine, JavaSimulationEngine

public abstract class SimulationEngine

extends Option

General class for simulation engine. It defines common contract (properties and methods) for any simulation engine.

public final static double DEFAULT_ABSOLUTE_TOLERANCE

public final static double DEFAULT_RELATIVE_TOLERANCE

public boolean needToShowPlot

public final static String srcDir

public void clearContext()
                   throws java.lang.Exception

public boolean containsDelays()

Returns true if the differential equations contain delays when derivatives computing.

public void error(String message)

public void error(String messageBundleKey, String[] params)

public void error(String messageBundleKey, String[] params, Throwable t)

public void fillSimulationResult(SimulationResult result)
                           throws java.lang.Exception

public abstract File[] generateModel()
                               throws java.lang.Exception

public abstract String generateVariableCodeName(int n)

public double getAbsTolerance()

public double getCompletionTime()

public Diagram getDiagram()

public EModel getExecutableModel()

public abstract Formatter getFormatter()

Returns formatter corresponding for given engine.

public double getInitialTime()

public boolean getNeedToShowPlot()

public String getOutputDir()

public String getQualifiedName(String name, DiagramElement de)

Resolves brief varibale name to fully qualified variable name. Generates error if variable can not be resolved.

See Also:

biouml.model.dynamics.EModel.getQualifiedName(java.lang.String,biouml.model.DiagramElement)

public double getRelTolerance()

public ResourceBundle getResourceBundle()

public String getResourceString(String key)

Returns string from the resource bundle for the specified key. If the sting is absent the key string is returned instead and the message is printed in log4j.Category.

public String getSolverName()

public double getTimeIncrement()

public String normalize(String name)

Normalize name to be valid simulation script name.

public void setAbsTolerance(double absTolerance)

public void setCompletionTime(double completionTime)

public void setDiagram(Diagram diagram)

public void setInitialTime(double initialTime)

public void setNeedToShowPlot(boolean value)

public void setOutputDir(String outputDir)

public void setRelTolerance(double relTolerance)

public void setSolverName(String solverName)

public void setTimeIncrement(double timeIncrement)

public abstract String simulate(File[] files)
                          throws java.lang.Exception

public void warn(String messageBundleKey, String[] params)

public void writeAssignment(String variable, String expression, Role role)

public abstract void writeComment(String comment)

public void writeFile(String source, String outDir, String outFile, boolean rewrite)
                throws java.lang.Exception

Utility method to write needed source files from the specified source to the specified directory.

Association Links

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String

to Class org.apache.log4j.Category

to Class java.util.Map

Stores list of equations for used diagram variable.

to Class java.util.List

List of all equations.

to Class java.util.List

List of all variables however used in model.

to Class java.util.Map

maps "variable name" -> "scalar equation, calculating this variable"

to Class biouml.plugins.simulation.MathWriter

to Class biouml.model.Diagram

to Class biouml.model.dynamics.EModel

to Class java.lang.String

Output directory where the code will be generated.

to Class java.lang.String

to Class java.util.ResourceBundle

Resource bundle containing necessary String data. This resource bundle contains join of childResources with parentResources.

to Class java.util.ResourceBundle

Resource bundle containing necessary String data.

to Class java.util.ResourceBundle

Common description is located in biouml.plugins.simulation.resources.MessagesBundle. This bundle is used as parent bundle for resources.