Jadex 0.96-beta1

jadex.model
Interface IMBeliefbase

All Superinterfaces:
IMBase, IMElement

public interface IMBeliefbase
extends IMBase

The beliefbase is the container for the agent's or capability's beliefs and belief sets.


Method Summary
 IMBelief createBelief(String name, Class clazz, long updaterate, String exported)
          Create a new belief.
 IMBeliefReference createBeliefReference(String name, Class clazz, String exported, String ref)
          Create a new belief reference.
 IMBeliefSet createBeliefSet(String name, Class clazz, long updaterate, String exported)
          Create a new belief set.
 IMBeliefSetReference createBeliefSetReference(String name, Class clazz, String exported, String ref)
          Create a new belief set reference.
 void deleteBelief(IMBelief belief)
          Delete a belief.
 void deleteBeliefReference(IMBeliefReference beliefreference)
          Delete a belief reference.
 void deleteBeliefSet(IMBeliefSet beliefset)
          Delete a belief set.
 void deleteBeliefSetReference(IMBeliefSetReference beliefsetreference)
          Delete a belief set reference.
 IMBelief getBelief(String name)
          Get a belief by name.
 IMBeliefReference getBeliefReference(String name)
          Get a belief reference.
 IMBeliefReference[] getBeliefReferences()
          Get all belief references.
 IMBelief[] getBeliefs()
          Get all defined beliefs.
 IMBeliefSet getBeliefSet(String name)
          Get a belief set by name.
 IMBeliefSetReference getBeliefSetReference(String name)
          Get a belief set reference by name.
 IMBeliefSetReference[] getBeliefSetReferences()
          Get all defined belief set references.
 IMBeliefSet[] getBeliefSets()
          Get all defined belief sets.
 
Methods inherited from interface jadex.model.IMBase
deleteReferenceableElement, getCorrespondingBase, getElementReferences, getReferenceableElement, getReferenceableElements
 
Methods inherited from interface jadex.model.IMElement
check, getChildren, getDescription, getEncodableRepresentation, getName, getOwner, getReport, getScope, getSystemExpressionParameters, setDescription, setName
 

Method Detail

getBeliefs

IMBelief[] getBeliefs()
Get all defined beliefs.

Returns:
The beliefs.

getBelief

IMBelief getBelief(String name)
Get a belief by name. Searches the belief in direct subcapabilities, when path notation is used (a.name).

Parameters:
name - The belief name.
Returns:
The belief with that name (if any).

createBelief

IMBelief createBelief(String name,
                      Class clazz,
                      long updaterate,
                      String exported)
Create a new belief.

Parameters:
name - The belief name.
clazz - The class for facts.
updaterate - The updaterate (or -1 for none).
Returns:
The newly created belief.

deleteBelief

void deleteBelief(IMBelief belief)
Delete a belief.

Parameters:
belief - The belief to delete.

getBeliefSets

IMBeliefSet[] getBeliefSets()
Get all defined belief sets.

Returns:
The belief sets.

getBeliefSet

IMBeliefSet getBeliefSet(String name)
Get a belief set by name. Searches the belief in direct subcapabilities, when path notation is used (a.name).

Parameters:
name - The belief set name.
Returns:
The belief set with that name (if any).

createBeliefSet

IMBeliefSet createBeliefSet(String name,
                            Class clazz,
                            long updaterate,
                            String exported)
Create a new belief set.

Parameters:
name - The belief set name.
clazz - The class for facts.
updaterate - The updaterate (or -1 for none).
exported - Flag indicating if this belief set may be referenced from outside capabilities.
Returns:
The newly created belief set.

deleteBeliefSet

void deleteBeliefSet(IMBeliefSet beliefset)
Delete a belief set.

Parameters:
beliefset - The belief set to delete.

getBeliefReferences

IMBeliefReference[] getBeliefReferences()
Get all belief references.

Returns:
The belief references.

getBeliefReference

IMBeliefReference getBeliefReference(String name)
Get a belief reference. Searches the belief ref in direct subcapabilities, when path notation is used (a.name).

Parameters:
name - The name.
Returns:
The belief reference.

createBeliefReference

IMBeliefReference createBeliefReference(String name,
                                        Class clazz,
                                        String exported,
                                        String ref)
Create a new belief reference.

Parameters:
name - The belief reference name.
clazz - The class for facts.
exported - Flag indicating if this belief reference may be referenced from outside capabilities.
ref - The referenced belief (or null for abstract).
Returns:
The newly created belief reference.

deleteBeliefReference

void deleteBeliefReference(IMBeliefReference beliefreference)
Delete a belief reference.

Parameters:
beliefreference - The belief reference to delete.

getBeliefSetReferences

IMBeliefSetReference[] getBeliefSetReferences()
Get all defined belief set references.

Returns:
The belief set references.

getBeliefSetReference

IMBeliefSetReference getBeliefSetReference(String name)
Get a belief set reference by name. Searches the belief set ref in direct subcapabilities, when path notation is used (a.name).

Parameters:
name - The belief set name.
Returns:
The belief set with that name (if any).

createBeliefSetReference

IMBeliefSetReference createBeliefSetReference(String name,
                                              Class clazz,
                                              String exported,
                                              String ref)
Create a new belief set reference.

Parameters:
name - The belief set reference name.
clazz - The class for facts.
exported - Flag indicating if this belief set reference may be referenced from outside capabilities.
ref - The referenced belief set (or null for abstract).
Returns:
The newly created belief set reference.

deleteBeliefSetReference

void deleteBeliefSetReference(IMBeliefSetReference beliefsetreference)
Delete a belief set reference.

Parameters:
beliefsetreference - The belief set reference to delete.

Jadex 0.96-beta1

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.