Argument

org.nlogo.api.Argument
trait Argument

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.

Attributes

See also

Command#perform(Argument[], Context)

Reporter#report(Argument[], Context)

Source
Argument.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Argument

Members list

Value members

Abstract methods

def get: AnyRef

Returns the argument as an Object without type checking.

Returns the argument as an Object without type checking.

Attributes

Throws
api.LogoException

if a LogoException occurred while evaluating this argument

Source
Argument.scala

Returns the argument as an Agent.

Returns the argument as an Agent.

Attributes

Throws
api.ExtensionException

if the argument is not an Agent

api.LogoException

if a LogoException occurred while evaluating this argument

Source
Argument.scala

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

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

Attributes

Throws
api.ExtensionException

if the argument is not an AgentSet

api.LogoException

if a LogoException occurred while evaluating this argument

Source
Argument.scala
def getBoolean: Boolean

Returns the argument as a boxed java.lang.Boolean

Returns the argument as a boxed java.lang.Boolean

Attributes

Throws
api.ExtensionException

if the argument is not a Boolean

api.LogoException

if a LogoException occurred while evaluating this argument

Source
Argument.scala

Returns the value of the argument as an unboxed boolean.

Returns the value of the argument as an unboxed boolean.

Attributes

Throws
api.ExtensionException

if the argument is not a boolean

api.LogoException

if a LogoException occurred while evaluating this argument

Source
Argument.scala
def getCode: List[Token]

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

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

Attributes

Throws
api.ExtensionException

if the argument is not a valid block of tokens

api.LogoException

if a LogoException occurred while evaluating this argument

Source
Argument.scala

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

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

Attributes

Throws
api.ExtensionException

if the argument is not an AnonymousCommand

api.LogoException

if a LogoException occurred while evaluating this argument

Source
Argument.scala
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.

Attributes

Throws
api.ExtensionException

if the argument is not a number.

api.LogoException

if a LogoException occurred while evaluating this argument

Source
Argument.scala

Returns the value of the argument as an unboxed double.

Returns the value of the argument as an unboxed double.

Attributes

Throws
api.ExtensionException

if the argument is not a number.

api.LogoException

if a LogoException occurred while evaluating this argument

Source
Argument.scala

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

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

Attributes

Throws
api.ExtensionException

if the argument is not a number.

api.LogoException

if a LogoException occurred while evaluating this argument

Source
Argument.scala

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

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

Attributes

Throws
api.ExtensionException

if the argument is not a LogoList

api.LogoException

if a LogoException occurred while evaluating this argument

Source
Argument.scala

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

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

Attributes

Throws
api.ExtensionException

if the argument is not a Patch

api.LogoException

if a LogoException occurred while evaluating this argument

Source
Argument.scala

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

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

Attributes

Throws
api.ExtensionException

if the argument is not an AnonymousReporter

api.LogoException

if a LogoException occurred while evaluating this argument

Source
Argument.scala

Returns the argument as a String

Returns the argument as a String

Attributes

Throws
api.ExtensionException

if the argument cannot be cast to a String

api.LogoException

if a LogoException occurred while evaluating this argument

Source
Argument.scala

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

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

Attributes

Throws
api.ExtensionException

if the argument is not a Token

api.LogoException

if a LogoException occurred while evaluating this argument

Source
Argument.scala

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

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

Attributes

Throws
api.ExtensionException

if the argument is not a Turtle

api.LogoException

if a LogoException occurred while evaluating this argument

Source
Argument.scala