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)
- Alphabetic
- By Inheritance
- Argument
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
get: AnyRef
Returns the argument as an
Objectwithout type checking.Returns the argument as an
Objectwithout type checking.- Annotations
- @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
- Exceptions thrown
api.LogoExceptionif a LogoException occurred while evaluating this argument
-
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.ExtensionExceptionif the argument is not anAgentapi.LogoExceptionif a LogoException occurred while evaluating this argument
-
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.ExtensionExceptionif the argument is not anAgentSetapi.LogoExceptionif a LogoException occurred while evaluating this argument
-
abstract
def
getBoolean: Boolean
Returns the argument as a boxed
java.lang.BooleanReturns the argument as a boxed
java.lang.Boolean- Annotations
- @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
- Exceptions thrown
api.ExtensionExceptionif the argument is not aBooleanapi.LogoExceptionif a LogoException occurred while evaluating this argument
-
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.ExtensionExceptionif the argument is not abooleanapi.LogoExceptionif a LogoException occurred while evaluating this argument
-
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.ExtensionExceptionif the argument is not a valid block of tokensapi.LogoExceptionif a LogoException occurred while evaluating this argument
-
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.ExtensionExceptionif the argument is not anAnonymousCommandapi.LogoExceptionif a LogoException occurred while evaluating this argument
-
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.ExtensionExceptionif the argument is not a number.api.LogoExceptionif a LogoException occurred while evaluating this argument
-
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.ExtensionExceptionif the argument is not a number.api.LogoExceptionif a LogoException occurred while evaluating this argument
-
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.ExtensionExceptionif the argument is not a number.api.LogoExceptionif a LogoException occurred while evaluating this argument
-
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.ExtensionExceptionif the argument is not aLinkapi.LogoExceptionif a LogoException occurred while evaluating this argument
-
abstract
def
getList: LogoList
Returns the argument as a
org.nlogo.core.LogoListReturns the argument as a
org.nlogo.core.LogoList- Annotations
- @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
- Exceptions thrown
api.ExtensionExceptionif the argument is not aLogoListapi.LogoExceptionif a LogoException occurred while evaluating this argument
-
abstract
def
getPatch: Patch
Returns the argument as an
org.nlogo.api.PatchReturns the argument as an
org.nlogo.api.Patch- Annotations
- @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
- Exceptions thrown
api.ExtensionExceptionif the argument is not aPatchapi.LogoExceptionif a LogoException occurred while evaluating this argument
-
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.ExtensionExceptionif the argument is not anAnonymousReporterapi.LogoExceptionif a LogoException occurred while evaluating this argument
-
abstract
def
getString: String
Returns the argument as a
StringReturns the argument as a
String- Annotations
- @throws( classOf[ExtensionException] ) @throws( classOf[LogoException] )
- Exceptions thrown
api.ExtensionExceptionif the argument cannot be cast to aStringapi.LogoExceptionif a LogoException occurred while evaluating this argument
-
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.ExtensionExceptionif the argument is not aTokenapi.LogoExceptionif a LogoException occurred while evaluating this argument
-
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.ExtensionExceptionif the argument is not aTurtleapi.LogoExceptionif a LogoException occurred while evaluating this argument
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()