oms3.dsl
Class Sim

java.lang.Object
  oms3.dsl.AbstractSimulation
      oms3.dsl.Sim

All Implemented Interfaces:

Buildable

public class Sim
extends AbstractSimulation

Core Simulation DSL

Author:

od

Field Summary

Fields inherited from class oms3.dsl.AbstractSimulation

log

Fields inherited from interface oms3.dsl.Buildable

LEAF

Constructor Summary

Sim()

Method Summary

Buildable	create(java.lang.Object name, java.lang.Object value) Create a node.
void	dig()
java.lang.String	digest() Get the simulation digest record.
void	doc()
void	document(java.lang.CharSequence file) Generate Simulation Documentation in Docbook 5.
void	edit() Edit parameter file content.
java.lang.Object	run()
void	setDigest(boolean digest)
void	setSanitychecks(boolean sanitychecks) perform sanity checks for the model, default is true.
void	setTiming(boolean timing) Print out timing information at the end.

Methods inherited from class oms3.dsl.AbstractSimulation

getModel, getName, getOut, getOutput, graph, handleException, output, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

Sim

public Sim()

Method Detail

setTiming

public void setTiming(boolean timing)

Print out timing information at the end. default false

Parameters:

timing -

setSanitychecks

public void setSanitychecks(boolean sanitychecks)

perform sanity checks for the model, default is true.

Parameters:

sanitychecks -

setDigest

public void setDigest(boolean digest)

create

public Buildable create(java.lang.Object name,
                        java.lang.Object value)

Description copied from interface: Buildable

Create a node.

Specified by:

create in interface Buildable

Overrides:

create in class AbstractSimulation

Parameters:

name - the node name

value - the value

Returns:

a new Subnode

run

public java.lang.Object run()

Overrides:

run in class AbstractSimulation

edit

public void edit()
          throws java.lang.Exception

Edit parameter file content. Edit only the

Overrides:

edit in class AbstractSimulation

Throws:

java.lang.Exception

doc

public void doc()
         throws java.lang.Exception

Overrides:

doc in class AbstractSimulation

Throws:

java.lang.Exception

document

public void document(java.lang.CharSequence file)
              throws java.lang.Exception

Generate Simulation Documentation in Docbook 5.

Parameters:

file -

Throws:

java.lang.Exception

dig

public void dig()
         throws java.lang.Exception

Overrides:

dig in class AbstractSimulation

Throws:

java.lang.Exception

digest

public java.lang.String digest()
                        throws java.lang.Exception

Get the simulation digest record.

Returns:

the digest record string

Throws:

java.lang.Exception