Package madkit.simulation.activator

Class DiscreteEventAgentsActivator<A extends AbstractAgent>

java.lang.Object
madkit.kernel.Activator<A>
madkit.simulation.activator.GenericBehaviorActivator<A>
madkit.simulation.activator.DiscreteEventAgentsActivator<A>
Type Parameters:
A -
All Implemented Interfaces:
Comparable<DiscreteEventAgentsActivator<A>>
public class DiscreteEventAgentsActivator<A extends AbstractAgent> extends GenericBehaviorActivator<A> implements Comparable<DiscreteEventAgentsActivator<A>>
An activator that works using a discrete-event simulation scheme.
Author:
Fabien Michel

  • Constructor Details

    • DiscreteEventAgentsActivator

      public DiscreteEventAgentsActivator(String community, String group, String role, String theBehaviorToActivate)

  • Method Details

    • compareTo

      public int compareTo(DiscreteEventAgentsActivator<A> o)
      Specified by:
      compareTo in interface Comparable<A extends AbstractAgent>

    • getNextActivationDate

      public LocalDateTime getNextActivationDate()

    • adding

      protected void adding(A agent)
      This method is automatically called when an agent joins the corresponding group and role. This method is empty by default. Override this method when you want to do some initialization when an agent enters the group/role.
      Overrides:
      adding in class Activator<A extends AbstractAgent>
      Parameters:
      agent - which has been added to this group/role

    • removing

      protected void removing(A agent)
      This method is automatically called when an agent leaves the corresponding group and role. This method is empty by default. Override this method when you want to do some work when an agent leaves the group/role. Note that the role is still handled by the agent when invoked.
      Parameters:
      agent - the agent which is being removed from this group/role

    • setNextActivationDate

      public void setNextActivationDate(LocalDateTime nextActivationDate)

    • execute

      public void execute(Object... args)
      Description copied from class: Activator
      Call #execute(List agentsList) on all the agents, i.e. using Overlooker.getCurrentAgentsList(). By default, this is automatically called by the default scheduler's loop once the activator is added.
      Overrides:
      execute in class Activator<A extends AbstractAgent>
      Parameters:
      args - arguments that could be used by the scheduler to pass information to this activator for an activation
      See Also:

    • toString

      public String toString()
      returns a string containing the CGR location and the number of monitored agents.
      Overrides:
      toString in class Activator<A extends AbstractAgent>
      Returns:
      a string representation of this tool.

    • getDefaultInterval

      public Duration getDefaultInterval()

    • setDefaultInterval

      public void setDefaultInterval(Duration defaultInterval)

    • getCommunity

      public String getCommunity()
      Gets the community to which this activator/probe is binded to.
      Returns:
      a string representing the community's name

    • getGroup

      public String getGroup()
      Gets the group to which this activator/probe is binded to.
      Returns:
      a string representing the group's name

    • getRole

      public String getRole()
      Gets the role to which this activator/probe is binded to.
      Returns:
      a string representing the role's name

    • initialize

      public void initialize()
      Called by the MaDKit kernel when the Activator or Probe is first added. Default behavior is: adding(getCurrentAgentsList());

    • adding

      protected void adding(List<A> agents)
      Called when a list of agents joins the corresponding group and role. This method is automatically called by the MaDKit kernel when agents enter a role due to the use of AbstractAgent.launchAgentBucket(String, int, String...). Override this method when you want to do some initialization on the agents that enter the group/role. Default implementation is: 
      
 protected void adding(final List<A> agents) {
        for (A agent : agents) {
                adding(agent);
        }
 }
      Parameters:
      agents - the list of agents which have been added to this group/role at once.

    • removing

      protected void removing(List<A> agents)
      This method is automatically called when a list of agents has leaved the corresponding group and role. This method is empty by default. Override this method when you want to do some initialization on the agents that enter the group/role. Default implementation is: 
      
 protected void removing(final List<A> agents) {
        for (A agent : agents) {
                removing(agent);
        }
 }
      Parameters:
      agents - the list of agents which have been removed from this group/role

    • size

      public int size()
      Returns the number of the agents handling the group/role couple
      Returns:
      the number of the agents that handle the group/role couple

    • getCurrentAgentsList

      public List<A> getCurrentAgentsList()
      Returns a snapshot at moment t of the agents handling the group/role couple
      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

    • getShuffledList

      public List<A> getShuffledList()
      Returns a ListIterator over the agents which is shuffled
      Returns:
      a ListIterator which has been previously shuffled
      Since:
      MaDKit 3.0

    • killAgents

      public void killAgents()
      Kills all the agents which are monitored.

    • allAgentsLeaveRole

      public void allAgentsLeaveRole()
      Makes all the agents leave the corresponding role at once.