org.nlogo.headless
Class HeadlessWorkspace

java.lang.Object
  org.nlogo.workspace.AbstractWorkspace
      org.nlogo.headless.HeadlessWorkspace

All Implemented Interfaces:

org.nlogo.agent.ImporterUser, org.nlogo.agent.WorldResizer, org.nlogo.nvm.JobManagerOwner, org.nlogo.nvm.Workspace, org.nlogo.workspace.Controllable, org.nlogo.workspace.WorldLoaderInterface

public class HeadlessWorkspace
extends org.nlogo.workspace.AbstractWorkspace
implements org.nlogo.workspace.Controllable, org.nlogo.workspace.WorldLoaderInterface

The main class for headless (no GUI) operation of NetLogo.

You may create more than one HeadlessWorkspace object. Multiple instances can operate separately and independently. (Behind the scenes, this is supported by creating a separate thread for each instance.)

When you are done using a HeadlessWorkspace, you should call its dispose() method. This will shut down the thread associated with the workspace and allow resources to be freed.

See the "Controlling" section of the NetLogo User Manual for example code.

Nested Class Summary

Nested classes/interfaces inherited from class org.nlogo.workspace.AbstractWorkspace

org.nlogo.workspace.AbstractWorkspace.HubNetManagerFactory

Field Summary

LogoException	lastLogoException Internal use only.
StringBuffer	outputAreaBuffer
String[]	protocolLines
org.nlogo.render.Renderer	renderer
static int	SPREADSHEET constant for specifying format of BehaviorSpace output
static int	TABLE constant for specifying format of BehaviorSpace output
static String	TEST_DECLARATIONS Internal use only.

Fields inherited from class org.nlogo.workspace.AbstractWorkspace

aggregateManager, DEFAULT_PREVIEW_COMMANDS, jobManager, previewCommands, TYPE_CONVERTED, TYPE_LIBRARY, TYPE_NEW, TYPE_NORMAL, world, worldLoader

Fields inherited from interface org.nlogo.nvm.Workspace

OUTPUT_NORMAL, OUTPUT_TO_FILE, OUTPUT_TO_OUTPUT_AREA

Constructor Summary

HeadlessWorkspace()
Makes a new instance of NetLogo capable of running a model "headless", with no GUI.

Method Summary

int	calculateHeight(int worldHeight, double patchSize)
int	calculateWidth(int worldWidth, double patchSize)
void	changeTopology(boolean wrapX, boolean wrapY)
void	clearDrawing()
void	clearOutput() Internal use only.
void	command(String source) Runs NetLogo commands and waits for them to complete.
double	computePatchSize(int width, int numPatches)
void	createPatchesNotify() Internal use only.
void	ensureRenderer() Internal use only.
void	exportDrawing(String filename, String format)
void	exportDrawingToCSV(PrintWriter writer)
void	exportGraphics(String filename, String format)
void	exportInterface(String filename) Not implemented.
void	exportOutput(String filename)
void	exportOutputAreaToCSV(PrintWriter writer)
void	fontSize(int fontSize)
void	generateModelTest(String model)
static void	generateModelTests() Internal use only.
BufferedImage	getAndCreateDrawing()
org.nlogo.agent.Shape	getDefaultLinkDirectionShape()
org.nlogo.agent.Shape	getDefaultLinkShape()
org.nlogo.agent.Shape	getDefaultShape()
BufferedImage	getGraphics() Get a snapshot of the 2D view.
void	getGraphics(BufferedImage image) Get a snapshot of the 2D view, using an existing BufferedImage object.
int	getMinimumWidth()
void	halt() Halts all running NetLogo code in this workspace.
void	hexDraw(boolean hexDraw)
void	importDrawing(org.nlogo.util.File file)
void	initForTesting(int minPxcor, int maxPxcor, int minPycor, int maxPycor)
void	initForTesting(int minPxcor, int maxPxcor, int minPycor, int maxPycor, String source) Internal use only.
void	initForTesting(org.nlogo.agent.WorldDimensions d)
void	initForTesting(org.nlogo.agent.WorldDimensions d, String source)
void	initModel()
int	insetWidth()
void	inspectAgent(Class agentClass, org.nlogo.agent.Agent agent) Internal use only.
boolean	isCompilerTestingMode() Internal use only.
boolean	isHeadless() Internal use only.
void	magicOpen(String name) Internal use only.
static void	main(String[] args)
void	makePreviews(boolean allModels, boolean overwrite)
void	open(String path) Opens a model stored in a file.
void	openFromSource(String source) Opens a model stored in a string.
void	ownerFinished(org.nlogo.nvm.JobOwner owner) Internal use only.
void	paint(Graphics2D g) Internal use only.
double	patchSize()
void	patchSize(double patchSize)
void	periodicUpdate() Internal use only.
org.nlogo.lab.Protocol	protocolFromModel(String name)
void	refreshShaped(boolean shapesOn)
Object	report(String source) Runs a NetLogo reporter.
void	resizeWorld()
void	runExperiment(File file, int format, PrintWriter writer) Runs a BehaviorSpace experiment.
void	runExperiment(File file, String name, int format, PrintWriter writer) Runs a BehaviorSpace experiment.
void	runExperiment(String xml, int format, PrintWriter writer) Runs a BehaviorSpace experiment.
org.nlogo.lab.Experiment	runExperimentFromModel(String name)
void	runExperimentFromModel(String name, int format, PrintWriter writer) Runs a BehaviorSpace experiment.
void	runtimeError(org.nlogo.nvm.JobOwner owner, org.nlogo.nvm.Context context, org.nlogo.command.Instruction instruction, Exception ex) Internal use only.
void	setCompilerTestingMode(boolean testing) Internal use only.
void	setDimensions(org.nlogo.agent.WorldDimensions d) Kills all turtles, clears all patch variables, and makes a new patch grid.
void	setDimensions(org.nlogo.agent.WorldDimensions d, double patchSize)
void	setImporterErrorHandler(org.nlogo.agent.Importer.ErrorHandler importErrorHandler) Internal use only.
void	setSize(int x, int y)
boolean	shapesOn()
void	shapesOn(boolean shapesOn)
void	stamp(org.nlogo.agent.Turtle turtle, boolean erase)
boolean	stripPlottingCommands() Internal use only.
void	updateDisplay(boolean force) Internal use only.
void	waitFor(org.nlogo.nvm.CommandRunnable runnable) Internal use only.
void	waitForQueuedEvents() Internal use only.
Object	waitForResult(org.nlogo.nvm.ReporterRunnable runnable) Internal use only.
void	writeGraphicsData(PrintWriter writer)

Methods inherited from class org.nlogo.workspace.AbstractWorkspace

addJobFromJobThread, attachModelDir, clearAll, compileCommands, compileForRun, compileReporter, computerHubNetRunning, computerHubNetRunning, convertToNormal, dispose, evaluateCommands, evaluateCommands, evaluateCommands, evaluateReporter, evaluateReporter, exportBehaviors, exportWorld, fileManager, forceSaveAs, getExtensionManager, getHubNetManager, getModelDir, getModelFileName, getModelPath, getModelType, guessExportName, hubnetManager, importDrawing, importWorld, init, isApp, isApp, isApplet, isApplet, joinForeverButtons, modelNameForDisplay, outputObject, resetTimer, runCompiledCommands, runCompiledReporter, setOutputAreaContents, updateChecksum, warningMessage, world

Methods inherited from class java.lang.Object

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

Field Detail

protocolLines

public String[] protocolLines

TABLE

public static final int TABLE

constant for specifying format of BehaviorSpace output

See Also:

Constant Field Values

SPREADSHEET

public static final int SPREADSHEET

constant for specifying format of BehaviorSpace output

See Also:

Constant Field Values

renderer

public org.nlogo.render.Renderer renderer

outputAreaBuffer

public final StringBuffer outputAreaBuffer

TEST_DECLARATIONS

public static final String TEST_DECLARATIONS

Internal use only.

See Also:

Constant Field Values

lastLogoException

public LogoException lastLogoException

Internal use only.

Constructor Detail

HeadlessWorkspace

public HeadlessWorkspace()

Makes a new instance of NetLogo capable of running a model "headless", with no GUI.

Method Detail

isHeadless

public boolean isHeadless()

Internal use only.

Specified by:

isHeadless in class org.nlogo.workspace.AbstractWorkspace

ensureRenderer

public void ensureRenderer()

Internal use only.

setCompilerTestingMode

public void setCompilerTestingMode(boolean testing)

Internal use only.

isCompilerTestingMode

public boolean isCompilerTestingMode()

Internal use only.

Overrides:

isCompilerTestingMode in class org.nlogo.workspace.AbstractWorkspace

waitFor

public void waitFor(org.nlogo.nvm.CommandRunnable runnable)
             throws LogoException

Internal use only.

Specified by:

waitFor in interface org.nlogo.nvm.Workspace

Throws:

LogoException

waitForResult

public Object waitForResult(org.nlogo.nvm.ReporterRunnable runnable)
                     throws LogoException

Internal use only.

Specified by:

waitForResult in interface org.nlogo.nvm.Workspace

Throws:

LogoException

waitForQueuedEvents

public void waitForQueuedEvents()

Internal use only.

Specified by:

waitForQueuedEvents in interface org.nlogo.nvm.Workspace

initForTesting

public void initForTesting(int minPxcor,
                           int maxPxcor,
                           int minPycor,
                           int maxPycor,
                           String source)
                    throws CompilerException

Internal use only.

Throws:

CompilerException

initForTesting

public void initForTesting(org.nlogo.agent.WorldDimensions d,
                           String source)
                    throws CompilerException

Throws:

CompilerException

initForTesting

public void initForTesting(int minPxcor,
                           int maxPxcor,
                           int minPycor,
                           int maxPycor)

initForTesting

public void initForTesting(org.nlogo.agent.WorldDimensions d)

Overrides:

initForTesting in class org.nlogo.workspace.AbstractWorkspace

setDimensions

public void setDimensions(org.nlogo.agent.WorldDimensions d)

Kills all turtles, clears all patch variables, and makes a new patch grid.

Specified by:

setDimensions in interface org.nlogo.agent.WorldResizer

setDimensions

public void setDimensions(org.nlogo.agent.WorldDimensions d,
                          double patchSize)

Specified by:

setDimensions in interface org.nlogo.workspace.WorldLoaderInterface

getMinimumWidth

public int getMinimumWidth()

Specified by:

getMinimumWidth in interface org.nlogo.workspace.WorldLoaderInterface

insetWidth

public int insetWidth()

Specified by:

insetWidth in interface org.nlogo.workspace.WorldLoaderInterface

computePatchSize

public double computePatchSize(int width,
                               int numPatches)

Specified by:

computePatchSize in interface org.nlogo.workspace.WorldLoaderInterface

calculateHeight

public int calculateHeight(int worldHeight,
                           double patchSize)

Specified by:

calculateHeight in interface org.nlogo.workspace.WorldLoaderInterface

calculateWidth

public int calculateWidth(int worldWidth,
                          double patchSize)

Specified by:

calculateWidth in interface org.nlogo.workspace.WorldLoaderInterface

resizeWorld

public void resizeWorld()

Specified by:

resizeWorld in interface org.nlogo.agent.WorldResizer

patchSize

public void patchSize(double patchSize)

Specified by:

patchSize in interface org.nlogo.agent.WorldResizer

Specified by:

patchSize in interface org.nlogo.workspace.WorldLoaderInterface

patchSize

public double patchSize()

Specified by:

patchSize in interface org.nlogo.nvm.Workspace

changeTopology

public void changeTopology(boolean wrapX,
                           boolean wrapY)

Specified by:

changeTopology in interface org.nlogo.nvm.Workspace

Specified by:

changeTopology in interface org.nlogo.workspace.WorldLoaderInterface

refreshShaped

public void refreshShaped(boolean shapesOn)

Specified by:

refreshShaped in interface org.nlogo.workspace.WorldLoaderInterface

fontSize

public void fontSize(int fontSize)

Specified by:

fontSize in interface org.nlogo.workspace.WorldLoaderInterface

hexDraw

public void hexDraw(boolean hexDraw)

Specified by:

hexDraw in interface org.nlogo.workspace.WorldLoaderInterface

setSize

public void setSize(int x,
                    int y)

Specified by:

setSize in interface org.nlogo.workspace.WorldLoaderInterface

createPatchesNotify

public void createPatchesNotify()

Internal use only.

inspectAgent

public void inspectAgent(Class agentClass,
                         org.nlogo.agent.Agent agent)

Internal use only.

Specified by:

inspectAgent in interface org.nlogo.nvm.Workspace

stamp

public void stamp(org.nlogo.agent.Turtle turtle,
                  boolean erase)

Specified by:

stamp in interface org.nlogo.nvm.Workspace

getAndCreateDrawing

public BufferedImage getAndCreateDrawing()

Specified by:

getAndCreateDrawing in interface org.nlogo.nvm.Workspace

importDrawing

public void importDrawing(org.nlogo.util.File file)
                   throws IOException

Specified by:

importDrawing in class org.nlogo.workspace.AbstractWorkspace

Throws:

IOException

clearDrawing

public void clearDrawing()

Specified by:

clearDrawing in interface org.nlogo.nvm.Workspace

Specified by:

clearDrawing in class org.nlogo.workspace.AbstractWorkspace

exportDrawing

public void exportDrawing(String filename,
                          String format)
                   throws IOException

Specified by:

exportDrawing in interface org.nlogo.nvm.Workspace

Throws:

IOException

exportDrawingToCSV

public void exportDrawingToCSV(PrintWriter writer)

Specified by:

exportDrawingToCSV in class org.nlogo.workspace.AbstractWorkspace

exportOutput

public void exportOutput(String filename)

Specified by:

exportOutput in interface org.nlogo.nvm.Workspace

exportOutputAreaToCSV

public void exportOutputAreaToCSV(PrintWriter writer)

Specified by:

exportOutputAreaToCSV in class org.nlogo.workspace.AbstractWorkspace

clearOutput

public void clearOutput()

Internal use only.

Specified by:

clearOutput in interface org.nlogo.nvm.Workspace

setImporterErrorHandler

public void setImporterErrorHandler(org.nlogo.agent.Importer.ErrorHandler importErrorHandler)

Internal use only.

getGraphics

public BufferedImage getGraphics()

Get a snapshot of the 2D view.

getGraphics

public void getGraphics(BufferedImage image)

Get a snapshot of the 2D view, using an existing BufferedImage object.

paint

public void paint(Graphics2D g)

Internal use only.

exportGraphics

public void exportGraphics(String filename,
                           String format)
                    throws IOException

Specified by:

exportGraphics in interface org.nlogo.nvm.Workspace

Throws:

IOException

exportInterface

public void exportInterface(String filename)

Not implemented.

Specified by:

exportInterface in interface org.nlogo.nvm.Workspace

writeGraphicsData

public void writeGraphicsData(PrintWriter writer)

Specified by:

writeGraphicsData in class org.nlogo.workspace.AbstractWorkspace

ownerFinished

public void ownerFinished(org.nlogo.nvm.JobOwner owner)

Internal use only.

Specified by:

ownerFinished in interface org.nlogo.nvm.JobManagerOwner

updateDisplay

public void updateDisplay(boolean force)

Internal use only.

Specified by:

updateDisplay in interface org.nlogo.nvm.JobManagerOwner

periodicUpdate

public void periodicUpdate()

Internal use only.

Specified by:

periodicUpdate in interface org.nlogo.nvm.JobManagerOwner

magicOpen

public void magicOpen(String name)

Internal use only.

Specified by:

magicOpen in interface org.nlogo.nvm.Workspace

Specified by:

magicOpen in class org.nlogo.workspace.AbstractWorkspace

runtimeError

public void runtimeError(org.nlogo.nvm.JobOwner owner,
                         org.nlogo.nvm.Context context,
                         org.nlogo.command.Instruction instruction,
                         Exception ex)

Internal use only.

Specified by:

runtimeError in interface org.nlogo.nvm.JobManagerOwner

open

public void open(String path)
          throws IOException,
                 CompilerException,
                 LogoException

Opens a model stored in a file.

Specified by:

open in interface org.nlogo.workspace.Controllable

Specified by:

open in class org.nlogo.workspace.AbstractWorkspace

Parameters:

path - the path (absolute or relative) of the NetLogo model to open.

Throws:

IOException

CompilerException

LogoException

openFromSource

public void openFromSource(String source)
                    throws CompilerException,
                           LogoException

Opens a model stored in a string. Can only be called once per instance of HeadlessWorkspace

Parameters:

source - The complete model, including widgets and so forth, in the same format as it would be stored in a file.

Throws:

CompilerException

LogoException

command

public void command(String source)
             throws CompilerException,
                    LogoException

Runs NetLogo commands and waits for them to complete.

Specified by:

command in interface org.nlogo.workspace.Controllable

Parameters:

source - The command or commands to run

Throws:

CompilerException - if the code fails to compile

LogoException - if the code fails to run

report

public Object report(String source)
              throws CompilerException,
                     LogoException

Runs a NetLogo reporter.

Specified by:

report in interface org.nlogo.workspace.Controllable

Parameters:

source - The reporter to run

Returns:

the result reported; may be of type java.lang.Integer, java.lang.Double, java.lang.Boolean, java.lang.String, LogoList, Agent, AgentSet, or Nobody

Throws:

CompilerException - if the code fails to compile

LogoException - if the code fails to run

halt

public void halt()

Halts all running NetLogo code in this workspace.

Overrides:

halt in class org.nlogo.workspace.AbstractWorkspace

stripPlottingCommands

public boolean stripPlottingCommands()

Internal use only.

Specified by:

stripPlottingCommands in class org.nlogo.workspace.AbstractWorkspace

runExperiment

public void runExperiment(String xml,
                          int format,
                          PrintWriter writer)
                   throws CompilerException,
                          SAXException

Runs a BehaviorSpace experiment.

Parameters:

xml - a single experiment setup represented in XML

format - TABLE or SPREADSHEET

writer - where to send the results Writes the results of the experiment to the given writer in CSV (comma separated values) format.

Throws:

CompilerException

SAXException

runExperiment

public void runExperiment(File file,
                          int format,
                          PrintWriter writer)
                   throws IOException,
                          CompilerException,
                          SAXException

Runs a BehaviorSpace experiment.

Parameters:

file - file containing a single experiment setup represented in XML

format - TABLE or SPREADSHEET

writer - where to send the results Writes the results of the experiment to the given writer in CSV (comma separated values) format.

Throws:

IOException

CompilerException

SAXException

runExperiment

public void runExperiment(File file,
                          String name,
                          int format,
                          PrintWriter writer)
                   throws IOException,
                          CompilerException,
                          SAXException

Runs a BehaviorSpace experiment.

Parameters:

file - file containing one or more experiment setups represented in XML

name - name of the experiment setup to run; must match the name of one of the setups in the XML file

format - TABLE or SPREADSHEET

writer - where to send the results Writes the results of the experiment to the given writer in CSV (comma separated values) format.

Throws:

IOException

CompilerException

SAXException

protocolFromModel

public org.nlogo.lab.Protocol protocolFromModel(String name)
                                         throws SAXException

Throws:

SAXException

runExperimentFromModel

public org.nlogo.lab.Experiment runExperimentFromModel(String name)
                                                throws CompilerException,
                                                       SAXException

Throws:

CompilerException

SAXException

runExperimentFromModel

public void runExperimentFromModel(String name,
                                   int format,
                                   PrintWriter writer)
                            throws CompilerException,
                                   SAXException

Runs a BehaviorSpace experiment.

Parameters:

name - the name of an experiment setup which is stored in the currently loaded model file

format - TABLE or SPREADSHEET

writer - where to send the results Writes the results of the experiment to the given writer in CSV (comma separated values) format.

Throws:

CompilerException

SAXException

main

public static void main(String[] args)
                 throws InterruptedException

Throws:

InterruptedException

shapesOn

public void shapesOn(boolean shapesOn)

Specified by:

shapesOn in class org.nlogo.workspace.AbstractWorkspace

shapesOn

public boolean shapesOn()

Specified by:

shapesOn in class org.nlogo.workspace.AbstractWorkspace

generateModelTest

public void generateModelTest(String model)
                       throws IOException,
                              CompilerException,
                              LogoException

Throws:

IOException

CompilerException

LogoException

initModel

public void initModel()
               throws LogoException,
                      CompilerException

Specified by:

initModel in interface org.nlogo.nvm.Workspace

Throws:

LogoException

CompilerException

generateModelTests

public static void generateModelTests()
                               throws IOException

Internal use only.

Throws:

IOException

makePreviews

public void makePreviews(boolean allModels,
                         boolean overwrite)

Specified by:

makePreviews in interface org.nlogo.nvm.Workspace

getDefaultShape

public org.nlogo.agent.Shape getDefaultShape()

Overrides:

getDefaultShape in class org.nlogo.workspace.AbstractWorkspace

getDefaultLinkShape

public org.nlogo.agent.Shape getDefaultLinkShape()

Overrides:

getDefaultLinkShape in class org.nlogo.workspace.AbstractWorkspace

getDefaultLinkDirectionShape

public org.nlogo.agent.Shape getDefaultLinkDirectionShape()

Overrides:

getDefaultLinkDirectionShape in class org.nlogo.workspace.AbstractWorkspace