Jadex 0.96

jadex.planlib
Capability AMS

Direct Known Containing Capabilities:
StartAgents, TestCenter

capability AMS

Capability for agent management system (AMS) functionality. Defines some services that should be available on any platform (create/search/destroy agents).


Belief Summary
exported beliefset AMSAgentDescription agents
           The agents managed by the AMS.
 
Goal Summary
exported achievegoal ams_create_agent(BasicAgentIdentifier agentidentifier, BasicAgentIdentifier ams, Map arguments, String configuration, String name, boolean start, String type)
           Create (and by default start) a new agent on the platform.
exported achievegoal ams_destroy_agent(BasicAgentIdentifier agentidentifier, BasicAgentIdentifier ams)
           Destroy the given agent.
exported achievegoal ams_resume_agent(AMSAgentDescription agentdescription, BasicAgentIdentifier agentidentifier, BasicAgentIdentifier ams)
           Resume the given agent.
exported achievegoal ams_search_agents(BasicAgentIdentifier ams, SearchConstraints constraints, AMSAgentDescription description, AMSAgentDescription [set] result)
           Search for agents on the platform.
exported achievegoal ams_shutdown_platform(BasicAgentIdentifier ams)
           Shutdown the platform.
exported achievegoal ams_start_agent(BasicAgentIdentifier agentidentifier, BasicAgentIdentifier ams)
           Start the given agent (only possible when it has previously been created with start=false).
exported achievegoal ams_suspend_agent(AMSAgentDescription agentdescription, BasicAgentIdentifier agentidentifier, BasicAgentIdentifier ams)
           Suspend the given agent.
 
Configuration Summary
configuration  agentlist
           Configuration containing goals, plans, whatever needed to maintain an uptodate agent list belief.
default configuration  default
           Default configuration without maintaining an uptodate agent list.
 

Belief Detail

agents

exported beliefset AMSAgentDescription agents
The agents managed by the AMS. Is updated automatically only when initialstate 'agentlist' is used.

Goal Detail

ams_create_agent

exported achievegoal ams_create_agent(BasicAgentIdentifier agentidentifier, 
                                      BasicAgentIdentifier ams, 
                                      Map arguments, 
                                      String configuration, 
                                      String name, 
                                      boolean start, 
                                      String type)
Create (and by default start) a new agent on the platform.

Parameters:
out parameter agentidentifier - The identifier of the created agent.
optional in parameter ams - The AMS agent identifier (only needed for remote requests).
optional in parameter arguments - The arguments for the new agent.
optional in parameter configuration - The initial agent configuration to use.
optional in parameter name - The name of the instance to create.
in parameter start Default value:  true
- Flag indicating if the agent should be started after creation.
in parameter type - The agent type (name/path of agent model).
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

ams_start_agent

exported achievegoal ams_start_agent(BasicAgentIdentifier agentidentifier, 
                                     BasicAgentIdentifier ams)
Start the given agent (only possible when it has previously been created with start=false).

Parameters:
in parameter agentidentifier - The agent to destroy.
optional in parameter ams - The AMS agent identifier (only needed for remote requests).
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

ams_destroy_agent

exported achievegoal ams_destroy_agent(BasicAgentIdentifier agentidentifier, 
                                       BasicAgentIdentifier ams)
Destroy the given agent.

Parameters:
in parameter agentidentifier - The agent to destroy.
optional in parameter ams - The AMS agent identifier (only needed for remote requests).
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

ams_suspend_agent

exported achievegoal ams_suspend_agent(AMSAgentDescription agentdescription, 
                                       BasicAgentIdentifier agentidentifier, 
                                       BasicAgentIdentifier ams)
Suspend the given agent.

Parameters:
out parameter agentdescription - The possibly changed ams agent description.
in parameter agentidentifier - The agent to destroy.
optional in parameter ams - The AMS agent identifier (only needed for remote requests).
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

ams_resume_agent

exported achievegoal ams_resume_agent(AMSAgentDescription agentdescription, 
                                      BasicAgentIdentifier agentidentifier, 
                                      BasicAgentIdentifier ams)
Resume the given agent.

Parameters:
out parameter agentdescription - The possibly changed ams agent description.
in parameter agentidentifier - The agent to destroy.
optional in parameter ams - The AMS agent identifier (only needed for remote requests).
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

ams_search_agents

exported achievegoal ams_search_agents(BasicAgentIdentifier ams, 
                                       SearchConstraints constraints, 
                                       AMSAgentDescription description, 
                                       AMSAgentDescription [set] result)
Search for agents on the platform.

Parameters:
optional in parameter ams - The AMS agent identifier (only needed for remote requests).
optional in parameter constraints - The search constraints.
in parameter description - The template description to search for.
out parameterset result - The search results.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

ams_shutdown_platform

exported achievegoal ams_shutdown_platform(BasicAgentIdentifier ams)
Shutdown the platform.

Parameters:
optional in parameter ams - The AMS agent identifier (only needed for remote requests).
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false
Configuration Detail

default

default configuration default
Default configuration without maintaining an uptodate agent list.


agentlist

configuration agentlist
Configuration containing goals, plans, whatever needed to maintain an uptodate agent list belief.


Jadex 0.96

Submit a bug or feature
For further API reference and developer documentation, see the Jadex User Guide and the Jadex Tutorial. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, and working code examples.

Copyright (C) 2002-2007 Lars Braubach, Alexander Pokahr - University of Hamburg. Use is subject to license terms.