org.nlogo.api
Interface Context

public interface Context

Provides access to the current execution environment.

Method Summary

String	attachCurrentDirectory(String path) Transforms a relative path to an absolute path by prepending the current working directory.
String	attachModelDir(String filePath) Transforms a relative path to a model into an absolute path by prepending the current model directory.
Agent	getAgent() Returns the agent that is currently executing this code.
void	pauseProgram() Undocumented method.
void	resumeProgram() Undocumented method.
void	runCommand(String source, boolean waitForFinish) Runs a command as if it were written in the Command Center.
Object	runReporter(String source) Runs a reporter as if it were written in the Command Center.
void	setVariable(Argument arg, Object netLogoValue) Undocumented method.

Method Detail

getAgent

public Agent getAgent()

Returns the agent that is currently executing this code.

runCommand

public void runCommand(String source,
                       boolean waitForFinish)
                throws ExtensionException

Runs a command as if it were written in the Command Center.

Parameters:

source - the source code to run

waitForFinish - determines whether the method returns immediately, or waits until the Logo code is done executing

Throws:

ExtensionException

runReporter

public Object runReporter(String source)
                   throws ExtensionException

Runs a reporter as if it were written in the Command Center.

Parameters:

source - the source code to run

Returns:

the object returned by the reporter

Throws:

ExtensionException

attachModelDir

public String attachModelDir(String filePath)

Transforms a relative path to a model into an absolute path by prepending the current model directory. If this is a new model, and therefore doesn't have a model directory yet, the user's platform-dependent home directory is prepended instead. If filePath is an absolute path, it is returned unchanged.

Parameters:

filePath - the path to be processed

Returns:

an absolute path

attachCurrentDirectory

public String attachCurrentDirectory(String path)

Transforms a relative path to an absolute path by prepending the current working directory. If filePath is an absolute path, it is returned unchanged.

The "current working directory" is the current directory used by NetLogo's file I/O primitives, and can be changed by the user at run-time using the file-set-current-directory primitive. Its initial value is the directory from which the current model was loaded, or the user's home directory if this is a new model.

setVariable

public void setVariable(Argument arg,
                        Object netLogoValue)
                 throws ExtensionException

Undocumented method.

Throws:

ExtensionException

pauseProgram

public void pauseProgram()

Undocumented method.

resumeProgram

public void resumeProgram()

Undocumented method.