Packages

t

org.nlogo.api

Argument

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

Command#perform(Argument[], Context)

Reporter#report(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

    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

    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

    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

    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

    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]

    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

    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 getDouble: Double

    Returns the value of the argument as a boxed java.lang.Double.

    Returns the value of the argument as a boxed java.lang.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 getDoubleValue: Double

    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

  10. abstract def getIntValue: Int

    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

  11. abstract def getLink: Link

    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

  12. abstract def getList: LogoList

    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

  13. abstract def getPatch: Patch

    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

  14. abstract def getReporter: AnonymousReporter

    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

  15. abstract def getString: String

    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

  16. abstract def getSymbol: Token

    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

  17. abstract def getTurtle: Turtle

    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
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped