NetLogo 6.2.2 - org.nlogo.core
Keywords: NetLogo 6.2.2 org.nlogo.core

NetLogo6.2.2 < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package org
  Definition Classes
    root
-  package nlogo
  Definition Classes
    org
-  package agent
  Definition Classes
    nlogo
-  package api

  Provides classes associated with the NetLogo Extensions API and Controlling API.

  Provides classes associated with the NetLogo Extensions API and Controlling API.

  For discussion and sample code, please see the NetLogo User Manual.

  Definition Classes
    nlogo
-  package app
  Definition Classes
    nlogo
-  package core
  Definition Classes
    nlogo
-  package model
- AgentKind
- AgentKindJ
- AgentVariableSet
- AgentVariables
- AllShapesReplaced
- Application
- AstFolder
- AstNode
- AstTransformer
- AstVisitor
- BoxedValue
- Breed
- BreedIdentifierHandler
- Button
- Chooseable
- ChooseableBoolean
- ChooseableDouble
- ChooseableList
- ChooseableString
- Chooser
- ClosedLambdaVariable
- ClosedLet
- ClosedVariable
- Color
- ColorConstants
- Command
- CommandBlock
- CompilationEnvironment
- CompilationOperand
- CompilerException
- CompilerUtilitiesInterface
- ConstraintSpecification
- DeclaresConstraint
- DeclaresGlobal
- DeclaresGlobalCommand
- DefaultTokenMapper
- Dialect
- Direction
- DummyCompilationEnvironment
- DummyExtensionManager
- DummyLibraryManager
- Dump
- ErrorSource
- Expression
- ExtensionManager
- ExtensionObject
- Fail
- Femto
- File
- FileMode
- FileModeJ
- FrontEndInterface
- FrontEndProcedure
- Horizontal
- I18N
- I18NJava
- InputBox
- Instantiator
- Instruction
- Keywords
- Let
- LibraryInfo
- LibraryManager
- LibraryStatus
- LiteralImportHandler
- LiteralParser
- LogoList
- LowPriorityDialect
- Model
- ModelInfo
- Monitor
- NamedWidget
- NetLogoCore
- Nobody
- NumberParser
- NumericInput
- OptionalSection
- Output
- Pen
- Plot
- PlotPenInterface
- PlotPenState
- Primitive
- PrimitiveCommand
- PrimitiveReporter
- ProcedureDefinition
- ProcedureSyntax
- Program
- Pure
- Reference
- Referenceable
- Reporter
- ReporterApp
- ReporterBlock
- Resource
- Shape
- ShapeAdded
- ShapeEvent
- ShapeList
- ShapeListTracker
- ShapeParser
- ShapeRemoved
- ShapesAdded
- Slider
- SourceLocatable
- SourceLocation
- SourceRelocatable
- SourceRewriter
- SourceWrapping
- Statement
- Statements
- StringEscaper
- StringInput
- StructureDeclarations
- StructureResults
- Switch
- Syntax
- SyntaxJ
- TextBox
- Token
- TokenColorizer
- TokenHolder
- TokenMapper
- TokenMapperInterface
- TokenType
- TokenTypeJ
- TokenizerInterface
- TypeNames
- UpdateMode
- UpdateModeJ
- VersionUtils
- Vertical
- View
- Widget
- WorldDimensions
-  package editor

  Provides classes associated with the NetLogo Editor

  Provides classes associated with the NetLogo Editor

  Shouldn't depend on any other netlogo packages besides `org.nlogo.core`

  Definition Classes
    nlogo
-  package fileformat
  Definition Classes
    nlogo
-  package headless
  Definition Classes
    nlogo
-  package ide
  Definition Classes
    nlogo
-  package lite
  Definition Classes
    nlogo
-  package nvm
  Definition Classes
    nlogo
-  package render
  Definition Classes
    nlogo
-  package util
  Definition Classes
    nlogo
-  package workspace
  Definition Classes
    nlogo

p

org.nlogo

# core 

#### package core

 
Ordering

1. Alphabetic

Visibility

1. Public
2. All

### Type Members

1.  sealed trait AgentKind extends Product with Serializable
2.  trait AgentVariableSet extends AnyRef
3.  case class AllShapesReplaced(oldShapeList: ShapeList, newShapeList: ShapeList) extends ShapeEvent with Product with Serializable
4.  trait Application extends AstNode

   represents an application, in the abstract (either a reporter application of a command application).

   represents an application, in the abstract (either a reporter application of a command application). This is used when parsing arguments, when we don't care what kind of application the args are for.

5.  trait AstFolder[A] extends AnyRef
6.  trait AstNode extends SourceLocatable

   An interface representing a node in the NetLogo abstract syntax tree (AKA parse tree, in NetLogo's case).

   An interface representing a node in the NetLogo abstract syntax tree (AKA parse tree, in NetLogo's case).

   Each AstNode, even if synthesized, should correspond to some particular source fragment, as indicated by the position and length. It's the compiler's job to make sure these values are always reasonable.

7.  trait AstTransformer extends AnyRef

   Transforms an AST to allow changes without mutation

8.  trait AstVisitor extends AnyRef

   The default AST tree-walker.

   The default AST tree-walker. This simply visits each node of the tree, and visits any children of each node in turn. Subclasses can implement pre-order or post-order traversal, or a wide range of other strategies.

9.  sealed trait BoxedValue extends AnyRef
10.  case class Breed(name: String, singular: String, originalName: String, originalSingular: String, owns: Seq[String] = Seq(), isLinkBreed: Boolean = false, isDirected: Boolean = false) extends Product with Serializable
11.  case class Button(source: Option[String], left: Int, top: Int, right: Int, bottom: Int, display: Option[String] = None, forever: Boolean = false, buttonKind: AgentKind = AgentKind.Observer, actionKey: Option[Char] = None, disableUntilTicksStart: Boolean = false) extends Widget with Product with Serializable
12.  sealed trait Chooseable extends AnyRef
13.  case class ChooseableBoolean(value: Boolean) extends Chooseable with Product with Serializable
14.  case class ChooseableDouble(value: Double) extends Chooseable with Product with Serializable
15.  case class ChooseableList(value: LogoList) extends Chooseable with Product with Serializable
16.  case class ChooseableString(value: String) extends Chooseable with Product with Serializable
17.  case class Chooser(variable: Option[String], left: Int = 0, top: Int = 0, right: Int = 0, bottom: Int = 0, display: Option[String] = None, choices: List[Chooseable] = Nil, currentChoice: Int = 0) extends Widget with DeclaresGlobal with DeclaresGlobalCommand with DeclaresConstraint with Product with Serializable
18.  case class ClosedLambdaVariable(name: String) extends ClosedVariable with Product with Serializable
19.  case class ClosedLet(let: Let) extends ClosedVariable with Product with Serializable
20.  sealed trait ClosedVariable extends AnyRef
21.  trait Color extends AnyRef
22.  trait Command extends Instruction
23.  class CommandBlock extends Expression

    represents a block containing zero or more statements.

    represents a block containing zero or more statements. Called a command block rather than a statement block for consistency with usual NetLogo jargon. Note that this is an Expression, and as such can be an argument to commands and reporters, etc.

24.  trait CompilationEnvironment extends AnyRef
25.  case class CompilationOperand(sources: Map[String, String], extensionManager: ExtensionManager, libraryManager: LibraryManager, compilationEnvironment: CompilationEnvironment, containingProgram: Program = Program.empty, oldProcedures: ProceduresMap = NoProcedures, subprogram: Boolean = true, displayName: Option[String] = None, shouldAutoInstallLibs: Boolean = false) extends Product with Serializable
26.  class CompilerException extends RuntimeException

    Exception thrown by various methods that accept NetLogo code as input and cause that code to be compiled; indicates the code was invalid.

    Exception thrown by various methods that accept NetLogo code as input and cause that code to be compiled; indicates the code was invalid. May be inspected to discover the location and nature of the error.

27.  trait CompilerUtilitiesInterface extends LiteralParser
28.  sealed trait ConstraintSpecification extends AnyRef
29.  trait DeclaresConstraint extends NamedWidget
30.  trait DeclaresGlobal extends NamedWidget
31.  trait DeclaresGlobalCommand extends NamedWidget
32.  trait Dialect extends LowPriorityDialect
33.  sealed trait Direction extends AnyRef
34.  class DummyCompilationEnvironment extends CompilationEnvironment
35.  class DummyExtensionManager extends ExtensionManager
36.  class DummyLibraryManager extends LibraryManager
37.  trait Dump extends AnyRef
38.  class ErrorSource extends AnyRef
39.  trait Expression extends AstNode

    represents a NetLogo expression.

    represents a NetLogo expression. An expression is either a block or a reporter application (variable references and constants (including lists), are turned into reporter applications).

40.  trait ExtensionManager extends AnyRef
41.  trait ExtensionObject extends AnyRef

    Interface which all NetLogo objects defined in Extensions must support

42.  abstract class File extends AnyRef
43.  sealed trait FileMode extends AnyRef
44.  trait FrontEndInterface extends AnyRef
45.  trait FrontEndProcedure extends AnyRef
46.  trait I18NJava extends AnyRef

    The Scala compiler won't generate a Java varargs forwarder for a Scala varargs method unless the method comes from a Java class or interface.

    The Scala compiler won't generate a Java varargs forwarder for a Scala varargs method unless the method comes from a Java class or interface. So this is in Java to be implemented from Scala by I18N.BundleKind.

47.  case class InputBox(variable: Option[String], left: Int = 0, top: Int = 0, right: Int = 0, bottom: Int = 0, boxedValue: BoxedValue = ...) extends Widget with DeclaresGlobal with DeclaresGlobalCommand with DeclaresConstraint with Product with Serializable
48.  trait Instruction extends TokenHolder
49.  case class Let(name: String = null) extends Product with Serializable
50.  case class LibraryInfo(name: String, codeName: String, shortDescription: String, longDescription: String, version: String, homepage: URL, downloadURL: URL, bundled: Boolean, installedVersionOpt: Option[String], minNetLogoVersion: Option[String]) extends Product with Serializable
51.  trait LibraryManager extends AnyRef
52.  sealed trait LibraryStatus extends AnyRef
53.  trait LiteralImportHandler extends AnyRef
54.  trait LiteralParser extends AnyRef
55.  class LogoList extends IndexedSeq[AnyRef] with Serializable
56.  trait LowPriorityDialect extends AnyRef
57.  case class Model(code: String = "", widgets: Seq[Widget] = List(View()), info: String = "", version: String = "NetLogo 6.2", turtleShapes: Seq[VectorShape] = Model.defaultShapes, linkShapes: Seq[LinkShape] = Model.defaultLinkShapes, optionalSections: Seq[OptionalSection[_]] = Seq()) extends Product with Serializable
58.  case class ModelInfo(title: String, tags: Seq[String]) extends Product with Serializable
59.  case class Monitor(source: Option[String], left: Int, top: Int, right: Int, bottom: Int, display: Option[String], precision: Int, fontSize: Int = 11) extends Widget with Product with Serializable
60.  trait NamedWidget extends AnyRef
61.  case class NumericInput(value: Double, label: NumericKind) extends BoxedValue with Product with Serializable
62.  class OptionalSection[A <: AnyRef] extends AnyRef
63.  case class Output(left: Int, top: Int, right: Int, bottom: Int, fontSize: Int) extends Widget with Product with Serializable
64.  case class Pen(display: String, interval: Double = 1, mode: Int = 0, color: Int = 0, inLegend: Boolean = false, setupCode: String = "", updateCode: String = "") extends Product with Serializable
65.  case class Plot(display: Option[String], left: Int = 0, top: Int = 0, right: Int = 5, bottom: Int = 5, xAxis: Option[String] = None, yAxis: Option[String] = None, xmin: Double = 0, xmax: Double = 0, ymin: Double = 0, ymax: Double = 0, autoPlotOn: Boolean = true, legendOn: Boolean = false, setupCode: String = "", updateCode: String = "", pens: List[Pen] = Nil) extends Widget with Product with Serializable
66.  case class PlotPenState(x: Double = 0.0, color: Int = java.awt.Color.BLACK.getRGB, interval: Double = 1.0, mode: Int = PlotPenInterface.LineMode, isDown: Boolean = true, hidden: Boolean = false) extends Product with Serializable
67.  trait Primitive extends AnyRef

    Top-level interface for primitives (commands or reporters).

    Top-level interface for primitives (commands or reporters). Not to be implemented directly; the `Command` or `Reporter` interface should be used instead.

    See also

      Command

      Reporter

68.  trait PrimitiveCommand extends Primitive
69.  trait PrimitiveReporter extends Primitive
70.  class ProcedureDefinition extends AstNode

    represents a single procedure definition.

    represents a single procedure definition. really just a container for the procedure body, which is a Statements object.

71.  case class ProcedureSyntax(declarationKeyword: Token, identifier: Token, endKeyword: Token) extends Product with Serializable
72.  case class Program(interfaceGlobals: Seq[String] = Seq(), userGlobals: Seq[String] = Seq(), turtleVars: ListMap[String, Int] = ListMap(), patchVars: ListMap[String, Int] = ListMap(), linkVars: ListMap[String, Int] = ListMap(), breeds: ListMap[String, Breed] = ListMap(), linkBreeds: ListMap[String, Breed] = ListMap(), dialect: Dialect = NetLogoCore) extends Product with Serializable
73.  trait Pure extends AnyRef
74.  case class Reference(kind: AgentKind, vn: Int, original: TokenHolder) extends Product with Serializable
75.  trait Referenceable extends AnyRef
76.  trait Reporter extends Instruction
77.  class ReporterApp extends Application with Expression

    represents a reporter application.

    represents a reporter application. This is the typical kind of NetLogo expression, things like "round 5" and "3 + 4". However, this class also represents things like constants, which are converted into no-arg reporter applications as they're parsed.

78.  class ReporterBlock extends Expression

    represents a block containing exactly one expression.

    represents a block containing exactly one expression. Called a reporter block rather than an expression block for consistency with usual NetLogo jargon. Note that this is an Expression, and as such can be an argument to commands and reporters, etc. However, it is a different expression from the expression it contains... Its "blockness" is significant.

79.  sealed trait Shape extends AnyRef
80.  case class ShapeAdded(newShape: Shape, oldValue: Option[Shape], newShapeList: ShapeList) extends ShapeEvent with Product with Serializable
81.  sealed trait ShapeEvent extends AnyRef
82.  case class ShapeList(kind: AgentKind, shapeMap: Map[String, Shape]) extends Product with Serializable
83.  class ShapeListTracker extends Publisher[ShapeEvent]
84.  case class ShapeRemoved(removedShape: Shape, newShapeList: ShapeList) extends ShapeEvent with Product with Serializable
85.  case class ShapesAdded(addedShapes: Map[String, Shape], newShapeList: ShapeList) extends ShapeEvent with Product with Serializable
86.  case class Slider(variable: Option[String], left: Int = 0, top: Int = 0, right: Int = 0, bottom: Int = 0, display: Option[String] = None, min: String = "0", max: String = "100", default: Double = 1, step: String = "1", units: Option[String] = None, direction: Direction = Horizontal) extends Widget with DeclaresGlobal with DeclaresGlobalCommand with DeclaresConstraint with Product with Serializable
87.  trait SourceLocatable extends AnyRef
88.  case class SourceLocation(start: Int, end: Int, filename: String) extends Product with Serializable
89.  trait SourceRelocatable[T] extends SourceLocatable
90.  trait SourceRewriter extends AnyRef
91.  class Statement extends Application

    represents a NetLogo statement.

    represents a NetLogo statement. Statements only have one form: command application.

92.  class Statements extends AstNode

    represents a chunk of zero or more NetLogo statements.

    represents a chunk of zero or more NetLogo statements. Note that this is not necessarily a "block" of statements, as block means something specific (enclosed in [], in particular). This class is used to represent other groups of statements as well, for instance procedure bodies. nonLocalExit identifies that the statements contain one or more commands (possibly nested) which may cause a non-local exit (like `stop` or `report`)

93.  case class StringInput(value: String, label: StringKind, multiline: Boolean) extends BoxedValue with Product with Serializable
94.  case class StructureResults(program: Program, procedures: ProceduresMap = NoProcedures, procedureTokens: Map[String, Iterable[Token]] = Map(), includes: Seq[Token] = Seq(), includedSources: Seq[String] = Seq(), extensions: Seq[Token] = Seq()) extends Product with Serializable
95.  case class Switch(variable: Option[String], left: Int = 0, top: Int = 0, right: Int = 0, bottom: Int = 0, display: Option[String] = None, on: Boolean = false) extends Widget with DeclaresGlobal with DeclaresGlobalCommand with DeclaresConstraint with Product with Serializable
96.  case class Syntax extends Product with Serializable

    Specifies the arguments accepted by a primitive.

    Specifies the arguments accepted by a primitive. Used by the compiler for type-checking.

    You cannot instantiate this class directly. Instead, use the static construction methods `Syntax.commandSyntax(...)` or `Syntax.reporterSyntax(...)`.

    For example, in a `Reporter` that takes two number arguments and returns a boolean, implement `Primitive.getSyntax()` as follows:

        public Syntax getSyntax() {
          return Syntax.reporterSyntax(
            new int[] { Syntax.NumberType(), Syntax.NumberType() },
            Syntax.BooleanType());
        }

    An input can be made variadic, meaning that it can be repeated any number of times when enclosed in parentheses, if you add the `RepeatableType` flag. When using variadic inputs you should also define the default number of inputs, that is, the number of inputs expect if the user does not use parentheses. For example:

         public Syntax getSyntax() {
           return Syntax.reporterSyntax(
             new int[] { Syntax.WildcardType() | Syntax.RepeatableType() },
             Syntax.ListType(), 2);
         }

    See also

      Primitive#getSyntax()

97.  case class TextBox(display: Option[String], left: Int = 0, top: Int = 0, right: Int = 5, bottom: Int = 5, fontSize: Int, color: Double, transparent: Boolean = false) extends Widget with Product with Serializable
98.  case class Token(text: String, tpe: TokenType, value: AnyRef)(sourceLocation: SourceLocation) extends SourceLocatable with Product with Serializable
99.  trait TokenColorizer extends AnyRef
100.  trait TokenHolder extends AnyRef
101.  class TokenMapper extends TokenMapperInterface
102.  trait TokenMapperInterface extends AnyRef
103.  sealed trait TokenType extends AnyRef
104.  trait TokenizerInterface extends AnyRef
105.  sealed abstract class UpdateMode extends Serializable
106.  case class View(left: Int = 0, top: Int = 0, right: Int = 5, bottom: Int = 5, dimensions: WorldDimensions = View.defaultDimensions, fontSize: Int = 13, updateMode: UpdateMode = UpdateMode.TickBased, showTickCounter: Boolean = true, tickCounterLabel: Option[String] = Some("ticks"), frameRate: Double = 30) extends Widget with Product with Serializable
107.  trait Widget extends AnyRef
108.  case class WorldDimensions(minPxcor: Int, maxPxcor: Int, minPycor: Int, maxPycor: Int, patchSize: Double = 12.0, wrappingAllowedInX: Boolean = true, wrappingAllowedInY: Boolean = true) extends Product with Serializable

### Value Members

1.  object AgentKind extends Serializable
2.  object AgentKindJ

   Java can't (I don't think) access Scala inner objects without reflection, so we provide these convenience vals for use from Java.

3.  object AgentVariables extends AgentVariableSet
4.  object BoxedValue
5.  object BreedIdentifierHandler
6.  object Chooseable
7.  object Color extends Color
8.  object ColorConstants
9.  object CompilerException extends Serializable
10.  object ConstraintSpecification
11.  object DefaultTokenMapper extends TokenMapper
12.  object Dialect extends LowPriorityDialect
13.  object Dump extends Dump
14.  object Fail
15.  object Femto
16.  object FileMode
17.  object FileModeJ

    Java can't (I don't think) access Scala inner objects without reflection, so we provide these convenience vals for use from Java.

18.  object FrontEndInterface
19.  object Horizontal extends Direction with Product with Serializable
20.  object I18N
21.  object InputBox extends Serializable
22.  object Instantiator
23.  object Keywords
24.  object LibraryInfo extends Serializable
25.  object LibraryStatus
26.  object LiteralImportHandler
27.  object LogoList extends Serializable
28.  object Model extends Serializable
29.  object ModelInfo extends Serializable
30.  object NetLogoCore extends Dialect with Product with Serializable
31.  object Nobody
32.  object NumberParser
33.  object NumericInput extends Serializable
34.  object PlotPenInterface
35.  object Program extends Serializable
36.  object ReporterApp
37.  object ReporterBlock
38.  object Resource
39.  object Shape
40.  object ShapeList extends Serializable
41.  object ShapeParser
42.  object SourceWrapping
43.  object Statement
44.  object StringEscaper
45.  object StringInput extends Serializable
46.  object StructureDeclarations
47.  object StructureResults extends Serializable
48.  object Syntax extends Serializable
49.  object SyntaxJ

    Legacy convenience methods for constructing Syntax objects, for use by extensions written in Java.

50.  object Token extends Serializable
51.  object TokenType
52.  object TokenTypeJ
53.  object TypeNames
54.  object UpdateMode extends Serializable
55.  object UpdateModeJ

    Java can't (I don't think) access Scala inner objects without reflection, so we provide these convenience vals for use from Java.

56.  object VersionUtils
57.  object Vertical extends Direction with Product with Serializable
58.  object View extends Serializable

### Ungrouped