Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## turtlekit.kernel
Class TurtleProbe

    java.lang.Object
      madkit.kernel.Probe<Turtle>
          turtlekit.kernel.TurtleProbe

    public class TurtleProbe

extends Probe<Turtle>

The TurtleProbe class.

Version:
  3.1 09/10/2007
Author:
  Fabien MICHEL

Constructor Summary
`TurtleProbe(java.lang.String group, java.lang.String role)` build a turtleProbe on the specified group/role couple

Method Summary
`A` | `getAgentNb(int nb)`
`java.util.ListIterator<A>` | `getAgentsIterator()` Deprecated. as of MadKit 4.3 : simply type `getCurrentAgentsList().listIterator()`
`java.lang.String` | `getCommunity()`
`java.util.List<A>` | `getCurrentAgentsList()`
`java.lang.String` | `getGroup()`
`java.lang.String` | `getRole()`
`java.util.List<A>` | `getShuffledList()`
`Turtle[]` | `getTurtles()`
`int` | `nbOfTurtles()`
`int` | `numberOfAgents()`
`java.lang.String` | `toString()`

Methods inherited from class madkit.kernel.Probe
`initialize, update`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### TurtleProbe

    public TurtleProbe(java.lang.String group,
                       java.lang.String role)

  build a turtleProbe on the specified group/role couple

Method Detail

### getTurtles

    public Turtle[] getTurtles()

  Returns:
    an array of the turtles that handle the group/role couple

### nbOfTurtles

    public int nbOfTurtles()

  Returns:
    the number of turtles that handle the group/role couple

### getAgentsIterator

    public final java.util.ListIterator<A> getAgentsIterator()

  Deprecated. as of MadKit 4.3 : simply type `getCurrentAgentsList().listIterator()`

  Returns:
    a ListIterator over the agents that handle the group/role couple
  Since:
    MadKit 3.0

### getShuffledList

    public final java.util.List<A> getShuffledList()

  Returns:
    a ListIterator which has been previously shuffled
  Since:
    MadKit 3.0

### getCurrentAgentsList

    public final java.util.List<A> getCurrentAgentsList()

  Returns:
    a list view (a snapshot at moment t) of the agents that handle the group/role couple (in proper sequence)
  Since:
    MadKit 3.0

### numberOfAgents

    public final int numberOfAgents()

  Returns:
    the number of the agents that handle the group/role couple

### getAgentNb

    public final A getAgentNb(int nb)

### getCommunity

    public final java.lang.String getCommunity()

### getGroup

    public final java.lang.String getGroup()

### getRole

    public final java.lang.String getRole()

### toString

    public java.lang.String toString()

  Overrides:
    `toString` in class `java.lang.Object`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © Madkit Team (O. Gutknecht, J. Ferber, F. Michel et al.) All Rights Reserved.