Java Doc for SpawnAgents.java in  » Science » Cougaar12_4 » org » cougaar » core » mobility » plugin » Java Source Code / Java DocumentationJava Source Code and Java Documentation

This is really just a souped-up version of the AddAgentExamplePlugin .

Each plugin parameter is a "key=value" pair, where the default key is "agent". The keys are:

loopback=true

If the target is the local node and this plugin is loaded in the node agent, then use the local node's "addAgent" method instead of a mobility blackboard relay. This avoids the mobility domain if all agents are local.

parallel

Spawn agents in parallel, instead of waiting for each add to complete before adding the next agent.

agent

An add-agent command, see SpawnAgents.parseAgent . This can simply be a list of agent names, e.g.:

 <argument>Foo</argument>
 <argument>Bar</argument>
 

An agent string is either an agent name, a name followed by an "@" and a node name, or either of the prior options followed by an " if " and a node name.

 protected void parseAgents(List dummy) {
 List l = new ArrayList();
 if (localNode.equals("A")) {
 l.add("foo");
 } else {
 l.add("bar");
 l.add("qux");
 }
 super.parseAgents(l);
 }
 

Also see SpawnAgents.getNextAgent , which accesses the "agents" table created by this method.

Note that a subclass can override this method for greater control over the iteration order and values.
See Also:   SpawnAgents.parseAgents

An agent string is either an agent name, a name followed by an "@" and a node name, or either of the prior options followed by an " if " and a node name. This allows the client to specific all of the following simple commands:

 <!-- add agent A to the local node -->
 <argument>A</argument>
 <!-- add agent B to node X, which may be remote -->
 <argument>B @ X</argument>
 <!-- if this is node Y, then add agent C to the local node -->
 <argument>C if Y</argument>
 <!-- if this is node Z, then add agent D to node Q -->
 <argument>D @ Q if Z</argument>
 

 protected void parseAgents(List dummy) {
 List l = new ArrayList();
 if (localNode.equals("A")) {
 l.add("foo");
 } else {
 l.add("bar");
 l.add("qux");
 }
 super.parseAgents(l);
 }
 

Also see SpawnAgents.getNextAgent , which accesses the "agents" table created by this method.