org.nlogo.api

Command

trait Command extends Primitive

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

Source
Command.scala
Linear Supertypes
Primitive, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Command
  2. Primitive
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All

Abstract Value Members

  1. def getAgentClassString : String

    Returns a String which specifies which agents can run this primitive.

    Returns a String which specifies which agents can run this primitive. To specify observer use "O", to specify Turtle use "T", to specify Patch use "P", to specify link use "L". To use combinations, put them togther.

    Example of a primitive allowed for all agents: String getAgentClassString() { return "OTPL"; }

    Example of a primitive allowed only for turtles: String getAgentClassString() { return "T"; }

    returns

    a String specifying the acceptable agent types.

    Attributes
    abstract
    Definition Classes
    Primitive
  2. def getSwitchesBoolean : Boolean

    Specifies whether NetLogo should "switch" to another turtle after running this command.

    Specifies whether NetLogo should "switch" to another turtle after running this command. Generally, this should be true if this Command affects the state of the world (changing a variable, changing graphics, etc.)

    returns

    true if a switch should occur, false otherwise.

    Attributes
    abstract
  3. def getSyntax : Syntax

    Returns Syntax which specifies the syntax that is acceptable for this primitive.

    Returns Syntax which specifies the syntax that is acceptable for this primitive. Used by the compiler for type-checking.

    returns

    the Syntax for the primitive.

    Attributes
    abstract
    Definition Classes
    Primitive
    See also

    Syntax

  4. def perform (args: Array[Argument], context: Context): Unit

    Executes this Command.

    Executes this Command. Called by NetLogo when this Command is called at run-time.

    args

    the Arguments that were passed to the command. (May be a Reporter or a constant.) To evaluate arguments, use the typesafe methods in the Argument interface.

    context

    the current Context allows access to NetLogo internal methods

    Attributes
    abstract
    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )

Concrete Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  7. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  8. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  9. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  10. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  11. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  12. def hashCode (): Int

    Definition Classes
    AnyRef → Any
  13. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  14. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  15. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  16. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  17. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  18. def toString (): String

    Definition Classes
    AnyRef → Any
  19. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  20. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  21. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Primitive

Inherited from AnyRef

Inherited from Any