HeadlessWorkspace (NetLogo 4.1.3 API Specification)

org.nlogo.headless
Class HeadlessWorkspace

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

All Implemented Interfaces:: Evaluator, org.nlogo.api.CompilerServices, HubNetWorkspaceInterface, ImporterUser, RandomServices, ViewSettings, WorldResizer, JobManagerOwner, Workspace, Controllable, WorldLoaderInterface

public class HeadlessWorkspace
extends AbstractWorkspace
implements Controllable, WorldLoaderInterface, ViewSettings
extends AbstractWorkspace
implements Controllable, WorldLoaderInterface, ViewSettings

The primary 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
`AbstractWorkspace.HubNetManagerFactory`

Nested classes/interfaces inherited from interface org.nlogo.nvm.Workspace
`Workspace.BehaviorSpaceFormat, Workspace.OutputDestination, Workspace.UpdateMode`

Field Summary
`LogoException`	`lastLogoException` Internal use only.
`boolean`	`modelOpened` Has a model been opened in this workspace?
`StringBuilder`	`outputAreaBuffer`
`static String`	`TEST_DECLARATIONS` Internal use only.

Fields inherited from class org.nlogo.workspace.AbstractWorkspace
`codeBits, DEFAULT_PREVIEW_COMMANDS, jobManager, previewCommands, world`

Constructor Summary
`HeadlessWorkspace(World world, CompilerInterface compiler, RendererInterface renderer, org.nlogo.api.AggregateManagerInterface aggregateManager)` Internal use only.

Method Summary

org.nlogo.api.AggregateManagerInterface aggregateManager()

int calculateHeight(int worldHeight, double patchSize)

int calculateWidth(int worldWidth, double patchSize)

void changeTopology(boolean wrapX, boolean wrapY)

void clearDrawing()

void clearLastLogoException()
Internal use only.

void clearOutput()
Internal use only.

void clearTurtles()

void command(String source)
Runs NetLogo commands and waits for them to complete.

CompilerInterface compiler()

double computePatchSize(int width, int numPatches)

void createPatchesNotify()
Internal use only.

void deleteLogFiles()
Internal use only.

boolean drawSpotlight()

void exportDrawing(String filename, String format)

void exportDrawingToCSV(PrintWriter writer)

void exportInterface(String filename)
Not implemented.

void exportOutput(String filename)

void exportOutputAreaToCSV(PrintWriter writer)

BufferedImage exportView()
Get a snapshot of the 2D view.

void exportView(String filename, String format)

int fontSize()

void fontSize(int fontSize)

BufferedImage getAndCreateDrawing()

void getGraphics(BufferedImage image)
Get a snapshot of the 2D view, using an existing BufferedImage object.

int getHeight()

int getMinimumWidth()

int getWidth()

void halt()
Halts all running NetLogo code in this workspace.

void importDrawing(File file)

void initForTesting(int worldSize)
Internal use only.

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(int worldSize, String modelString)
Internal use only.

void initForTesting(WorldDimensions d)
Internal use only.

void initForTesting(WorldDimensions d, String source)
Internal use only.

int insetWidth()

void inspectAgent(Agent agent, double radius)
Internal use only.

void inspectAgent(Class<? extends Agent> agentClass, Agent agent, double radius)
Internal use only.

boolean isCompilerTestingMode()
Internal use only.

boolean isHeadless()
Internal use only.

LogoException lastLogoException()
Internal use only.

void magicOpen(String name)
Internal use only.

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

static HeadlessWorkspace newInstance(Class<? extends HeadlessWorkspace> subclass)
If you derive your own subclass of HeadlessWorkspace, you can use this method to instantiate it.

static org.nlogo.nvm.LabInterface newLab()

void open(String path)
Opens a model stored in a file.

void openFromSource(String source)
Opens a model stored in a string.

void openIndex()
Internal use only.

void openNext()
Internal use only.

void openPrevious()
Internal use only.

void openString(String modelContents)
Opens a model stored in a string

void ownerFinished(JobOwner owner)
Internal use only.

void paint(Graphics2D g)
Internal use only.

double patchSize()

void patchSize(double patchSize)

void perhapsUpdateDisplay()
Internal use only.

void periodicUpdate()
Internal use only.

Perspective perspective()

RendererInterface renderer()

boolean renderPerspective()

Object report(String source)
Runs a NetLogo reporter.

void requestDisplayUpdate(boolean force)
Internal use only.

void resizeView()

void runtimeError(JobOwner owner, Context context, Instruction instruction, Exception ex)
Internal use only.

void setCompilerTestingMode(boolean testing)
Internal use only.

void setDimensions(WorldDimensions d)
Kills all turtles, clears all patch variables, and makes a new patch grid.

void setDimensions(WorldDimensions d, double patchSize)

void setImporterErrorHandler(Importer.ErrorHandler importErrorHandler)
Internal use only.

void setSize(int x, int y)

boolean showTickCounter()

void showTickCounter(boolean visible)

void startLogging(String properties)
Internal use only.

String tickCounterLabel()

void tickCounterLabel(String label)

void updateDisplay(boolean haveWorldLockAlready)
Internal use only.

void updateMode(Workspace.UpdateMode updateMode)

double viewHeight()

double viewOffsetX()

double viewOffsetY()

double viewWidth()

void waitFor(CommandRunnable runnable)
Internal use only.

void waitForQueuedEvents()
Internal use only.





<T> T

waitForResult(ReporterRunnable<T> runnable)
Internal use only.

void writeGraphicsData(PrintWriter writer)

void zipLogFiles(String filename)
Internal use only.

Methods inherited from class org.nlogo.workspace.AbstractWorkspace
addJobFromJobThread, attachModelDir, autoConvert, auxRNG, behaviorSpaceRunNumber, behaviorSpaceRunNumber, checkCommandSyntax, checkReporterSyntax, clearAll, compileCommands, compileCommands, compileForRun, compileReporter, computerHubNetRunning, computerHubNetRunning, convertToNormal, currentPlot, dispose, evaluateCommands, evaluateCommands, evaluateCommands, evaluateReporter, evaluateReporter, exportAllPlots, exportBehaviors, exportPlot, exportWorld, exportWorld, fileManager, findProcedurePositions, forceSaveAs, getExtensionManager, getHubNetManager, getIsApplet, getModelDir, getModelFileName, getModelPath, getModelType, getPlot, getProcedures, getPropertiesInterface, getSource, getTokenAtPosition, guessExportName, hubnetManager, importDrawing, importExtensionData, importWorld, init, isApp, isApp, isApplet, isApplet, isConstant, isExtensionName, isValidIdentifier, joinForeverButtons, lastRunTimes, loadWorld, mainRNG, makeThunk, modelNameForDisplay, outputObject, plotManager, readFromString, readNumberFromString, runCompiledCommands, runCompiledReporter, runCompiledReporter, setModelPath, setOutputAreaContents, setProcedures, tokenizeForColorization, updateMode, warningMessage, world

Methods inherited from class org.nlogo.workspace.AbstractWorkspace

addJobFromJobThread, attachModelDir, autoConvert, auxRNG, behaviorSpaceRunNumber, behaviorSpaceRunNumber, checkCommandSyntax, checkReporterSyntax, clearAll, compileCommands, compileCommands, compileForRun, compileReporter, computerHubNetRunning, computerHubNetRunning, convertToNormal, currentPlot, dispose, evaluateCommands, evaluateCommands, evaluateCommands, evaluateReporter, evaluateReporter, exportAllPlots, exportBehaviors, exportPlot, exportWorld, exportWorld, fileManager, findProcedurePositions, forceSaveAs, getExtensionManager, getHubNetManager, getIsApplet, getModelDir, getModelFileName, getModelPath, getModelType, getPlot, getProcedures, getPropertiesInterface, getSource, getTokenAtPosition, guessExportName, hubnetManager, importDrawing, importExtensionData, importWorld, init, isApp, isApp, isApplet, isApplet, isConstant, isExtensionName, isValidIdentifier, joinForeverButtons, lastRunTimes, loadWorld, mainRNG, makeThunk, modelNameForDisplay, outputObject, plotManager, readFromString, readNumberFromString, runCompiledCommands, runCompiledReporter, runCompiledReporter, setModelPath, setOutputAreaContents, setProcedures, tokenizeForColorization, updateMode, warningMessage, world

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

modelOpened

public boolean modelOpened

Has a model been opened in this workspace?

outputAreaBuffer

public final StringBuilder 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