eu.simuline.octave

Class OctaveEngineFactory

java.lang.Object

eu.simuline.octave.OctaveEngineFactory

public final class OctaveEngineFactory
extends Object

Factory that creates OctaveEngines. First of all, create an OctaveEngineFactory using the default constructor OctaveEngineFactory() then, optionally, change parameters and finally create an Octave Engine using getScriptEngine() with the current parameters. To set a parameter, use the various setter methods. In the documentation of each setter method, also the default value is documented which is used to create an OctaveEngine if the setter method is not invoked.

Field Summary

Fields

Modifier and Type	Field and Description
private String[]	argsArray The array of arguments of the octave engines created.
private String[]	environment An array of strings of the form name=value representing the environment, i.e. the set of environment variables or null.
private Writer	errWriter The error writer for the octave process.
private int	numThreadsReuse The number of threads to be reused or -1 if there is no limit.
private Writer	octaveInputLog If this is not null, the octave engine created writes the output to that log writer also.
private String	octaveProgramCmd The command which determines the octave executable if octaveProgramFile is null and if the property PROPERTY_EXECUTABLE is not set.
private File	octaveProgramFile The file containing the octave program or is null.
static String	PROPERTY_EXECUTABLE System property where the executable is found.
private File	workingDir The file representing the working directory or null.

Constructor Summary

Constructors

Constructor and Description
OctaveEngineFactory() Default constructor creating a factory with default parameters.

Method Summary

Modifier and Type	Method and Description
OctaveEngine	getScriptEngine() Returns a script engine with the parameters set for this factory.
void	setArgsArray(String[] argsArray) Sets an array of arguments argsArray used when creating an OctaveEngine.
void	setEnvironment(String[] environment) Setter method for environment.
void	setErrorWriter(Writer errWriter) Setter method for errWriter.
void	setNumThreadsReuse(int numThreadsReuse) Sets the number of threads to be reused or -1 which indicates no limit.
void	setOctaveInputLog(Writer octaveInputLog) Setter method for octaveInputLog.
void	setOctaveProgramCmd(String octaveProgramCmd) Setter method for octaveProgramCmd.
void	setOctaveProgramFile(File octaveProgramFile) Setter method for octaveProgramFile.
void	setWorkingDir(File workingDir) Setter method for workingDir.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_EXECUTABLE

public static final String PROPERTY_EXECUTABLE

System property where the executable is found.

See Also:

Constant Field Values

octaveInputLog

private Writer octaveInputLog

If this is not null, the octave engine created writes the output to that log writer also. By default, this is null. The according setter method is setOctaveInputLog(Writer).

errWriter

private Writer errWriter

The error writer for the octave process. By default, this is just System.err. The according setter method is setErrorWriter(Writer).

octaveProgramFile

private File octaveProgramFile

The file containing the octave program or is null. In the latter case, the name of the octave program command is determined as described for octaveProgramCmd. By default, this is null.

octaveProgramCmd

private String octaveProgramCmd

The command which determines the octave executable if octaveProgramFile is null and if the property PROPERTY_EXECUTABLE is not set. By default, this is "octave".

argsArray

private String[] argsArray

The array of arguments of the octave engines created. For details, see octave user manual, version 3.4.0.+, Section 2.2.1.

Default value of this field is default value for octave engines created. The default value consists of the following components:

• --silent: prevents octave from printing the usual greeting and version message at startup.
• --no-init-file, --no-site-file prevents octave from reading the initialization files ~/.octaverc, .octaverc and site-wide octaverc.

The only mandatory argument is --silent: If not set this, octave's greeting message causes an exception. Option --no-init-file makes the result independent of user input, whereas --no-init-file and --no-site-file makes it independent of initialization files. Since this is used to create scripting engines, line editing and history seem superfluous and so --no-line-editing and --no-history seem appropriate. Note that --no-init-file and --no-site-file may be appropriate or not. ***** why not needed --no-gui? --no-window-system

environment

private String[] environment

An array of strings of the form name=value representing the environment, i.e. the set of environment variables or null. In the latter case, the environment is inherited from the current process. This field is initialized with null.

workingDir

private File workingDir

The file representing the working directory or null. In the latter case, the working directory is inherited from the current process. By default, this is null.

numThreadsReuse

private int numThreadsReuse

The number of threads to be reused or -1 if there is no limit. By default, this is 2.

Constructor Detail

OctaveEngineFactory

public OctaveEngineFactory()

Default constructor creating a factory with default parameters.

Method Detail

getScriptEngine

public OctaveEngine getScriptEngine()

Returns a script engine with the parameters set for this factory.

Returns:

a new OctaveEngine with the current parameters.

setOctaveInputLog

public void setOctaveInputLog(Writer octaveInputLog)

Setter method for octaveInputLog.

Parameters:

octaveInputLog - the octaveInputLog to set

setErrorWriter

public void setErrorWriter(Writer errWriter)

Setter method for errWriter.

Parameters:

errWriter - the errWriter to set

setOctaveProgramFile

public void setOctaveProgramFile(File octaveProgramFile)

Setter method for octaveProgramFile.

Parameters:

octaveProgramFile - the octaveProgramFile to set or null.

setOctaveProgramCmd

public void setOctaveProgramCmd(String octaveProgramCmd)

Setter method for octaveProgramCmd. This takes effect only, if octaveProgramFile is null and if the property PROPERTY_EXECUTABLE is not set.

Parameters:

octaveProgramCmd - the octave program executable to set

setArgsArray

public void setArgsArray(String[] argsArray)

Sets an array of arguments argsArray used when creating an OctaveEngine. The validity of the argument string is not proved. Note that subsequent changes on the array argsArray do not have any influence on this factory. The default options and a discussion of necessary options are documented with argsArray.

Parameters:

argsArray - the arguments as an array to set

setEnvironment

public void setEnvironment(String[] environment)

Setter method for environment. Note that subsequent changes on the array environment do not have any influence on this factory. The details are documented with environment.

Parameters:

environment - the environment or null.

setWorkingDir

public void setWorkingDir(File workingDir)

Setter method for workingDir.

Parameters:

workingDir - the workingDir to set or null.

setNumThreadsReuse

public void setNumThreadsReuse(int numThreadsReuse)

Sets the number of threads to be reused or -1 which indicates no limit. The default value is 2 but this can be speed optimized depending on the hardware. The number of threads to be created shall be positive or -1 otherwise throwing an exception.