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.
Don't try to use the constructor yourself; use HeadlessWorkspace.newInstance instead.
Attributes
- Companion
- object
- Source
- HeadlessWorkspace.scala
- Graph
-
- Supertypes
-
trait WorldLoaderInterfacetrait Controllableclass AbstractWorkspaceScalatrait Extensionstrait Exportingtrait Plottingtrait HubNetManagertrait Componentstrait Traceabletrait BehaviorSpaceInformationtrait Compilingtrait Procedurestrait ModelTrackertrait Evaluatingtrait Checksumstrait Benchmarkingtrait APIConformantclass AbstractWorkspacetrait HubNetWorkspaceInterfacetrait CompilerServicestrait LogoThunkFactorytrait ExtendableWorkspacetrait EditorWorkspacetrait Workspacetrait JobManagerOwnertrait Workspacetrait Controllabletrait ViewSettingstrait RandomServicestrait LiteralParsertrait ImporterUsertrait WorldResizerclass Objecttrait Matchableclass AnyShow all
Members list
Value members
Concrete methods
Internal use only.
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
-
AbstractWorkspace -> Workspace
- Source
- HeadlessWorkspace.scala
Internal use only.
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Not implemented.
Attributes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Get a snapshot of the 2D view.
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Get a snapshot of the 2D view, using an existing BufferedImage object.
Get a snapshot of the 2D view, using an existing BufferedImage object.
Attributes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Halts all running NetLogo code in this workspace.
Halts all running NetLogo code in this workspace.
Attributes
- Definition Classes
-
AbstractWorkspace
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
-
AbstractWorkspace
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
-
AbstractWorkspace
- Source
- HeadlessWorkspace.scala
Internal use only.
Internal use only.
Internal use only.
Internal use only.
Internal use only.
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Source
- HeadlessWorkspace.scala
Attributes
- Source
- HeadlessWorkspace.scala
Internal use only.
Attributes
- Source
- HeadlessWorkspace.scala
Attributes
- Source
- HeadlessWorkspace.scala
Internal use only.
Internal use only.
Attributes
- Definition Classes
-
AbstractWorkspace -> EditorWorkspace
- Source
- HeadlessWorkspace.scala
Has a model been opened in this workspace?
Opens a model stored in a file.
Opens a model stored in a file.
Value parameters
- path
-
the path (absolute or relative) of the NetLogo model to open.
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Opens a model stored in a string. Can only be called once per instance of HeadlessWorkspace
Opens a model stored in a string. Can only be called once per instance of HeadlessWorkspace
Value parameters
- source
-
The complete model, including widgets and so forth, in the same format as it would be stored in a file.
Attributes
- Source
- HeadlessWorkspace.scala
Attributes
- Source
- HeadlessWorkspace.scala
Opens a model stored in a string
Opens a model stored in a string
Attributes
- Definition Classes
-
AbstractWorkspace
- Source
- HeadlessWorkspace.scala
Internal use only.
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Internal use only.
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Internal use only.
Internal use only.
Attributes
- Definition Classes
-
AbstractWorkspace -> Workspace
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Internal use only.
Internal use only. Called from job thread.
Internal use only. Called from job thread.
Attributes
- Definition Classes
-
AbstractWorkspace
- Source
- HeadlessWorkspace.scala
Attributes
- Source
- HeadlessWorkspace.scala
Kills all turtles, clears all patch variables, and makes a new patch grid.
Kills all turtles, clears all patch variables, and makes a new patch grid.
Attributes
- Source
- HeadlessWorkspace.scala
Attributes
- Source
- HeadlessWorkspace.scala
Attributes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Source
- HeadlessWorkspace.scala
Internal use only.
Attributes
- Definition Classes
-
WorldLoaderInterface -> AbstractWorkspace
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Attributes
- Definition Classes
- Source
- HeadlessWorkspace.scala
Internal use only.
Internal use only.
Internal use only.
Inherited methods
Attributes
- Inherited from:
- Components
- Source
- Components.scala
Attributes
- Inherited from:
- Workspace
- Source
- Workspace.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- Components
- Source
- Components.scala
attaches the current model directory to a relative path, if necessary. If filePath is an absolute path, this method simply returns it. If it's a relative path, then the current model directory is prepended to it. If this is a new model, the user's platform-dependent home directory is prepended instead.
attaches the current model directory to a relative path, if necessary. If filePath is an absolute path, this method simply returns it. If it's a relative path, then the current model directory is prepended to it. If this is a new model, the user's platform-dependent home directory is prepended instead.
Attributes
- Inherited from:
- ExtendableWorkspaceMethods
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- Workspace
- Source
- Workspace.scala
Attributes
- Inherited from:
- BehaviorSpaceInformation
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- BehaviorSpaceInformation
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- BehaviorSpaceInformation
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- BehaviorSpaceInformation
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- Benchmarking
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- Compiling
- Source
- Compiling.scala
Attributes
- Inherited from:
- Compiling
- Source
- Compiling.scala
Attributes
- Inherited from:
- AbstractWorkspaceScala
- Source
- AbstractWorkspaceScala.scala
Attributes
- Definition Classes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- AbstractWorkspaceScala
- Source
- AbstractWorkspaceScala.scala
Runs NetLogo commands and waits for them to complete.
Runs NetLogo commands and waits for them to complete.
Value parameters
- source
-
The command or commands to run
Attributes
- Throws
-
org.nlogo.api.LogoException
if the code fails to run
org.nlogo.core.CompilerExceptionif the code fails to compile
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
instantly converts the current model to ModelTypeJ.NORMAL. This is used by the __edit command to enable quick saving of library models. It shouldn't be used anywhere else.
instantly converts the current model to ModelTypeJ.NORMAL. This is used by the __edit command to enable quick saving of library models. It shouldn't be used anywhere else.
Attributes
- Inherited from:
- ModelTracker
- Source
- ModelTracker.scala
Attributes
- Inherited from:
- Plotting
- Source
- Plotting.scala
Attributes
- Inherited from:
- Compiling
- Source
- Compiling.scala
Attributes
- Inherited from:
- Components
- Source
- Components.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- Exporting
- Source
- Exporting.scala
Attributes
- Inherited from:
- Exporting
- Source
- Exporting.scala
Attributes
- Inherited from:
- Exporting
- Source
- Exporting.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- Exporting
- Source
- Exporting.scala
Attributes
- Inherited from:
- Exporting
- Source
- Exporting.scala
Attributes
- Inherited from:
- Exporting
- Source
- Exporting.scala
Attributes
- Inherited from:
- Compiling
- Source
- Compiling.scala
Attributes
- Inherited from:
- APIConformant
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- APIConformant
- Source
- AbstractWorkspaceScala.scala
whether the user needs to enter a new filename to save this model. We need to do a "save as" if the model is new, from the models library, or converted.
whether the user needs to enter a new filename to save this model. We need to do a "save as" if the model is new, from the models library, or converted.
Basically, only normal models can get silently saved.
Attributes
- Inherited from:
- ModelTracker
- Source
- ModelTracker.scala
Attributes
- Inherited from:
- BehaviorSpaceInformation
- Source
- AbstractWorkspaceScala.scala
Attributes
- Definition Classes
- Inherited from:
- AbstractWorkspaceScala
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- Components
- Source
- Components.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- Extensions
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- HubNetManager
- Source
- AbstractWorkspaceScala.scala
Attributes
- Definition Classes
- Inherited from:
- AbstractWorkspaceScala
- Source
- AbstractWorkspaceScala.scala
returns the full path to the directory from which the current model was loaded. May be null if, for example, this is a new model.
returns the full path to the directory from which the current model was loaded. May be null if, for example, this is a new model.
Attributes
- Inherited from:
- ModelTracker
- Source
- ModelTracker.scala
returns the name of the file from which the current model was loaded. May be null if, for example, this is a new model.
returns the name of the file from which the current model was loaded. May be null if, for example, this is a new model.
Attributes
- Inherited from:
- ModelTracker
- Source
- ModelTracker.scala
Attributes
- Inherited from:
- ModelTracker
- Source
- ModelTracker.scala
returns the full pathname of the currently loaded model, if any. This may return null in some cases, for instance if this is a new model.
returns the full pathname of the currently loaded model, if any. This may return null in some cases, for instance if this is a new model.
Attributes
- Inherited from:
- ModelTracker
- Source
- ModelTracker.scala
Attributes
- Inherited from:
- ModelTracker
- Source
- ModelTracker.scala
Attributes
- Inherited from:
- Plotting
- Source
- Plotting.scala
Attributes
- Returns
-
plotCompilationErrorAction action to take if a plot compilation error occurs
- Definition Classes
- Inherited from:
- AbstractWorkspaceScala
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- AbstractWorkspaceScala
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- Compiling
- Source
- Compiling.scala
Attributes
- Definition Classes
- Inherited from:
- Checksums
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- HubNetManager
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- HubNetManager
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- HubNetManager
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- AbstractWorkspaceScala
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Definition Classes
- Inherited from:
- Procedures
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- Compiling
- Source
- Compiling.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- Compiling
- Source
- Compiling.scala
Attributes
- Inherited from:
- Compiling
- Source
- Compiling.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- AbstractWorkspaceScala
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- AbstractWorkspaceScala
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- ModelTracker
- Source
- ModelTracker.scala
Attributes
- Inherited from:
- ModelTracker
- Source
- ModelTracker.scala
Attributes
- Inherited from:
- Workspace
- Source
- Workspace.scala
Attributes
- Inherited from:
- Workspace
- Source
- Workspace.scala
Attributes
- Inherited from:
- Workspace
- Source
- Workspace.scala
Attributes
- Inherited from:
- Workspace
- Source
- Workspace.scala
Attributes
- Inherited from:
- Controllable
- Source
- Controllable.scala
Attributes
- Inherited from:
- Workspace
- Source
- Workspace.scala
Attributes
- Inherited from:
- APIConformant
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- APIConformant
- Source
- AbstractWorkspaceScala.scala
Attributes
- Definition Classes
- Inherited from:
- Procedures
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- Procedures
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- Traceable
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- Traceable
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- Compiling
- Source
- Compiling.scala
Runs a NetLogo reporter.
Runs a NetLogo reporter.
Value parameters
- source
-
The reporter to run
Attributes
- Returns
-
the result reported; may be of type java.lang.Integer, java.lang.Double, java.lang.Boolean, java.lang.String,
[[org.nlogo.core.LogoList]]
,[[org.nlogo.api.Agent]]
, AgentSet, or Nobody - Throws
-
org.nlogo.api.LogoException
if the code fails to run
org.nlogo.core.CompilerExceptionif the code fails to compile
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- AbstractWorkspaceScala
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- AbstractWorkspaceScala
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- BehaviorSpaceInformation
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- ModelTracker
- Source
- ModelTracker.scala
Attributes
- Inherited from:
- ModelTracker
- Source
- ModelTracker.scala
Attributes
- Inherited from:
- AbstractWorkspace
Value parameters
- plotCompilationErrorAction
-
action to take if a plot compilation error occurs Throw - Throw the first error Output - Output all errors Ignore - Do nothing
Attributes
- Definition Classes
- Inherited from:
- AbstractWorkspaceScala
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Definition Classes
- Inherited from:
- Procedures
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- Traceable
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- Plotting
- Source
- Plotting.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- AbstractWorkspaceScala
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- Compiling
- Source
- Compiling.scala
Attributes
- Inherited from:
- Compiling
- Source
- Compiling.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- Plotting
- Source
- Plotting.scala
Attributes
- Inherited from:
- Workspace
- Source
- Workspace.scala
Attributes
- Inherited from:
- Workspace
- Source
- Workspace.scala
Attributes
- Inherited from:
- Workspace
- Source
- Workspace.scala
Attributes
- Inherited from:
- Workspace
- Source
- Workspace.scala
Attributes
- Inherited from:
- Workspace
- Source
- Workspace.scala
Attributes
- Inherited from:
- Workspace
- Source
- Workspace.scala
Attributes
- Inherited from:
- Workspace
- Source
- Workspace.scala
Attributes
- Inherited from:
- Workspace
- Source
- Workspace.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Definition Classes
- Inherited from:
- Checksums
- Source
- AbstractWorkspaceScala.scala
Concrete fields
Attributes
- Source
- HeadlessWorkspace.scala
Attributes
- Source
- HeadlessWorkspace.scala
Internal use only.
Attributes
- Source
- HeadlessWorkspace.scala
Internal use only.
Attributes
- Source
- HeadlessWorkspace.scala
Attributes
- Source
- HeadlessWorkspace.scala
If true, don't send anything to standard output.
Inherited fields
Attributes
- Inherited from:
- BehaviorSpaceInformation
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- BehaviorSpaceInformation
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- BehaviorSpaceInformation
- Source
- AbstractWorkspaceScala.scala
name of the currently loaded model. Will be null if this is a new (unsaved) model. To get a version for display to the user, see modelNameForDisplay(). This is NOT a full path name, however, it does end in ".nlogo".
name of the currently loaded model. Will be null if this is a new (unsaved) model. To get a version for display to the user, see modelNameForDisplay(). This is NOT a full path name, however, it does end in ".nlogo".
Attributes
- Inherited from:
- ModelTracker
- Source
- ModelTracker.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- APIConformant
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- ModelTracker
- Source
- ModelTracker.scala
Attributes
- Inherited from:
- AbstractWorkspace
Attributes
- Inherited from:
- Evaluating
- Source
- Evaluating.scala
lastRunTimes is used by every
to track how long ago a job ran
lastRunTimes is used by every
to track how long ago a job ran
Attributes
- Inherited from:
- AbstractWorkspaceScala
- Source
- AbstractWorkspaceScala.scala
Attributes
- Inherited from:
- Plotting
- Source
- Plotting.scala
Attributes
- Inherited from:
- Plotting
- Source
- Plotting.scala
Attributes
- Inherited from:
- Plotting
- Source
- Plotting.scala
Attributes
- Inherited from:
- AbstractWorkspaceScala
- Source
- AbstractWorkspaceScala.scala