org.nlogo.nvm
Interface Workspace

All Superinterfaces:
ImporterUser, JobManagerOwner, WorldResizer
All Known Implementing Classes:
AbstractWorkspace, DummyWorkspace, HeadlessWorkspace

public interface Workspace
extends ImporterUser, JobManagerOwner


Field Summary
static int CONTINUOUS_UPDATES
           
static int OUTPUT_NORMAL
           
static int OUTPUT_TO_FILE
           
static int OUTPUT_TO_OUTPUT_AREA
           
static int TICK_BASED_UPDATES
           
 
Method Summary
 void addJobFromJobThread(Job job)
           
 String attachModelDir(String filePath)
           
 void changeTopology(boolean wrapX, boolean wrapY)
           
 void clearAll()
           
 void clearDrawing()
           
 void clearOutput()
           
 Procedure compileCommands(String source)
           
 Procedure compileForRun(String source, Context context, boolean reporter)
           
 Procedure compileReporter(String source)
           
 void convertToNormal()
           
 void deleteLogFiles()
           
 void evaluateCommands(String source)
           
 void evaluateCommands(String source, Agent agent, boolean waitForCompletion)
           
 void evaluateCommands(String source, Class agentClass, boolean waitForCompletion)
           
 Object evaluateReporter(String source, Agent agent)
           
 void exportAllPlots(String path)
           
 void exportDrawing(String path, String format)
           
 void exportGraphics(String path, String format)
           
 void exportInterface(String path)
           
 void exportOutput(String path)
           
 void exportPlot(org.nlogo.plot.Plot plot, String path)
           
 void exportWorld(String path)
           
 FileManager fileManager()
           
 BufferedImage getAndCreateDrawing()
           
 org.nlogo.compiler.AutoConverter.ErrorHandler getAutoConverterErrorHandler()
           
 org.nlogo.compiler.ExtensionManager getExtensionManager()
           
 float[] getHSB(int[] rgb)
           
 HubNetInterface getHubNetManager()
           
 boolean getIsApplet()
           
 String getModelDir()
           
 String getModelFileName()
           
 String getModelPath()
           
 void importDrawing(String path)
           
 void importWorld(String path)
           
 void initModelForChecksumming()
           
 void inspectAgent(Class agentClass, Agent agent)
           
 void joinForeverButtons(Agent agent)
           
 void magicOpen(String name)
           
 void makePreviews(boolean allModels, boolean overwrite)
           
 void openIndex()
           
 void openNext()
           
 void openPrevious()
           
 void outputObject(Object object, Object owner, boolean addNewline, boolean readable, int destination)
           
 double patchSize()
           
 void perhapsUpdateDisplay()
           
 org.nlogo.plot.PlotManager plotManager()
           
 void requestDisplayUpdate(boolean force)
           
 void resetTimer()
           
 boolean runCompiledCommands(Procedure procedure)
           
 Object runCompiledReporter(Procedure procedure)
           
 void startLogging(String properties)
           
 void updateChecksum()
           
 void waitFor(CommandRunnable runnable)
           
 void waitForQueuedEvents()
           
 Object waitForResult(ReporterRunnable runnable)
           
 World world()
           
 void zipLogFiles(String filename)
           
 
Methods inherited from interface org.nlogo.agent.ImporterUser
currentPlot, getPlot, setOutputAreaContents
 
Methods inherited from interface org.nlogo.agent.WorldResizer
patchSize, resizeWorld, setDimensions
 
Methods inherited from interface org.nlogo.nvm.JobManagerOwner
ownerFinished, periodicUpdate, runtimeError, updateDisplay
 

Field Detail

OUTPUT_NORMAL

static final int OUTPUT_NORMAL
See Also:
Constant Field Values

OUTPUT_TO_OUTPUT_AREA

static final int OUTPUT_TO_OUTPUT_AREA
See Also:
Constant Field Values

OUTPUT_TO_FILE

static final int OUTPUT_TO_FILE
See Also:
Constant Field Values

CONTINUOUS_UPDATES

static final int CONTINUOUS_UPDATES
See Also:
Constant Field Values

TICK_BASED_UPDATES

static final int TICK_BASED_UPDATES
See Also:
Constant Field Values
Method Detail

world

World world()

requestDisplayUpdate

void requestDisplayUpdate(boolean force)

perhapsUpdateDisplay

void perhapsUpdateDisplay()

joinForeverButtons

void joinForeverButtons(Agent agent)

addJobFromJobThread

void addJobFromJobThread(Job job)

getExtensionManager

org.nlogo.compiler.ExtensionManager getExtensionManager()

waitFor

void waitFor(CommandRunnable runnable)
             throws LogoException
Throws:
LogoException

waitForResult

Object waitForResult(ReporterRunnable runnable)
                     throws LogoException
Throws:
LogoException

importWorld

void importWorld(String path)
                 throws IOException
Throws:
IOException

importDrawing

void importDrawing(String path)
                   throws IOException
Throws:
IOException

clearDrawing

void clearDrawing()

exportDrawing

void exportDrawing(String path,
                   String format)
                   throws IOException
Throws:
IOException

exportGraphics

void exportGraphics(String path,
                    String format)
                    throws IOException
Throws:
IOException

exportInterface

void exportInterface(String path)
                     throws IOException
Throws:
IOException

exportWorld

void exportWorld(String path)
                 throws IOException
Throws:
IOException

exportOutput

void exportOutput(String path)
                  throws IOException
Throws:
IOException

exportPlot

void exportPlot(org.nlogo.plot.Plot plot,
                String path)
                throws IOException
Throws:
IOException

exportAllPlots

void exportAllPlots(String path)
                    throws IOException
Throws:
IOException

inspectAgent

void inspectAgent(Class agentClass,
                  Agent agent)

getAndCreateDrawing

BufferedImage getAndCreateDrawing()

resetTimer

void resetTimer()

getHubNetManager

HubNetInterface getHubNetManager()

waitForQueuedEvents

void waitForQueuedEvents()
                         throws LogoException
Throws:
LogoException

outputObject

void outputObject(Object object,
                  Object owner,
                  boolean addNewline,
                  boolean readable,
                  int destination)
                  throws LogoException
Throws:
LogoException

clearOutput

void clearOutput()
                 throws LogoException
Throws:
LogoException

clearAll

void clearAll()
              throws LogoException
Throws:
LogoException

compileForRun

Procedure compileForRun(String source,
                        Context context,
                        boolean reporter)
                        throws CompilerException
Throws:
CompilerException

convertToNormal

void convertToNormal()
                     throws IOException
Throws:
IOException

getModelPath

String getModelPath()

getModelDir

String getModelDir()

getModelFileName

String getModelFileName()

fileManager

FileManager fileManager()

plotManager

org.nlogo.plot.PlotManager plotManager()

attachModelDir

String attachModelDir(String filePath)
                      throws MalformedURLException
Throws:
MalformedURLException

evaluateCommands

void evaluateCommands(String source)
                      throws CompilerException
Throws:
CompilerException

evaluateCommands

void evaluateCommands(String source,
                      Agent agent,
                      boolean waitForCompletion)
                      throws CompilerException
Throws:
CompilerException

evaluateCommands

void evaluateCommands(String source,
                      Class agentClass,
                      boolean waitForCompletion)
                      throws CompilerException
Throws:
CompilerException

evaluateReporter

Object evaluateReporter(String source,
                        Agent agent)
                        throws CompilerException
Throws:
CompilerException

compileCommands

Procedure compileCommands(String source)
                          throws CompilerException
Throws:
CompilerException

compileReporter

Procedure compileReporter(String source)
                          throws CompilerException
Throws:
CompilerException

runCompiledCommands

boolean runCompiledCommands(Procedure procedure)

runCompiledReporter

Object runCompiledReporter(Procedure procedure)

patchSize

double patchSize()

updateChecksum

void updateChecksum()
                    throws LogoException,
                           CompilerException,
                           IOException
Throws:
LogoException
CompilerException
IOException

initModelForChecksumming

void initModelForChecksumming()
                              throws LogoException,
                                     CompilerException
Throws:
LogoException
CompilerException

changeTopology

void changeTopology(boolean wrapX,
                    boolean wrapY)

makePreviews

void makePreviews(boolean allModels,
                  boolean overwrite)

magicOpen

void magicOpen(String name)

openIndex

void openIndex()

openNext

void openNext()

openPrevious

void openPrevious()

startLogging

void startLogging(String properties)

zipLogFiles

void zipLogFiles(String filename)

deleteLogFiles

void deleteLogFiles()

getHSB

float[] getHSB(int[] rgb)

getAutoConverterErrorHandler

org.nlogo.compiler.AutoConverter.ErrorHandler getAutoConverterErrorHandler()

getIsApplet

boolean getIsApplet()