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

Reporter#report(Argument[], Context)

,

Command#perform(Argument[], Context)

Linear Supertypes
AnyRef, Any
Known Subclasses
Argument
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Argument
  2. AnyRef
  3. Any
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
    ExtensionExceptionLogoException

    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
    ExtensionException

    if the argument is not an Agent

    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
    ExtensionException

    if the argument is not an AgentSet

    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
    ExtensionException

    if the argument is not a Boolean

    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
    ExtensionException

    if the argument is not a boolean

    LogoException

    if a LogoException occurred while evaluating this argument

  6. abstract def getCommandTask: CommandTask

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

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

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

    if the argument is not a CommandTask

    LogoException

    if a LogoException occurred while evaluating this argument

  7. 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
    ExtensionException

    if the argument is not a number.

    LogoException

    if a LogoException occurred while evaluating this argument

  8. 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
    ExtensionException

    if the argument is not a number.

    LogoException

    if a LogoException occurred while evaluating this argument

  9. 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
    ExtensionException

    if the argument is not a Link

    LogoException

    if a LogoException occurred while evaluating this argument

  10. abstract def getList: LogoList

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

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

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

    if the argument is not a LogoList

    LogoException

    if a LogoException occurred while evaluating this argument

  11. 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
    ExtensionException

    if the argument is not a Patch

    LogoException

    if a LogoException occurred while evaluating this argument

  12. abstract def getReporterTask: ReporterTask

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

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

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

    if the argument is not a ReporterTask

    LogoException

    if a LogoException occurred while evaluating this argument

  13. 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
    ExtensionException

    if the argument cannot be cast to a String

    LogoException

    if a LogoException occurred while evaluating this argument

  14. 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
    ExtensionException

    if the argument is not a Turtle

    LogoException

    if a LogoException occurred while evaluating this argument

Concrete Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

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

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

    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. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  18. def toString(): String

    Definition Classes
    AnyRef → Any

  19. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from AnyRef

Inherited from Any