Package madkit.simulation.activator
Class GenericBehaviorActivator<A extends AbstractAgent>
java.lang.Object
madkit.kernel.Activator<A>
madkit.simulation.activator.GenericBehaviorActivator<A>
- Direct Known Subclasses:
DateBasedDiscreteEventActivator
,DiscreteEventAgentsActivator
An activator that invokes a single method with no parameters on a group of agents. This class encapsulates behavior
invocation on MaDKit agents for scheduler agents. This activator allows to call a particular Java method on agents
regardless of their actual class type as long as they extend
AbstractAgent
. This has to be used by
Scheduler
subclasses to create simulation applications.- Since:
- MaDKit 5.0.0.1
- Version:
- 1.0
- Author:
- Fabien Michel
-
Constructor Summary
ConstructorsConstructorDescriptionGenericBehaviorActivator
(String community, String group, String role, String theBehaviorToActivate) Builds a new GenericBehaviorActivator on the given CGR location of the artificial society. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Called when a list of agents joins the corresponding group and role.void
Makes all the agents leave the corresponding role at once.void
Triggers the corresponding behavior on all the agents which are at the CGR location defined by this activator.Gets the community to which this activator/probe is binded to.Returns a snapshot at moment t of the agents handling the group/role couplegetGroup()
Gets the group to which this activator/probe is binded to.getRole()
Gets the role to which this activator/probe is binded to.Returns a ListIterator over the agents which is shuffledvoid
Called by the MaDKit kernel when the Activator or Probe is first added.void
Kills all the agents which are monitored.protected void
This method is automatically called when an agent leaves the corresponding group and role.protected void
This method is automatically called when a list of agents has leaved the corresponding group and role.int
size()
Returns the number of the agents handling the group/role coupleMethods inherited from class madkit.kernel.Activator
adding, execute, executeBehaviorOf, findMethodOn, findMethodOnFromArgsSample, getMadkitServiceExecutor, getPriority, getSimulationTime, isMulticoreModeOn, multicoreExecute, nbOfParallelTasks, toString, useMulticore
-
Constructor Details
-
GenericBehaviorActivator
public GenericBehaviorActivator(String community, String group, String role, String theBehaviorToActivate) Builds a new GenericBehaviorActivator on the given CGR location of the artificial society. Once created, it has to be added by aScheduler
agent using theScheduler.addActivator(Activator)
method. Once added, it could be used to trigger the behavior on all the agents which are at this CGR location, regardless of their class type as long as they extendAbstractAgent
- Parameters:
community
-group
-role
-theBehaviorToActivate
- name of the Java method which will be invoked
-
-
Method Details
-
getBehaviorName
-
execute
Triggers the corresponding behavior on all the agents which are at the CGR location defined by this activator.- Specified by:
execute
in classActivator<A extends AbstractAgent>
- See Also:
-
getCommunity
Gets the community to which this activator/probe is binded to.- Returns:
- a string representing the community's name
-
getGroup
Gets the group to which this activator/probe is binded to.- Returns:
- a string representing the group's name
-
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
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 ofAbstractAgent.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
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
-
removing
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
-
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
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
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.
-