org.nlogo.api

Reporter

trait Reporter extends Primitive

Interface for NetLogo reporters. Reporters are primitives that return a value. All new reporters must implement this interface.

Source
Reporter.scala
Linear Supertypes
Primitive, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Reporter
  2. Primitive
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def getAgentClassString: String

    Returns a String which specifies which agents can run this primitive.

    Returns a String which specifies which agents can run this primitive. To specify observer use "O", to specify Turtle use "T", to specify Patch use "P", to specify link use "L". To use combinations, put them togther.

    Example of a primitive allowed for all agents: String getAgentClassString() { return "OTPL"; }

    Example of a primitive allowed only for turtles: String getAgentClassString() { return "T"; }

    returns

    a String specifying the acceptable agent types.

    Definition Classes
    Primitive
  2. abstract def getSyntax: Syntax

    Returns Syntax which specifies the syntax that is acceptable for this primitive.

    Returns Syntax which specifies the syntax that is acceptable for this primitive. Used by the compiler for type-checking.

    returns

    the Syntax for the primitive.

    Definition Classes
    Primitive
    See also

    Syntax

  3. abstract def report(args: Array[Argument], context: Context): AnyRef

    Executes this Reporter.

    Executes this Reporter. Called by NetLogo when this Reporter is called in a running NetLogo model.

    args

    The Arguments that were included with the command in the NetLogo code. (May be a Reporter or a constant.)

    context

    The current Context allows access to NetLogo internal methods.

    returns

    the object to be reported

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

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 Primitive

Inherited from AnyRef

Inherited from Any