//----------------------------------------------------------------------------
// Copyright (C) 2011 Ingrid Nunes
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
// To contact the authors:
// http://inf.ufrgs.br/~ingridnunes/bdi4jade/
//
//----------------------------------------------------------------------------
package bdi4jade.core;
import jade.lang.acl.ACLMessage;
import java.io.Serializable;
import java.util.HashSet;
import java.util.Set;
/**
* This capability represents a component that aggregates the mental attitudes
* defined by the BDI architecture. It has a belief base with the associated
* beliefs (knowledge) and a plan library.
*
* @author ingrid
*/
public class Capability implements Serializable {
private static final long serialVersionUID = -4922359927943108421L;
protected final BeliefBase beliefBase;
protected final Set<Capability> children;
protected final String id;
protected BDIAgent myAgent;
protected Capability parent;
protected final PlanLibrary planLibrary;
private boolean start;
/**
* Creates a new capability. It uses {@link BeliefBase} and
* {@link PlanLibrary} as belief base and plan library respectively.
*/
public Capability() {
this(null);
}
/**
* Creates a new capability.
*
* @param beliefBase
* the belief base of this capability.
* @param planLibrary
* the plan library of this capability.
*/
public Capability(BeliefBase beliefBase, PlanLibrary planLibrary) {
this(null, beliefBase, planLibrary);
}
/**
* Creates a new capability. It uses {@link BeliefBase} and
* {@link PlanLibrary} as belief base and plan library respectively.
*
* @param id
* the capability id. If it is null, the class name is going to
* be used.
*/
public Capability(String id) {
this(id, new BeliefBase(), new PlanLibrary());
}
/**
* Creates a new capability.
*
* @param id
* the capability id. If it is null, the class name is going to
* be used.
* @param beliefBase
* the belief base of this capability.
* @param planLibrary
* the plan library of this capability.
*/
public Capability(String id, BeliefBase beliefBase, PlanLibrary planLibrary) {
this(id, null, beliefBase, planLibrary);
}
/**
* Creates a new capability. It uses {@link BeliefBase} and
* {@link PlanLibrary} as belief base and plan library respectively.
*
* @param id
* the capability id. If it is null, the class name is going to
* be used.
* @param parent
* the parent of this capability.
*/
public Capability(String id, Capability parent) {
this(id, parent, new BeliefBase(), new PlanLibrary());
}
/**
* Creates a new capability.
*
* @param id
* the capability id. If it is null, the class name is going to
* be used.
* @param parent
* the parent of this capability.
* @param beliefBase
* the belief base of this capability.
* @param planLibrary
* the plan library of this capability.
*/
public Capability(String id, Capability parent, BeliefBase beliefBase,
PlanLibrary planLibrary) {
if (id == null) {
if (this.getClass().getCanonicalName() == null
|| Capability.class.equals(this.getClass())) {
this.id = Capability.class.getSimpleName()
+ System.currentTimeMillis();
} else {
this.id = this.getClass().getSimpleName();
}
} else {
this.id = id;
}
this.children = new HashSet<>();
if (parent != null) {
parent.addChild(this);
}
beliefBase.setCapability(this);
this.beliefBase = beliefBase;
planLibrary.setCapability(this);
this.planLibrary = planLibrary;
this.start = false;
}
public void addChild(Capability capability) {
if (capability.parent != null) {
capability.parent.removeChild(capability);
}
capability.parent = this;
this.children.add(capability);
}
/**
* Checks if this capability has a plan that can process the given message.
*
* @param msg
* the message to be checked.
* @return true if this capability has at least a plan that can process the
* message.
*/
public boolean canProcess(ACLMessage msg) {
return this.planLibrary.canProcessPlans(msg);
}
/**
* @return the beliefBase
*/
public BeliefBase getBeliefBase() {
return beliefBase;
}
/**
* @return the children
*/
public Set<Capability> getChildren() {
return new HashSet<>(children);
}
/**
* @return the id
*/
public String getId() {
return id;
}
/**
* @return the agent that this capability is associated with.
*/
public BDIAgent getMyAgent() {
return this.myAgent;
}
/**
* @return the parent
*/
public Capability getParent() {
return parent;
}
/**
* @return the planLibrary
*/
public PlanLibrary getPlanLibrary() {
return planLibrary;
}
public boolean hasChildren() {
return !this.children.isEmpty();
}
public boolean removeChild(Capability capability) {
boolean removed = this.children.remove(capability);
if (removed) {
capability.parent = null;
}
return removed;
}
/**
* @param myAgent
* the myAgent to set
*/
public void setMyAgent(BDIAgent myAgent) {
this.myAgent = myAgent;
if (!start) {
setup();
this.start = true;
}
}
/**
* This is an empty holder for being overridden by subclasses. Initializes
* the capability. This method is invoked by the constructor. It may be used
* to add initial plans and beliefs. The reasoning strategies of this
* capability are initialized in the constructor with default strategies.
* This method may also customize them.
*/
protected void setup() {
}
/**
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return id;
}
}