Trait

org.nlogo.api

Argument

Related Doc: package api

Permalink

trait Argument extends AnyRef

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.

Source
Argument.scala
See also

Reporter#report(Argument[], Context)

Command#perform(Argument[], Context)

Linear Supertypes
AnyRef, Any
Known Subclasses
Argument
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Argument
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def get: AnyRef

    Permalink

    Returns the argument as an Object without type checking.

    Returns the argument as an Object without type checking.

    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
    Exceptions thrown

    api.LogoException if a LogoException occurred while evaluating this argument

  2. abstract def getAgent: Agent

    Permalink

    Returns the argument as an Agent.

    Returns the argument as an Agent.

    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
    Exceptions thrown

    api.ExtensionException if the argument is not an Agent

    api.LogoException if a LogoException occurred while evaluating this argument

  3. abstract def getAgentSet: AgentSet

    Permalink

    Returns the argument as an org.nlogo.api.AgentSet.

    Returns the argument as an org.nlogo.api.AgentSet.

    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
    Exceptions thrown

    api.ExtensionException if the argument is not an AgentSet

    api.LogoException if a LogoException occurred while evaluating this argument

  4. abstract def getBoolean: Boolean

    Permalink

    Returns the argument as a boxed java.lang.Boolean

    Returns the argument as a boxed java.lang.Boolean

    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
    Exceptions thrown

    api.ExtensionException if the argument is not a Boolean

    api.LogoException if a LogoException occurred while evaluating this argument

  5. abstract def getBooleanValue: Boolean

    Permalink

    Returns the value of the argument as an unboxed boolean.

    Returns the value of the argument as an unboxed boolean.

    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
    Exceptions thrown

    api.ExtensionException if the argument is not a boolean

    api.LogoException if a LogoException occurred while evaluating this argument

  6. abstract def getCode: List[Token]

    Permalink

    Returns the argument as a java.utilList[Token].

    Returns the argument as a java.utilList[Token].

    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
    Exceptions thrown

    api.ExtensionException if the argument is not a valid block of tokens

    api.LogoException if a LogoException occurred while evaluating this argument

  7. abstract def getCommand: AnonymousCommand

    Permalink

    Returns the argument as a org.nlogo.api.AnonymousCommand.

    Returns the argument as a org.nlogo.api.AnonymousCommand.

    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
    Exceptions thrown

    api.ExtensionException if the argument is not an AnonymousCommand

    api.LogoException if a LogoException occurred while evaluating this argument

  8. abstract def getDoubleValue: Double

    Permalink

    Returns the value of the argument as an unboxed double.

    Returns the value of the argument as an unboxed double.

    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
    Exceptions thrown

    api.ExtensionException if the argument is not a number.

    api.LogoException if a LogoException occurred while evaluating this argument

  9. abstract def getIntValue: Int

    Permalink

    Returns the value of the argument as an unboxed int.

    Returns the value of the argument as an unboxed int. Any fractional part is discarded.

    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
    Exceptions thrown

    api.ExtensionException if the argument is not a number.

    api.LogoException if a LogoException occurred while evaluating this argument

  10. abstract def getLink: Link

    Permalink

    Returns the argument as a org.nlogo.api.Link.

    Returns the argument as a org.nlogo.api.Link.

    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
    Exceptions thrown

    api.ExtensionException if the argument is not a Link

    api.LogoException if a LogoException occurred while evaluating this argument

  11. abstract def getList: LogoList

    Permalink

    Returns the argument as a org.nlogo.core.LogoList

    Returns the argument as a org.nlogo.core.LogoList

    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
    Exceptions thrown

    api.ExtensionException if the argument is not a LogoList

    api.LogoException if a LogoException occurred while evaluating this argument

  12. abstract def getPatch: Patch

    Permalink

    Returns the argument as an org.nlogo.api.Patch

    Returns the argument as an org.nlogo.api.Patch

    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
    Exceptions thrown

    api.ExtensionException if the argument is not a Patch

    api.LogoException if a LogoException occurred while evaluating this argument

  13. abstract def getReporter: AnonymousReporter

    Permalink

    Returns the argument as a org.nlogo.api.AnonymousReporter.

    Returns the argument as a org.nlogo.api.AnonymousReporter.

    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
    Exceptions thrown

    api.ExtensionException if the argument is not an AnonymousReporter

    api.LogoException if a LogoException occurred while evaluating this argument

  14. abstract def getString: String

    Permalink

    Returns the argument as a String

    Returns the argument as a String

    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
    Exceptions thrown

    api.ExtensionException if the argument cannot be cast to a String

    api.LogoException if a LogoException occurred while evaluating this argument

  15. abstract def getSymbol: Token

    Permalink

    Returns the argument as a org.nlogo.api.Token.

    Returns the argument as a org.nlogo.api.Token.

    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
    Exceptions thrown

    api.ExtensionException if the argument is not a Token

    api.LogoException if a LogoException occurred while evaluating this argument

  16. abstract def getTurtle: Turtle

    Permalink

    Returns the argument as a org.nlogo.api.Turtle.

    Returns the argument as a org.nlogo.api.Turtle.

    Annotations
    @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
    Exceptions thrown

    api.ExtensionException if the argument is not a Turtle

    api.LogoException if a LogoException occurred while evaluating this argument

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped