eu.simuline.octave

Class OctaveEngine

java.lang.Object

eu.simuline.octave.OctaveEngine

public final class OctaveEngine
extends Object

The connection to an octave process. This is inspired by the javax.script.ScriptEngine interface.

Field Summary

Fields

Modifier and Type	Field and Description
private OctaveEngineFactory	factory
private OctaveExec	octaveExec The executor of this octave engine.
private OctaveIO	octaveIO
private Random	random Describe variable random here.
private Writer	writer The writer to write to stdout.

Constructor Summary

Constructors

Constructor and Description
OctaveEngine(OctaveEngineFactory factory, int numThreadsReuse, Writer octaveInputLog, Writer errorWriter, String[] cmdArray, String[] environment, File workingDir) Creates an octave engine with the given parameters.

Method Summary

Modifier and Type	Method and Description
void	close() Close the octave process in an orderly fashion.
void	destroy() Kill the octave process without remorse.
void	eval(String script) A safe eval that will not break the engine on syntax errors or other errors.
<T extends OctaveObject> T	get(Class<T> castClass, String key)
OctaveObject	get(String key)
OctaveEngineFactory	getFactory()
private ReadFunctor	getReadFunctor() Returns the according read functor: If writer is non-null, wrap it into a WriterReadFunctor.
String	getVersion() Return the version of the octave implementation.
void	put(String key, OctaveObject value) Sets a value in octave.
void	putAll(Map<String,OctaveObject> vars) Sets all the mappings in the specified map as variables in octave.
void	setErrorWriter(Writer errorWriter) Set the writer that the scripts error output will be written to.
void	setWriter(Writer writer) Set the writer that the scripts output will be written to.
void	unsafeEval(Reader script) Execute the given script.
void	unsafeEval(String script) Execute the given script.

Methods inherited from class java.lang.Object

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

Field Detail

factory

private final OctaveEngineFactory factory

octaveExec

private final OctaveExec octaveExec

The executor of this octave engine.

octaveIO

private final OctaveIO octaveIO

writer

private Writer writer

The writer to write to stdout.

random

private final Random random

Describe variable random here.

Constructor Detail

OctaveEngine

OctaveEngine(OctaveEngineFactory factory,
             int numThreadsReuse,
             Writer octaveInputLog,
             Writer errorWriter,
             String[] cmdArray,
             String[] environment,
             File workingDir)

Creates an octave engine with the given parameters. The first one is nowhere used and the others are handed over to OctaveExec(int,Writer,Writer,String[],String[],File).

Method Detail

getReadFunctor

private ReadFunctor getReadFunctor()

Returns the according read functor: If writer is non-null, wrap it into a WriterReadFunctor. Otherwise, create functor from a reader which reads empty, i.e. without action, as long as the reader is empty.

unsafeEval

public void unsafeEval(Reader script)

Execute the given script.

Parameters:

script - the script to execute

Throws:

OctaveIOException - if the script fails, this will kill the engine

unsafeEval

public void unsafeEval(String script)

Execute the given script.

Parameters:

script - the script to execute

Throws:

OctaveIOException - if the script fails, this will kill the engine

eval

public void eval(String script)

A safe eval that will not break the engine on syntax errors or other errors.

Parameters:

script - the script to execute

Throws:

OctaveEvalException - if the script fails

put

public void put(String key,
                OctaveObject value)

Sets a value in octave.

Parameters:

key - the name of the variable

value - the value to set

putAll

public void putAll(Map<String,OctaveObject> vars)

Sets all the mappings in the specified map as variables in octave. These mappings replace any variable that octave had for any of the keys currently in the specified map.

Parameters:

vars - the variables to be stored in octave

get

public OctaveObject get(String key)

Parameters:

key - the name of the variable

Returns:

the value from octave or null if the variable does not exist

get

public <T extends OctaveObject> T get(Class<T> castClass,
                                      String key)

Type Parameters:

T - the class of the return value

Parameters:

castClass - Class to cast to

key - the name of the variable

Returns:

shallow copy of value for this key, or null if key isn't there.

Throws:

OctaveClassCastException - if the object can not be cast to a castClass

getFactory

public OctaveEngineFactory getFactory()

Returns:

the factory that created this object

setWriter

public void setWriter(Writer writer)

Set the writer that the scripts output will be written to. This method is usually placed in ScriptContext.

Parameters:

writer - the writer to set

setErrorWriter

public void setErrorWriter(Writer errorWriter)

Set the writer that the scripts error output will be written to. This method is usually placed in ScriptContext.

Parameters:

errorWriter - the errorWriter to set

close

public void close()

Close the octave process in an orderly fashion.

destroy

public void destroy()

Kill the octave process without remorse.

getVersion

public String getVersion()

Return the version of the octave implementation. E.g. a string like "3.0.5" or "3.2.3".

Returns:

Version of octave