api

Type Members

1. trait Action extends AnyRef

   

2. trait ActionBroker[A <: Action] extends Publisher[A]

   

3. class ActionBuffer[A <: Action] extends Subscriber[A, Publisher[A]]

   

   An ActionBuffer logs all actions generated by the supplied ActionBroker.

   An ActionBuffer logs all actions generated by the supplied ActionBroker. Actions can be grabbed (which clears the buffer) and the buffer can be cleared independently. NP 2013-01-25.

4. trait ActionRunner[A <: Action] extends AnyRef

   

5. trait Activation extends AnyRef

   

   A representation of the currently executing procedure

6. trait Agent extends AnyRef

   

   NetLogo agents include turtles, patches, links and the observer.

7. class AgentException extends Exception

   

8. trait AgentFollowingPerspective extends AnyRef

   

9. trait AgentSet extends AnyRef

   

   Interface provides access to NetLogo agentsets.

   Interface provides access to NetLogo agentsets. NetLogo agentsets may be composed of turtles, patches, or links (but an agentset may not contain a mix of different agent types.)

   In order to perform some functions on AgentSets you may need to cast to org.nlogo.agent.AgentSet.

10. final class AgentVariableNumbers extends AnyRef

    

11. trait AggregateManagerInterface extends SourceOwner with ModelSaveable

    

12. trait AnonymousCommand extends AnonymousProcedure

    

13. sealed trait AnonymousProcedure extends AnyRef

    

14. trait AnonymousReporter extends AnonymousProcedure

    

15. trait Argument extends AnyRef

    

    Interface provides access to arguments passed to the perform or report methods of a primitive at run-time.

    Interface provides access to arguments passed to the perform or report methods of a primitive at run-time.

    Arguments are created by NetLogo and passed to the perform or report methods of your primitive.

    See also

    Reporter#report(Argument[], Context)

    Command#perform(Argument[], Context)

16. trait AutoConvertable extends AnyRef

    

17. trait AutoConverter extends AnyRef

    

18. class CSV extends AnyRef

    

19. trait ClassManager extends AnyRef

    

20. trait Command extends PrimitiveCommand

    

    Interface for NetLogo extension commands.

    Interface for NetLogo extension commands. Commands are primitives that do not return a value. All new commands must implement this interface.

21. trait CommandLogoThunk extends AnyRef

    

22. trait CommandRunnable extends AnyRef

    

23. trait CompilerServices extends LiteralParser

    

24. trait ComponentSerialization[A, B <: ModelFormat[A, _]] extends AutoConvertable

    

25. class ConfigurableModelLoader extends ModelLoader

    

26. trait Context extends AnyRef

    

    Provides access to the current execution environment.

27. trait Controllable extends AnyRef

    

    Interface provides access to the NetLogo controlling API's report and command methods found in methods independent of App.app and headless.HeadlessWorkspace.

    Interface provides access to the NetLogo controlling API's report and command methods found in methods independent of App.app and headless.HeadlessWorkspace. This is useful for making java software that can run NetLogo in both GUI and Headless mode.

28. abstract class DefaultClassManager extends ClassManager

    

29. trait DelegatingMapper extends TokenMapperInterface

    

30. trait Drawing3D extends AnyRef

    

31. trait DrawingInterface extends AnyRef

    

32. trait DrawingLine3D extends AnyRef

    

33. class DummyCompilerServices extends CompilerServices

    

34. trait DummyEditable extends Editable with DummyErrorHandler

    

35. trait DummyErrorHandler extends AnyRef

    

36. class DummyExtensionManager extends core.DummyExtensionManager with ExtensionManager

    

37. class DummyLogoThunkFactory extends LogoThunkFactory

    

38. trait Editable extends AnyRef

    

39. trait EditorAreaInterface extends AnyRef

    

40. case class EnumeratedValueSet(variableName: String, values: List[Any]) extends ValueSet with Product with Serializable

    

41. class ExtensionException extends Exception

    

    Wrapper class for exceptions thrown by NetLogo extensions.

42. trait ExtensionManager extends core.ExtensionManager

    

    ExtensionManager provides some methods that can be used in runOnce

    ExtensionManager provides some methods that can be used in runOnce

43. class FormatterPair[A, B <: ModelFormat[A, B]] extends AnyRef

    

44. class Graphics2DWrapper extends GraphicsInterface

    

45. trait GraphicsInterface extends AnyRef

    

46. trait HubNetInterface extends ViewInterface with ModelSaveable

    

47. trait HubNetWorkspaceInterface extends CompilerServices

    

48. trait I18NJava extends AnyRef

    

49. trait ImportErrorHandler extends AnyRef

    

50. trait ImporterUser extends WorldResizer

    

51. trait JobOwner extends SourceOwner

    

    Like source owners, job owners are usually parts of the UI.

    Like source owners, job owners are usually parts of the UI. Jobs are initiated by by buttons, by monitors, by the Command Center, and so on.

    The (assorted, disparate) methods here in JobOwner have mainly to do with runtime behavior and/or runtime error handling. (SourceOwner is more about compilation and compile-time errors.)

52. case class LabProtocol(name: String, setupCommands: String, goCommands: String, finalCommands: String, repetitions: Int, runMetricsEveryStep: Boolean, timeLimit: Int, exitCondition: String, metrics: List[String], valueSets: List[ValueSet]) extends Product with Serializable

    

53. trait Link extends Agent

    

    Interface provides access to NetLogo links.

54. trait Link3D extends Link

    

55. trait LinkStamp3D extends Link3D

    

56. class LocalFile extends File

    

57. trait Logger extends AnyRef

    

58. abstract class LogoException extends RuntimeException

    

    A runtime error that has occurred in NetLogo code.

    A runtime error that has occurred in NetLogo code.

    As with any Exception, use the getMessage() method to get the error message. A LogoExceptions is expected to have a nice end-user-understandable message.

    LogoException is abstract because engine code is supposed to throw a concrete subclass like EngineException.

59. class LogoHashObject extends AnyRef

    

60. class LogoListBuilder extends AnyRef

    

61. trait LogoThunkFactory extends AnyRef

    

62. class Matrix3D extends AnyRef

    

63. final class MersenneTwisterFast extends Random with Serializable with Cloneable

    

64. trait ModelFormat[Section, Format <: ModelFormat[Section, _]] extends AnyRef

    

65. trait ModelLoader extends AnyRef

    

66. trait ModelRun extends AnyRef

    

67. sealed trait ModelSection extends AnyRef

    

68. trait ModelSections extends AnyRef

    

69. case class ModelSettings(snapToGrid: Boolean) extends Product with Serializable

    

70. sealed trait ModelType extends AnyRef

    

    how a model was loaded.

    how a model was loaded. NEW is type for new models, NORMAL is a model opened normally (e.g. via Open on the File menu), LIBRARY a models library model.

71. trait ModelingCommonsInterface extends AnyRef

    

72. trait MultiErrorHandler extends AnyRef

    

73. trait NetLogoAdapter extends NetLogoListener

    

    Implements NetLogoListener with empty methods, which can be overriden in subclasses.

74. trait NetLogoListener extends EventListener

    

    A host application should implement this interface in order to be notified of events occurring within NetLogo.

    A host application should implement this interface in order to be notified of events occurring within NetLogo. Its methods are called by NetLogoListenerManager when these events occur. The events are typically user actions, but may also be triggered programmatically by the model.

75. trait Observer extends Agent

    

76. trait ObserverOrientation extends AnyRef

    

77. class Options[T] extends AnyRef

    

78. sealed trait OutputDestination extends AnyRef

    

79. trait Patch extends Agent

    

    Provides access to NetLogo patches.

80. trait Patch3D extends Patch

    

81. sealed abstract class Perspective extends AnyRef

    

82. class PerspectiveJ extends AnyRef

    

83. sealed trait PlotAction extends Action

    

84. trait PlotInterface extends AnyRef

    

85. trait PlotManagerInterface extends AnyRef

    

86. case class PlotState(autoPlotOn: Boolean = true, xMin: Double = 0, xMax: Double = 10, yMin: Double = 0, yMax: Double = 10) extends Product with Serializable

    

87. sealed trait PreviewCommands extends ModelSaveable

    

    A model's "preview commands" are the commands that are used to generate the preview that appears in the Models Library dialog, the NetLogo website (http://ccl.northwestern.edu/netlogo/models/), the Modeling Commons (http://www.modelingcommons.org/) and potentially other places.

    A model's "preview commands" are the commands that are used to generate the preview that appears in the Models Library dialog, the NetLogo website (http://ccl.northwestern.edu/netlogo/models/), the Modeling Commons (http://www.modelingcommons.org/) and potentially other places. By default, they're just setup repeat 75 [ go ] but they can be customized. Some models require manually generated previews.

    Preview commands are always run in a fresh headless workspace with random-seed 0 called before opening the model. The startup procedure, if present, runs before the preview commands.

88. trait PrimitiveManager extends AnyRef

    

    Ships extension primitives and associated names to NetLogo.

89. case class Property(accessString: String, tpe: Type, name: String, notes: String = "", gridWidth: Int = GridBagConstraints.REMAINDER, focus: Boolean = false, setLive: Boolean = false, enabled: Boolean = true, collapsible: Boolean = false, collapseByDefault: Boolean = false) extends Product with Serializable

    

90. trait Protractor extends AnyRef

    

91. trait Protractor3D extends Protractor

    

92. trait RandomServices extends AnyRef

    

93. class RemoteFile extends File

    

94. trait RendererInterface extends AnyRef

    

95. trait Reporter extends PrimitiveReporter

    

    Interface for NetLogo reporters.

    Interface for NetLogo reporters. Reporters are primitives that return a value. All new reporters must implement this interface.

96. trait ReporterLogoThunk extends AnyRef

    

    This is used by SliderConstraint.

    This is used by SliderConstraint. Sliders have snippets of Logo code associated with them, which need be to be evaluated to produce numbers for the min, max, and increment. But here in the org.nlogo.agent package we don't know anything about Logo code and how to run it. This interface lets other code keep us in the dark by giving us a black box that magically produces an object whenever we ask for one. (In the case of SliderConstraint the object should be a boxed double.)

97. trait ReporterRunnable[T] extends AnyRef

    

98. class SimpleChangeEventPublisher extends Publisher[SimpleChangeEvent.type]

    

    A most basic event publisher only warning subscribers that "something has changed" Currently used by TreeAgentSet to allow the nw extension to listen for changes and update its graph context accordingly.

    A most basic event publisher only warning subscribers that "something has changed" Currently used by TreeAgentSet to allow the nw extension to listen for changes and update its graph context accordingly. NP 2013-05-14.

99. class SimpleJobOwner extends JobOwner

    

100. trait SingleErrorHandler extends AnyRef

     

101. trait SourceOwner extends AnyRef

     

     Source owners are usually parts of the UI.

     Source owners are usually parts of the UI. Code comes from buttons, from monitors, from the Code tab, from the Command Center, and so on.

     SourceOwner has mainly to do with compilation and with what to do if an error occurs during compilation.

     "Header source" is distinguished from "inner source" because the latter is the code the user actually wrote, while header and footer source is extra code we wrapped around it. This matters when showing code and showing positions of errors in the UI; we never want to show the user header/footer source, but error locations need to take the length of the header source into account.

     See also JobOwner, which extends SourceOwner and adds methods having to do with runtime behavior and runtime error-handling.

102. case class SteppedValueSet(variableName: String, firstValue: BigDecimal, step: BigDecimal, lastValue: BigDecimal) extends ValueSet with Product with Serializable

     

103. class Timer extends AnyRef

     

104. trait TokenHolder extends AnyRef

     

105. trait TokenizerInterface extends AnyRef

     

106. trait TrailDrawerInterface extends DrawingInterface

     

107. trait Turtle extends Agent

     

     Interface provides access to NetLogo turtles.

108. trait Turtle3D extends Turtle

     

109. trait TurtleStamp3D extends Turtle3D

     

110. trait ValueConstraint extends AnyRef

     

     Interface for objects which provide constraints for values

111. sealed trait ValueSet extends Iterable[Any]

     

112. case class Vect(x: Double, y: Double, z: Double) extends Product with Serializable

     

113. trait Version extends AnyRef

     

114. trait ViewInterface extends AnyRef

     

115. trait ViewSettings extends AnyRef

     

116. trait Workspace extends ImporterUser with LiteralParser with RandomServices with ViewSettings with Controllable

     

117. trait World extends AnyRef

     

118. trait World3D extends World

     

119. class WorldDimensionException extends Exception

     

120. class WorldDimensions3D extends WorldDimensions

     

121. trait WorldPropertiesInterface extends AnyRef

     

122. trait WorldRenderable extends AnyRef

     

123. trait WorldResizer extends AnyRef

     

     used by Importer for resizing the world during an import.

     used by Importer for resizing the world during an import. also used by BehaviorSpace when the experiment varies the world size

124. trait WorldWithWorldRenderable extends World with WorldRenderable