Schema jadex-0.94.xsd


schema location:  http://jadex.sourceforge.net/jadex-0.94.xsd
targetNamespace:  http://jadex.sourceforge.net/jadex
 
Elements  Complex types 
agent  MAchieveGoal 
capability  MAchieveGoalReference 
properties  MAssign 
MBase 
MBDIAgent 
MBelief 
MBeliefbase 
MBeliefReference 
MBeliefSet 
MBeliefSetReference 
MBindingCondition 
MCapability 
MCapabilityReference 
MCondition 
MConditionReference 
MDeliberation 
MDummyPlan 
MElement 
MElementReference 
MEvent 
MEventbase 
MEventReference 
MExpression 
MExpressionbase 
MExpressionParameter 
MExpressionReference 
MGoal 
MGoalbase 
MGoalEvent 
MGoalEventReference 
MGoalReference 
MInhibits 
MInitialBase 
MInitialBelief 
MInitialBeliefbase 
MInitialBeliefSet 
MInitialCapability 
MInitialCapabilitybase 
MInitialElement 
MInitialEventbase 
MInitialGoal 
MInitialGoalbase 
MInitialInternalEvent 
MInitialMessageEvent 
MInitialParameter 
MInitialParameterElement 
MInitialParameterSet 
MInitialPlan 
MInitialPlanbase 
MInitialReferenceableElement 
MInitialState 
MInitialStatebase 
MInternalCondition 
MInternalEvent 
MInternalEventReference 
MInternalExpression 
MMaintainGoal 
MMaintainGoalReference 
MMessageEvent 
MMessageEventReference 
MMetaGoal 
MMetaGoalDummy 
MMetaGoalReference 
MParameter 
MParameterElement 
MParameterElementReference 
MParameterReference 
MParameterSet 
MParameterSetReference 
MPerformGoal 
MPerformGoalReference 
MPlan 
MPlanbase 
MPlanBody 
MPlanParameter 
MPlanParameterSet 
MPlanReference 
MPlanTrigger 
MPropertybase 
MQueryGoal 
MQueryGoalReference 
MReference 
MReferenceableElement 
MReferenceParameter 
MRelevantElement 
MStaticValue 
MTrigger 
MTypedElement 
MTypedElementReference 
MTypedElementSet 
MTypedElementSetReference 
MUnique 


element agent
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MBDIAgent
children imports capabilities beliefs goals plans events expressions properties initialstates
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
package  xs:string  optional      
documentation The package to which this capability belongs.
abstract  xs:boolean  optional  false    
documentation When a capability is declared as abstract, it cannot be used directly for execution. Instead there need to be some implementation for this capability that will be resolved from the capability identifier.
propertyfile  xs:string  optional  jadex.config.runtime    
annotation
documentation Defines a new agent type.

element capability
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MCapability
children imports capabilities beliefs goals plans events expressions properties initialstates
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
package  xs:string  optional      
documentation The package to which this capability belongs.
abstract  xs:boolean  optional  false    
documentation When a capability is declared as abstract, it cannot be used directly for execution. Instead there need to be some implementation for this capability that will be resolved from the capability identifier.
annotation
documentation Defines a new capability type.

element properties
diagram
namespace http://jadex.sourceforge.net/jadex
type MPropertybase
children property
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Defines a new property file.

complexType MAchieveGoal
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MGoal
children assignto parameter parameterset unique creationcondition contextcondition dropcondition deliberation targetcondition failurecondition
used by
element MGoalbase/achievegoal
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
retry  xs:boolean    true    
documentation The retry flag can be used to determine the behaviour on plan failures. If retry is turned on (by default it is on) and a plan fails to achieve the considered goal another plan from the applicables plan list will be chosen for execution.
metalevelreasoning  xs:boolean    true    
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given goal. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean    false    
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
retrydelay  xs:long    0    
documentation With the retrydelay the delay between the failure of one plan and the execution of the next plan can be specified in milliseconds.
exclude  xs:string    when_tried    
documentation The exclude flag can be specified when a plan will be excluded from the applicable plan list. The default is when_tried, which means that a candidate is excluded independently of its state when executed one time for a goal. Other options are when_succeeded, when_failed and never.
posttoall  xs:boolean    false    
documentation When post-to-all is set to true (default is false), a goal is dispatched to all candidates of the applicable plan list at once. This process will only happen one time regardless of the retry settings. A post-to-all goal has implicit or semantics meaning that if one plan achieves the goal all others will be terminated.
annotation
documentation An achieve goal aims at bringing about a target state.

element MAchieveGoal/targetcondition
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported    prohibited      
evaluationmode    prohibited      
class    prohibited      
trigger    prohibited      
annotation
documentation The target condition can be used to specify a desired world state representing goal success.

element MAchieveGoal/failurecondition
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported    prohibited      
evaluationmode    prohibited      
class    prohibited      
trigger    prohibited      
annotation
documentation Can be used to explicitly state when a goal cannot be pursued any longer and is failed.

complexType MAchieveGoalReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MGoalReference
children assignto concrete abstract parameterref parametersetref deliberation
used by
element MGoalbase/achievegoalref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Reference to an achieve goal.

complexType MAssign
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElement
used by
elements MMetaGoalDummy/assignto MDummyPlan/assignto MParameter/assignto MParameterSet/assignto MReferenceableElement/assignto MPlanTrigger/beliefchange MPlanTrigger/beliefsetchange MElementReference/concrete MPlanTrigger/factadded MPlanTrigger/factremoved MPlanParameter/goalmapping MPlanParameterSet/goalmapping MPlanParameter/internaleventmapping MPlanParameterSet/internaleventmapping MPlanParameter/messageeventmapping MPlanParameterSet/messageeventmapping
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.
annotation
documentation Used to define a reference to another element.

complexType MBase
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElement
used by
complexTypes MBeliefbase MEventbase MExpressionbase MGoalbase MPlanbase MPropertybase
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Base type for all bases, e.g. beliefbase, planbase, goalbase, etc.

complexType MBDIAgent
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MCapability
children imports capabilities beliefs goals plans events expressions properties initialstates
used by
element agent
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
package  xs:string  optional      
documentation The package to which this capability belongs.
abstract  xs:boolean  optional  false    
documentation When a capability is declared as abstract, it cannot be used directly for execution. Instead there need to be some implementation for this capability that will be resolved from the capability identifier.
propertyfile  xs:string  optional  jadex.config.runtime    
annotation
documentation Base type for a Jadex BDI agent.

complexType MBelief
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MTypedElement
children assignto fact
used by
element MBeliefbase/belief
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string  required      
documentation The required Java class of the fact. Used for type checking objects that are asserted as facts.
updaterate  xs:long  optional  0    
documentation For dynamic expressions the update rate defines in what intervals the fact will be re-evaluated. The default update rate is set to 0.
transient  xs:boolean  optional  false    
documentation Transient beliefs or prameter values are not retained, when persisting or migrating an agent. This is useful e.g. when a value class is not serializable.
annotation
documentation A belief represents a single-valued piece of information.

element MBelief/fact
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalExpression
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
annotation
documentation An expression that represents the default value. Per default it is static, i.e. it is only evalued only once on creation.

complexType MBeliefbase
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MBase
children belief beliefset beliefref beliefsetref
used by
element MCapability/beliefs
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Container for beliefs, beliefsets and corresponding references.

element MBeliefbase/belief
diagram
namespace http://jadex.sourceforge.net/jadex
type MBelief
children assignto fact
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string  required      
documentation The required Java class of the fact. Used for type checking objects that are asserted as facts.
updaterate  xs:long  optional  0    
documentation For dynamic expressions the update rate defines in what intervals the fact will be re-evaluated. The default update rate is set to 0.
transient  xs:boolean  optional  false    
documentation Transient beliefs or prameter values are not retained, when persisting or migrating an agent. This is useful e.g. when a value class is not serializable.
annotation
documentation A single-valued piece of agent knowlegde.

element MBeliefbase/beliefset
diagram
namespace http://jadex.sourceforge.net/jadex
type MBeliefSet
children assignto fact facts
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string  required      
documentation The required Java class of the fact. Used for type checking objects that are asserted as facts.
updaterate  xs:long  optional  0    
documentation For dynamic expressions the update rate defines in what intervals the fact will be re-evaluated. The default update rate is set to 0.
transient  xs:boolean  optional  false    
documentation Transient beliefs or prameter values are not retained, when persisting or migrating an agent. This is useful e.g. when a value class is not serializable.
annotation
documentation A multi-valued piece of agent knowlegde.

element MBeliefbase/beliefref
diagram
namespace http://jadex.sourceforge.net/jadex
type MBeliefReference
children assignto concrete abstract
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string        
documentation The class of the contained value. In the reference this value can be overridden to allow specializations for derived types.
annotation
documentation A concrete reference to a belief(ref) in another capability (concrete) or an abstract belief that needs assigment from the using capability.

element MBeliefbase/beliefsetref
diagram
namespace http://jadex.sourceforge.net/jadex
type MBeliefSetReference
children assignto concrete abstract
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string        
documentation The class of the contained value. In the reference this value can be overridden to allow specializations for derived types.
annotation
documentation A concrete reference to a beliefset(ref) in another capability (concrete) or an abstract beliefset that needs assigment from the using capability.

complexType MBeliefReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MTypedElementReference
children assignto concrete abstract
used by
element MBeliefbase/beliefref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string        
documentation The class of the contained value. In the reference this value can be overridden to allow specializations for derived types.
annotation
documentation Reference to a belief.

complexType MBeliefSet
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MTypedElementSet
children assignto fact facts
used by
element MBeliefbase/beliefset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string  required      
documentation The required Java class of the fact. Used for type checking objects that are asserted as facts.
updaterate  xs:long  optional  0    
documentation For dynamic expressions the update rate defines in what intervals the fact will be re-evaluated. The default update rate is set to 0.
transient  xs:boolean  optional  false    
documentation Transient beliefs or prameter values are not retained, when persisting or migrating an agent. This is useful e.g. when a value class is not serializable.
annotation
documentation A belief represents a multi-valued piece of information.

element MBeliefSet/fact
diagram
namespace http://jadex.sourceforge.net/jadex
type MStaticValue
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
evaluationmode    prohibited      
annotation
documentation An expression that evaluated to a default value. Only static values are allowed, i.e. it is only evaluated once on creation.

element MBeliefSet/facts
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalExpression
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
annotation
documentation An expression that is evaluated to a set of default values. Per default it is static, i.e. it is only evalued only once on creation.

complexType MBeliefSetReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MTypedElementSetReference
children assignto concrete abstract
used by
element MBeliefbase/beliefsetref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string        
documentation The class of the contained value. In the reference this value can be overridden to allow specializations for derived types.
annotation
documentation Reference to a belief set.

complexType MBindingCondition
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInternalCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
used by
elements MPlanTrigger/condition MGoal/creationcondition
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported    prohibited      
evaluationmode    prohibited      
class    prohibited      
trigger    prohibited      
annotation
documentation A condition used for binding purposes (multiple variable assignmnets).

complexType MCapability
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElement
children imports capabilities beliefs goals plans events expressions properties initialstates
used by
element capability
complexType MBDIAgent
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
package  xs:string  optional      
documentation The package to which this capability belongs.
abstract  xs:boolean  optional  false    
documentation When a capability is declared as abstract, it cannot be used directly for execution. Instead there need to be some implementation for this capability that will be resolved from the capability identifier.
annotation
documentation Base type for a capability.

element MCapability/imports
diagram
namespace http://jadex.sourceforge.net/jadex
children import
annotation
documentation In the imports section single classes, packages and Capability files and packages can be imported with arbitrarily many import statements. Once imported the short Class resp. Capability name can be used to refer to such an element.

element MCapability/imports/import
diagram
namespace http://jadex.sourceforge.net/jadex
type xs:string
annotation
documentation An import statement allows to import one class, package resp. Capability file.

element MCapability/capabilities
diagram
namespace http://jadex.sourceforge.net/jadex
children capability
annotation
documentation In the capabilities section arbitrary many capabilities can be declared. The functionality of a capability can be used within the agent resp. capability.

element MCapability/capabilities/capability
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MCapabilityReference
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
file  xs:string  required      
documentation The capability to include. The file can be either referenced by an unqualified or qualified name, e.g. name or package.name, or by a filename relative to the classpath, e.g., package/name.capability.xml. Abstract capabilities like the DF capability have to be referenced by the fully qualified name (i.e., jadex.planlib.DF), because these capabilities are resolved by this identifier using the platform configuration.
annotation
documentation A capability usage declaration must include the local name of this capability (symbolic name) and the capability's type name (file) or an identifier for its identification.

element MCapability/beliefs
diagram
namespace http://jadex.sourceforge.net/jadex
type MBeliefbase
children belief beliefset beliefref beliefsetref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation In the beliefs section single-valued beliefs or multi-valued belief-references can be declared. Additionally references to exported or abstract beliefs of other capabilities can be specified.

element MCapability/goals
diagram
namespace http://jadex.sourceforge.net/jadex
type MGoalbase
children performgoal achievegoal querygoal maintaingoal metagoal performgoalref achievegoalref querygoalref maintaingoalref metagoalref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation In this section different kinds of goals and goal references can be specified. Supported goal types are perform, achieve, query, maintain and meta goals. Also refernces for all types can be specified.

element MCapability/plans
diagram
namespace http://jadex.sourceforge.net/jadex
type MPlanbase
children plan
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation In this section plans can be specified.

element MCapability/events
diagram
namespace http://jadex.sourceforge.net/jadex
type MEventbase
children internalevent messageevent goalevent internaleventref messageeventref goaleventref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation In this section internal and message events can be specified. Also references for both can be declared.

element MCapability/expressions
diagram
namespace http://jadex.sourceforge.net/jadex
type MExpressionbase
children expression condition expressionref conditionref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation In this section predefined expressions and conditions can be declared. Also references for both can be declared.

element MCapability/properties
diagram
namespace http://jadex.sourceforge.net/jadex
type MPropertybase
children property
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation In this section arbitrary properties can be specified.

element MCapability/initialstates
diagram
namespace http://jadex.sourceforge.net/jadex
type MInitialStatebase
children initialstate
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
default  xs:string  optional      
documentation The default initial state name. Will be used to choose the initial state among multiple initial state definitions. If no default is explicitly stated, the first will be selected.
annotation
documentation In this section arbitrary many initial capability states can be defined. Such a state is used for initialization when an agent is born.

complexType MCapabilityReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElement
used by
element MCapability/capabilities/capability
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
file  xs:string  required      
documentation The capability to include. The file can be either referenced by an unqualified or qualified name, e.g. name or package.name, or by a filename relative to the classpath, e.g., package/name.capability.xml. Abstract capabilities like the DF capability have to be referenced by the fully qualified name (i.e., jadex.planlib.DF), because these capabilities are resolved by this identifier using the platform configuration.
annotation
documentation Describes and defines an included capability.

complexType MCondition
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MExpression
children assignto parameter relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
used by
element MExpressionbase/condition
complexType MInternalCondition
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
trigger  xs:string  optional      
documentation The trigger specifies the circumstances under which a condition triggers. Possible settings are changes_to_true, changes_to_false, is_true, is_false, changes and always.
annotation
documentation An expression that is monitored.

complexType MConditionReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MExpressionReference
children assignto concrete abstract
used by
element MExpressionbase/conditionref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Reference to a condition.

complexType MDeliberation
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElement
children inhibits
used by
elements MGoal/deliberation MMetaGoalDummy/deliberation MGoalReference/deliberation
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
cardinality  xs:int  optional  -1    
documentation The cardinality specifies how many active goal instances of the given type can exist. The default is -1 meaning that a unlimited number of goals are permitted being active.
annotation
documentation Easy deliberation settings for goals (cardinality and inhibitions).

element MDeliberation/inhibits
diagram
namespace http://jadex.sourceforge.net/jadex
type MInhibits
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
ref  xs:string  required      
documentation The name of the goal to inhibit.
inhibit  xs:string  optional  when_active    
documentation In which state other goals should be inhibited. The default is when_active. For maintain this should normally be changed to when_in_process as maintain goals are homeostatic and active longer than other goal types.
annotation
documentation Any number of inhibitions can be specified. One inhibition specifies under which circumstances a referenced goal is inhibited.

complexType MDummyPlan
diagram
namespace http://jadex.sourceforge.net/jadex
type restriction of MParameterElement
children assignto
used by
complexType MPlan
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Used only internally.

element MDummyPlan/assignto
diagram
namespace http://jadex.sourceforge.net/jadex
type MAssign
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.
annotation
documentation Assign this element to an abstract element of another capability.

complexType MElement
diagram
namespace http://jadex.sourceforge.net/jadex
used by
complexTypes MAssign MBase MCapability MCapabilityReference MDeliberation MExpressionParameter MInitialBase MInitialElement MInitialState MReference MReferenceableElement MReferenceParameter MRelevantElement MTrigger MUnique
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Base type for all model elements.

complexType MElementReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MReferenceableElement
children assignto concrete abstract
used by
complexTypes MExpressionReference MParameterElementReference MPlanReference MTypedElementReference MTypedElementSetReference
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Base type for element references, i.e. elements that reference others.

element MElementReference/concrete
diagram
namespace http://jadex.sourceforge.net/jadex
type MAssign
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.
annotation
documentation A concrete reference to an element that is conatined in some included subcapability. Dot notation is used for referencing the other element, e.g. subcapname.elemname

element MElementReference/abstract
diagram
namespace http://jadex.sourceforge.net/jadex
attributes
Name  Type  Use  Default  Fixed  Annotation
required  xs:boolean  optional  true    
documentation If an abstract element is required, a capability wants to use this capability is forced to assign an element to this abstract reference. Per default abstract alements are required.
annotation
documentation The reference is abstract. This means that an outer capability can assign an element to this reference. If required this assignment is needed. Otherwise the element can potentially be unbounded.

complexType MEvent
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MParameterElement
children assignto parameter parameterset
used by
complexTypes MGoalEvent MInternalEvent MMessageEvent
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
posttoall  xs:boolean  optional      
documentation When post-to-all is set to true (default is true only for internal events), an event is dispatched to all candidates of the applicable plan list at once.
metalevelreasoning  xs:boolean  optional      
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given event. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean  optional      
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
annotation
documentation Base type for all events.

complexType MEventbase
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MBase
children internalevent messageevent goalevent internaleventref messageeventref goaleventref
used by
element MCapability/events
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Container for internal, message events and corresponding references.

element MEventbase/internalevent
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalEvent
children assignto parameter parameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
posttoall  xs:boolean  optional      
documentation When post-to-all is set to true (default is true only for internal events), an event is dispatched to all candidates of the applicable plan list at once.
metalevelreasoning  xs:boolean  optional      
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given event. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean  optional      
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
annotation
documentation An internal event is used for agent internal event notification. It represents a one-way information flow as the event thrower cannot obtain information about the result of event processing.

element MEventbase/messageevent
diagram
namespace http://jadex.sourceforge.net/jadex
type MMessageEvent
children assignto parameter parameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
posttoall  xs:boolean  optional      
documentation When post-to-all is set to true (default is true only for internal events), an event is dispatched to all candidates of the applicable plan list at once.
metalevelreasoning  xs:boolean  optional      
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given event. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean  optional      
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
direction  xs:string  optional  send_receive    
documentation Specifies the direction of the message. Possible values are send, receive and send_receive.
type  xs:string  required      
documentation The message type defines the predefined names and types of parameters. Possible values are fipa.
annotation
documentation A message event is used for inter-agent communication.

element MEventbase/goalevent
diagram
namespace http://jadex.sourceforge.net/jadex
type MGoalEvent
children assignto parameter parameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
posttoall  xs:boolean  optional      
documentation When post-to-all is set to true (default is true only for internal events), an event is dispatched to all candidates of the applicable plan list at once.
metalevelreasoning  xs:boolean  optional      
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given event. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean  optional      
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
annotation
documentation Do not use. Is only used system internally.

element MEventbase/internaleventref
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalEventReference
children assignto concrete abstract parameterref parametersetref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation A concrete reference to an internalevent(ref) in another capability (concrete) or an abstract event that needs assigment from the using capability.

element MEventbase/messageeventref
diagram
namespace http://jadex.sourceforge.net/jadex
type MMessageEventReference
children assignto concrete abstract parameterref parametersetref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation A concrete reference to an messageevent(ref) in another capability (concrete) or an abstract event that needs assigment from the using capability.

element MEventbase/goaleventref
diagram
namespace http://jadex.sourceforge.net/jadex
type MGoalEventReference
children assignto concrete abstract parameterref parametersetref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Do not use. Is only used system internally.

complexType MEventReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MParameterElementReference
children assignto concrete abstract parameterref parametersetref
used by
complexTypes MGoalEventReference MInternalEventReference MMessageEventReference
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Reference to an event.

complexType MExpression
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MReferenceableElement
children assignto parameter relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
used by
element MExpressionbase/expression
complexTypes MCondition MInternalExpression
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
annotation
documentation A piece a program code that is evaluated.

element MExpression/parameter
diagram
namespace http://jadex.sourceforge.net/jadex
type MExpressionParameter
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
class  xs:string  required      
documentation The Java class of the user-defined parameter.
annotation
documentation Any number of typed expression parameters. For evaluation specific parameter values have to be provieded. Allows parametrized queries being specified.

element MExpression/relevantbelief
diagram
namespace http://jadex.sourceforge.net/jadex
type MRelevantElement
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
eventtype  xs:string  optional      
documentation The eventtype that is of interest for the expression/condition that specifies the relevant element.
ref  xs:string  required      
documentation The name of the referenced element that is relevant for the expression/condition that specifies the relevant element.
annotation
documentation Any number of beliefs that should cause a re-evaluation of this expression.

element MExpression/relevantbeliefset
diagram
namespace http://jadex.sourceforge.net/jadex
type MRelevantElement
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
eventtype  xs:string  optional      
documentation The eventtype that is of interest for the expression/condition that specifies the relevant element.
ref  xs:string  required      
documentation The name of the referenced element that is relevant for the expression/condition that specifies the relevant element.
annotation
documentation Any number of belief sets that should cause a re-evaluation of this expression.

element MExpression/relevantgoal
diagram
namespace http://jadex.sourceforge.net/jadex
type MRelevantElement
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
eventtype  xs:string  optional      
documentation The eventtype that is of interest for the expression/condition that specifies the relevant element.
ref  xs:string  required      
documentation The name of the referenced element that is relevant for the expression/condition that specifies the relevant element.
annotation
documentation Any number of goals that should cause a re-evaluation of this expression.

element MExpression/relevantparameter
diagram
namespace http://jadex.sourceforge.net/jadex
type MRelevantElement
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
eventtype  xs:string  optional      
documentation The eventtype that is of interest for the expression/condition that specifies the relevant element.
ref  xs:string  required      
documentation The name of the referenced element that is relevant for the expression/condition that specifies the relevant element.
annotation
documentation Any number of parameters that should cause a re-evaluation of this expression.

element MExpression/relevantparameterset
diagram
namespace http://jadex.sourceforge.net/jadex
type MRelevantElement
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
eventtype  xs:string  optional      
documentation The eventtype that is of interest for the expression/condition that specifies the relevant element.
ref  xs:string  required      
documentation The name of the referenced element that is relevant for the expression/condition that specifies the relevant element.
annotation
documentation Any number of parameter sets that should cause a re-evaluation of this expression.

complexType MExpressionbase
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MBase
children expression condition expressionref conditionref
used by
element MCapability/expressions
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Container for expressions, conditions and corresponding references.

element MExpressionbase/expression
diagram
namespace http://jadex.sourceforge.net/jadex
type MExpression
children assignto parameter relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
annotation
documentation An expression can be used for information querying. Parametrized expressions need explicitly to defined their input parameters.

element MExpressionbase/condition
diagram
namespace http://jadex.sourceforge.net/jadex
type MCondition
children assignto parameter relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
trigger  xs:string  optional      
documentation The trigger specifies the circumstances under which a condition triggers. Possible settings are changes_to_true, changes_to_false, is_true, is_false, changes and always.
annotation
documentation A condition can be used for waiting for certain world states. Parametrized conditions need explicitly to defined their input parameters.

element MExpressionbase/expressionref
diagram
namespace http://jadex.sourceforge.net/jadex
type MExpressionReference
children assignto concrete abstract
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation A concrete reference to an expression(ref) in another capability (concrete) or an abstract expression that needs assigment from the using capability.

element MExpressionbase/conditionref
diagram
namespace http://jadex.sourceforge.net/jadex
type MConditionReference
children assignto concrete abstract
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation A concrete reference to a condition(ref) in another capability (concrete) or an abstract condition that needs assigment from the using capability.

complexType MExpressionParameter
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElement
used by
element MExpression/parameter
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
class  xs:string  required      
documentation The Java class of the user-defined parameter.
annotation
documentation A user-defined parameter for an expression, e.g. for parametrized queries.

complexType MExpressionReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElementReference
children assignto concrete abstract
used by
element MExpressionbase/expressionref
complexType MConditionReference
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Reference to an expression.

complexType MGoal
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MParameterElement
children assignto parameter parameterset unique creationcondition contextcondition dropcondition deliberation
used by
complexTypes MAchieveGoal MMaintainGoal MPerformGoal MQueryGoal
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
retry  xs:boolean    true    
documentation The retry flag can be used to determine the behaviour on plan failures. If retry is turned on (by default it is on) and a plan fails to achieve the considered goal another plan from the applicables plan list will be chosen for execution.
metalevelreasoning  xs:boolean    true    
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given goal. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean    false    
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
retrydelay  xs:long    0    
documentation With the retrydelay the delay between the failure of one plan and the execution of the next plan can be specified in milliseconds.
exclude  xs:string    when_tried    
documentation The exclude flag can be specified when a plan will be excluded from the applicable plan list. The default is when_tried, which means that a candidate is excluded independently of its state when executed one time for a goal. Other options are when_succeeded, when_failed and never.
posttoall  xs:boolean    false    
documentation When post-to-all is set to true (default is false), a goal is dispatched to all candidates of the applicable plan list at once. This process will only happen one time regardless of the retry settings. A post-to-all goal has implicit or semantics meaning that if one plan achieves the goal all others will be terminated.
annotation
documentation Base type for all goals.

element MGoal/unique
diagram
namespace http://jadex.sourceforge.net/jadex
type MUnique
children exclude
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation If a goal is declared unique only one instance of this type is allowed being adopted at any one time. To determine if two goals are equal the type and parameters are used. Parameters that should not be considered can explicitly be excluded.

element MGoal/creationcondition
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MBindingCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported    prohibited      
evaluationmode    prohibited      
class    prohibited      
trigger    prohibited      
annotation
documentation A condition that creates a new goal of the given type when triggered. If binding-parameters are used for each possible binding a new goal is created.

element MGoal/contextcondition
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported    prohibited      
evaluationmode    prohibited      
class    prohibited      
trigger    prohibited      
annotation
documentation The context condition is checked during the whole execution time of a goal. If it becomes invalid the goal will become suspended and is not actively pursued until reactivation.

element MGoal/dropcondition
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported    prohibited      
evaluationmode    prohibited      
class    prohibited      
trigger    prohibited      
annotation
documentation If the dropcondition triggers the goal instance is dropped.

element MGoal/deliberation
diagram
namespace http://jadex.sourceforge.net/jadex
type MDeliberation
children inhibits
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
cardinality  xs:int  optional  -1    
documentation The cardinality specifies how many active goal instances of the given type can exist. The default is -1 meaning that a unlimited number of goals are permitted being active.
annotation
documentation The goal deliberation setting for the easy deliberation strategy.

complexType MGoalbase
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MBase
children performgoal achievegoal querygoal maintaingoal metagoal performgoalref achievegoalref querygoalref maintaingoalref metagoalref
used by
element MCapability/goals
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Container for goals and corresponding references.

element MGoalbase/performgoal
diagram
namespace http://jadex.sourceforge.net/jadex
type MPerformGoal
children assignto parameter parameterset unique creationcondition contextcondition dropcondition deliberation
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
retry  xs:boolean    true    
documentation The retry flag can be used to determine the behaviour on plan failures. If retry is turned on (by default it is on) and a plan fails to achieve the considered goal another plan from the applicables plan list will be chosen for execution.
metalevelreasoning  xs:boolean    true    
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given goal. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean    false    
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
retrydelay  xs:long    0    
documentation With the retrydelay the delay between the failure of one plan and the execution of the next plan can be specified in milliseconds.
exclude  xs:string    when_tried    
documentation The exclude flag can be specified when a plan will be excluded from the applicable plan list. The default is when_tried, which means that a candidate is excluded independently of its state when executed one time for a goal. Other options are when_succeeded, when_failed and never.
posttoall  xs:boolean    false    
documentation When post-to-all is set to true (default is false), a goal is dispatched to all candidates of the applicable plan list at once. This process will only happen one time regardless of the retry settings. A post-to-all goal has implicit or semantics meaning that if one plan achieves the goal all others will be terminated.
annotation
documentation A perform goal is goal that is directly associalted with actions to perform.

element MGoalbase/achievegoal
diagram
namespace http://jadex.sourceforge.net/jadex
type MAchieveGoal
children assignto parameter parameterset unique creationcondition contextcondition dropcondition deliberation targetcondition failurecondition
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
retry  xs:boolean    true    
documentation The retry flag can be used to determine the behaviour on plan failures. If retry is turned on (by default it is on) and a plan fails to achieve the considered goal another plan from the applicables plan list will be chosen for execution.
metalevelreasoning  xs:boolean    true    
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given goal. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean    false    
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
retrydelay  xs:long    0    
documentation With the retrydelay the delay between the failure of one plan and the execution of the next plan can be specified in milliseconds.
exclude  xs:string    when_tried    
documentation The exclude flag can be specified when a plan will be excluded from the applicable plan list. The default is when_tried, which means that a candidate is excluded independently of its state when executed one time for a goal. Other options are when_succeeded, when_failed and never.
posttoall  xs:boolean    false    
documentation When post-to-all is set to true (default is false), a goal is dispatched to all candidates of the applicable plan list at once. This process will only happen one time regardless of the retry settings. A post-to-all goal has implicit or semantics meaning that if one plan achieves the goal all others will be terminated.
annotation
documentation An achieve goal is a goal with a target state. To fulfill the goal the target state needs to be achieved.

element MGoalbase/querygoal
diagram
namespace http://jadex.sourceforge.net/jadex
type MQueryGoal
children assignto parameter parameterset unique creationcondition contextcondition dropcondition deliberation targetcondition failurecondition
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
retry  xs:boolean    true    
documentation The retry flag can be used to determine the behaviour on plan failures. If retry is turned on (by default it is on) and a plan fails to achieve the considered goal another plan from the applicables plan list will be chosen for execution.
metalevelreasoning  xs:boolean    true    
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given goal. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean    false    
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
retrydelay  xs:long    0    
documentation With the retrydelay the delay between the failure of one plan and the execution of the next plan can be specified in milliseconds.
exclude  xs:string    when_tried    
documentation The exclude flag can be specified when a plan will be excluded from the applicable plan list. The default is when_tried, which means that a candidate is excluded independently of its state when executed one time for a goal. Other options are when_succeeded, when_failed and never.
posttoall  xs:boolean    false    
documentation When post-to-all is set to true (default is false), a goal is dispatched to all candidates of the applicable plan list at once. This process will only happen one time regardless of the retry settings. A post-to-all goal has implicit or semantics meaning that if one plan achieves the goal all others will be terminated.
annotation
documentation A query goal is a goal for retrieving information. It has the implicit target consition that some result must be obtained for being succesfully achieved.

element MGoalbase/maintaingoal
diagram
namespace http://jadex.sourceforge.net/jadex
type MMaintainGoal
children assignto parameter parameterset unique creationcondition contextcondition dropcondition deliberation maintaincondition targetcondition
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
retry  xs:boolean    true    
documentation The retry flag can be used to determine the behaviour on plan failures. If retry is turned on (by default it is on) and a plan fails to achieve the considered goal another plan from the applicables plan list will be chosen for execution.
metalevelreasoning  xs:boolean    true    
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given goal. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean    false    
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
retrydelay  xs:long    0    
documentation With the retrydelay the delay between the failure of one plan and the execution of the next plan can be specified in milliseconds.
exclude  xs:string    when_tried    
documentation The exclude flag can be specified when a plan will be excluded from the applicable plan list. The default is when_tried, which means that a candidate is excluded independently of its state when executed one time for a goal. Other options are when_succeeded, when_failed and never.
posttoall  xs:boolean    false    
documentation When post-to-all is set to true (default is false), a goal is dispatched to all candidates of the applicable plan list at once. This process will only happen one time regardless of the retry settings. A post-to-all goal has implicit or semantics meaning that if one plan achieves the goal all others will be terminated.
recur  xs:boolean    false    
documentation The recur flag. If turned on (default is false) a maintain goal tries to reestablish the maintain state when it is unmaintainable or unknown.
recurdelay  xs:long    0    
documentation Can be used to specify the timeframe between goal failure (could not reestablish the maintain state) and a new try.
annotation
documentation A maintain goal is a goal for maintaing some target state. Whenever this state gets violated plans are executed for the goal until the state is reestablished.

element MGoalbase/metagoal
diagram
namespace http://jadex.sourceforge.net/jadex
type MMetaGoal
children assignto parameter parameterset contextcondition dropcondition deliberation targetcondition failurecondition trigger
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
retry  xs:boolean    true    
documentation The retry flag can be used to determine the behaviour on plan failures. If retry is turned on (by default it is on) and a plan fails to achieve the considered goal another plan from the applicables plan list will be chosen for execution.
metalevelreasoning  xs:boolean    true    
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given goal. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean    false    
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
retrydelay  xs:long    0    
documentation With the retrydelay the delay between the failure of one plan and the execution of the next plan can be specified in milliseconds.
exclude  xs:string    when_tried    
documentation The exclude flag can be specified when a plan will be excluded from the applicable plan list. The default is when_tried, which means that a candidate is excluded independently of its state when executed one time for a goal. Other options are when_succeeded, when_failed and never.
posttoall  xs:boolean    false    
documentation When post-to-all is set to true (default is false), a goal is dispatched to all candidates of the applicable plan list at once. This process will only happen one time regardless of the retry settings. A post-to-all goal has implicit or semantics meaning that if one plan achieves the goal all others will be terminated.
annotation
documentation A meta goal can be used for meta-level reasoning. Trigger of a meta-goal is another goal or event.

element MGoalbase/performgoalref
diagram
namespace http://jadex.sourceforge.net/jadex
type MPerformGoalReference
children assignto concrete abstract parameterref parametersetref deliberation
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation A concrete reference to a performgoal(ref) in another capability (concrete) or an abstract goal that needs assigment from the using capability.

element MGoalbase/achievegoalref
diagram
namespace http://jadex.sourceforge.net/jadex
type MAchieveGoalReference
children assignto concrete abstract parameterref parametersetref deliberation
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation A concrete reference to an achievegoal(ref) in another capability (concrete) or an abstract goal that needs assigment from the using capability.

element MGoalbase/querygoalref
diagram
namespace http://jadex.sourceforge.net/jadex
type MQueryGoalReference
children assignto concrete abstract parameterref parametersetref deliberation
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation A concrete reference to a querygoal(ref) in another capability (concrete) or an abstract goal that needs assigment from the using capability.

element MGoalbase/maintaingoalref
diagram
namespace http://jadex.sourceforge.net/jadex
type MMaintainGoalReference
children assignto concrete abstract parameterref parametersetref deliberation
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation A concrete reference to a maintaingoal(ref) in another capability (concrete) or an abstract goal that needs assigment from the using capability.

element MGoalbase/metagoalref
diagram
namespace http://jadex.sourceforge.net/jadex
type MMetaGoalReference
children assignto concrete abstract parameterref parametersetref deliberation
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation A concrete reference to a metagoal(ref) in another capability (concrete) or an abstract goal that needs assigment from the using capability.

complexType MGoalEvent
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MEvent
children assignto parameter parameterset
used by
element MEventbase/goalevent
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
posttoall  xs:boolean  optional      
documentation When post-to-all is set to true (default is true only for internal events), an event is dispatched to all candidates of the applicable plan list at once.
metalevelreasoning  xs:boolean  optional      
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given event. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean  optional      
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
annotation
documentation Base type for goal events.

complexType MGoalEventReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MEventReference
children assignto concrete abstract parameterref parametersetref
used by
element MEventbase/goaleventref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Reference to a goal event.

complexType MGoalReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MParameterElementReference
children assignto concrete abstract parameterref parametersetref deliberation
used by
complexTypes MAchieveGoalReference MMaintainGoalReference MMetaGoalReference MPerformGoalReference MQueryGoalReference
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Reference to a goal.

element MGoalReference/deliberation
diagram
namespace http://jadex.sourceforge.net/jadex
type MDeliberation
children inhibits
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
cardinality  xs:int  optional  -1    
documentation The cardinality specifies how many active goal instances of the given type can exist. The default is -1 meaning that a unlimited number of goals are permitted being active.

complexType MInhibits
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInternalExpression
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
used by
element MDeliberation/inhibits
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
ref  xs:string  required      
documentation The name of the goal to inhibit.
inhibit  xs:string  optional  when_active    
documentation In which state other goals should be inhibited. The default is when_active. For maintain this should normally be changed to when_in_process as maintain goals are homeostatic and active longer than other goal types.
annotation
documentation Easy deliberation settings for goals (inhibitions). For an inhibition with the ref attribute the name of the inhibited goal can be specified. With the inhibit attribute it can optinally also specified in which state the goal has to be to inhibit the other.

complexType MInitialBase
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElement
used by
complexTypes MInitialBeliefbase MInitialCapabilitybase MInitialEventbase MInitialGoalbase MInitialPlanbase MInitialStatebase
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Base type for initial bases.

complexType MInitialBelief
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialReferenceableElement
children fact
used by
element MInitialBeliefbase/initialbelief
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation A belief that is initialized with a defined value on capability or agent creation.

element MInitialBelief/fact
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalExpression
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
annotation
documentation An expression that is once evaluated to the initial belief value.

complexType MInitialBeliefbase
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialBase
children initialbelief initialbeliefset
used by
element MInitialState/beliefs
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Container for initial beliefs.

element MInitialBeliefbase/initialbelief
diagram
namespace http://jadex.sourceforge.net/jadex
type MInitialBelief
children fact
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation Any number of initially customized beliefs.

element MInitialBeliefbase/initialbeliefset
diagram
namespace http://jadex.sourceforge.net/jadex
type MInitialBeliefSet
children fact facts
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation Any number of initially customized belief sets.

complexType MInitialBeliefSet
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialReferenceableElement
children fact facts
used by
element MInitialBeliefbase/initialbeliefset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation A belief that is initialized with defined values on capability or agent creation.

element MInitialBeliefSet/fact
diagram
namespace http://jadex.sourceforge.net/jadex
type MStaticValue
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
evaluationmode    prohibited      
annotation
documentation An expression that is once evaluated to the initial belief value.

element MInitialBeliefSet/facts
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalExpression
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
annotation
documentation An expression that is once evaluated to the initial belief set values.

complexType MInitialCapability
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialReferenceableElement
used by
element MInitialCapabilitybase/initialcapability
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
initialstate  xs:string  required      
documentation The name of the initialstate that should be used for the initial capability.
annotation
documentation A capability that is initialized with a defined configuration on capability or agent creation.

complexType MInitialCapabilitybase
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialBase
children initialcapability
used by
element MInitialState/capabilities
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Container for initial capabilitiers.

element MInitialCapabilitybase/initialcapability
diagram
namespace http://jadex.sourceforge.net/jadex
type MInitialCapability
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
initialstate  xs:string  required      
documentation  The name of the initialstate that should be used for the initial capability.
annotation
documentation Any number of initially set up capabilities. Note that they have to reference a declared capability and can only change their initialstate.

complexType MInitialElement
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElement
used by
complexType MInitialReferenceableElement
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Base type for initial elements.

complexType MInitialEventbase
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialBase
children initialinternalevent initialmessageevent
used by
element MInitialState/events
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Container for initial events.

element MInitialEventbase/initialinternalevent
diagram
namespace http://jadex.sourceforge.net/jadex
type MInitialInternalEvent
children parameter parameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation Any number of initially created internal events.

element MInitialEventbase/initialmessageevent
diagram
namespace http://jadex.sourceforge.net/jadex
type MInitialMessageEvent
children parameter parameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation Any number of initially created message events.

complexType MInitialGoal
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialParameterElement
children parameter parameterset
used by
element MInitialGoalbase/initialgoal
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation A goal that is created on capability or agent creation.

complexType MInitialGoalbase
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialBase
children initialgoal
used by
element MInitialState/goals
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Container for initial goals.

element MInitialGoalbase/initialgoal
diagram
namespace http://jadex.sourceforge.net/jadex
type MInitialGoal
children parameter parameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation Any number of initially created goals.

complexType MInitialInternalEvent
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialParameterElement
children parameter parameterset
used by
element MInitialEventbase/initialinternalevent
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation An internal event that is created on capability or agent creation.

complexType MInitialMessageEvent
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialParameterElement
children parameter parameterset
used by
element MInitialEventbase/initialmessageevent
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation A message event that is created on capability or agent creation.

complexType MInitialParameter
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialReferenceableElement
children value
used by
element MInitialParameterElement/parameter
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation An initial parameter hold an initial value for a parameter.

element MInitialParameter/value
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalExpression
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
annotation
documentation An expression that resolves to a single value.

complexType MInitialParameterElement
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialReferenceableElement
children parameter parameterset
used by
complexTypes MInitialGoal MInitialInternalEvent MInitialMessageEvent MInitialPlan
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation Base type for initial parameter elements.

element MInitialParameterElement/parameter
diagram
namespace http://jadex.sourceforge.net/jadex
type MInitialParameter
children value
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation An expression that is once evaluated to the initial parameter value.

element MInitialParameterElement/parameterset
diagram
namespace http://jadex.sourceforge.net/jadex
type MInitialParameterSet
children value values
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation An expression that is once evaluated to the initial parameter set values.

complexType MInitialParameterSet
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialReferenceableElement
children value values
used by
element MInitialParameterElement/parameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation An initial parameter hold an initial value for a parameter set.

element MInitialParameterSet/value
diagram
namespace http://jadex.sourceforge.net/jadex
type MStaticValue
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
evaluationmode    prohibited      
annotation
documentation An expression that evaluates to a single value.

element MInitialParameterSet/values
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalExpression
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
annotation
documentation An expression that resolves to a set of values. Supported are iterators, enumerations, java.util.Collections, java.util.Maps, arrays.

complexType MInitialPlan
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialParameterElement
children parameter parameterset
used by
element MInitialPlanbase/initialplan
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation A plan that is created on capability or agent creation.

complexType MInitialPlanbase
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialBase
children initialplan
used by
element MInitialState/plans
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Container for initial plans.

element MInitialPlanbase/initialplan
diagram
namespace http://jadex.sourceforge.net/jadex
type MInitialPlan
children parameter parameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation Any number of initially created plans.

complexType MInitialReferenceableElement
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialElement
used by
complexTypes MInitialBelief MInitialBeliefSet MInitialCapability MInitialParameter MInitialParameterElement MInitialParameterSet
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced model element.
annotation
documentation Base type for initial referenceable elements.

complexType MInitialState
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElement
children capabilities beliefs goals plans events
used by
element MInitialStatebase/initialstate
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Defines initial states for capabilities and agents.

element MInitialState/capabilities
diagram
namespace http://jadex.sourceforge.net/jadex
type MInitialCapabilitybase
children initialcapability
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Any number of initially customized capabilities.

element MInitialState/beliefs
diagram
namespace http://jadex.sourceforge.net/jadex
type MInitialBeliefbase
children initialbelief initialbeliefset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Any number of initially customized beliefs.

element MInitialState/goals
diagram
namespace http://jadex.sourceforge.net/jadex
type MInitialGoalbase
children initialgoal
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Any number of initially created goals.

element MInitialState/plans
diagram
namespace http://jadex.sourceforge.net/jadex
type MInitialPlanbase
children initialplan
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Any number of initially created plans.

element MInitialState/events
diagram
namespace http://jadex.sourceforge.net/jadex
type MInitialEventbase
children initialinternalevent initialmessageevent
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Any number of initially created events.

complexType MInitialStatebase
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MInitialBase
children initialstate
used by
element MCapability/initialstates
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
default  xs:string  optional      
documentation The default initial state name. Will be used to choose the initial state among multiple initial state definitions. If no default is explicitly stated, the first will be selected.
annotation
documentation Container for initial states.

element MInitialStatebase/initialstate
diagram
namespace http://jadex.sourceforge.net/jadex
type MInitialState
children capabilities beliefs goals plans events
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Any number of initial states.

complexType MInternalCondition
diagram
namespace http://jadex.sourceforge.net/jadex
type restriction of MCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
used by
elements MGoal/contextcondition MMetaGoalDummy/contextcondition MPlan/contextcondition MGoal/dropcondition MMetaGoalDummy/dropcondition MAchieveGoal/failurecondition MQueryGoal/failurecondition MMetaGoalDummy/failurecondition MMaintainGoal/maintaincondition MAchieveGoal/targetcondition MQueryGoal/targetcondition MMaintainGoal/targetcondition MMetaGoalDummy/targetcondition
complexType MBindingCondition
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  prohibited  false    
evaluationmode  xs:string  prohibited      
class  xs:string  prohibited      
trigger  xs:string  prohibited      
annotation
documentation For conditions that are not conatined in the expressionbase. Cannot be exported.

element MInternalCondition/relevantbelief
diagram
namespace http://jadex.sourceforge.net/jadex
type MRelevantElement
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
eventtype  xs:string  optional      
documentation The eventtype that is of interest for the expression/condition that specifies the relevant element.
ref  xs:string  required      
documentation The name of the referenced element that is relevant for the expression/condition that specifies the relevant element.
annotation
documentation Any number of beliefs that should cause a re-evaluation of this expression.

element MInternalCondition/relevantbeliefset
diagram
namespace http://jadex.sourceforge.net/jadex
type MRelevantElement
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
eventtype  xs:string  optional      
documentation The eventtype that is of interest for the expression/condition that specifies the relevant element.
ref  xs:string  required      
documentation The name of the referenced element that is relevant for the expression/condition that specifies the relevant element.
annotation
documentation Any number of belief sets that should cause a re-evaluation of this expression.

element MInternalCondition/relevantgoal
diagram
namespace http://jadex.sourceforge.net/jadex
type MRelevantElement
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
eventtype  xs:string  optional      
documentation The eventtype that is of interest for the expression/condition that specifies the relevant element.
ref  xs:string  required      
documentation The name of the referenced element that is relevant for the expression/condition that specifies the relevant element.
annotation
documentation Any number of goals that should cause a re-evaluation of this expression.

element MInternalCondition/relevantparameter
diagram
namespace http://jadex.sourceforge.net/jadex
type MRelevantElement
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
eventtype  xs:string  optional      
documentation The eventtype that is of interest for the expression/condition that specifies the relevant element.
ref  xs:string  required      
documentation The name of the referenced element that is relevant for the expression/condition that specifies the relevant element.
annotation
documentation Any number of parameters that should cause a re-evaluation of this expression.

element MInternalCondition/relevantparameterset
diagram
namespace http://jadex.sourceforge.net/jadex
type MRelevantElement
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
eventtype  xs:string  optional      
documentation The eventtype that is of interest for the expression/condition that specifies the relevant element.
ref  xs:string  required      
documentation The name of the referenced element that is relevant for the expression/condition that specifies the relevant element.
annotation
documentation Any number of parameter sets that should cause a re-evaluation of this expression.

complexType MInternalEvent
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MEvent
children assignto parameter parameterset
used by
element MEventbase/internalevent
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
posttoall  xs:boolean  optional      
documentation When post-to-all is set to true (default is true only for internal events), an event is dispatched to all candidates of the applicable plan list at once.
metalevelreasoning  xs:boolean  optional      
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given event. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean  optional      
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
annotation
documentation An internal event is used for agent internal event notification.

complexType MInternalEventReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MEventReference
children assignto concrete abstract parameterref parametersetref
used by
element MEventbase/internaleventref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Reference to an internal event.

complexType MInternalExpression
diagram
namespace http://jadex.sourceforge.net/jadex
type restriction of MExpression
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
used by
elements MParameter/bindingoptions MPlanParameter/bindingoptions MBelief/fact MInitialBelief/fact MBeliefSet/facts MInitialBeliefSet/facts MParameter/value MPlanParameter/value MInitialParameter/value MParameterSet/values MPlanParameterSet/values MInitialParameterSet/values
complexTypes MInhibits MStaticValue
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  prohibited  false    
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
annotation
documentation For expressions that are not conatined in the expressionbase. Cannot be exported.

element MInternalExpression/relevantbelief
diagram
namespace http://jadex.sourceforge.net/jadex
type MRelevantElement
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
eventtype  xs:string  optional      
documentation The eventtype that is of interest for the expression/condition that specifies the relevant element.
ref  xs:string  required      
documentation The name of the referenced element that is relevant for the expression/condition that specifies the relevant element.
annotation
documentation Any number of beliefs that should cause a re-evaluation of this expression.

element MInternalExpression/relevantbeliefset
diagram
namespace http://jadex.sourceforge.net/jadex
type MRelevantElement
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
eventtype  xs:string  optional      
documentation The eventtype that is of interest for the expression/condition that specifies the relevant element.
ref  xs:string  required      
documentation The name of the referenced element that is relevant for the expression/condition that specifies the relevant element.
annotation
documentation Any number of belief sets that should cause a re-evaluation of this expression.

element MInternalExpression/relevantgoal
diagram
namespace http://jadex.sourceforge.net/jadex
type MRelevantElement
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
eventtype  xs:string  optional      
documentation The eventtype that is of interest for the expression/condition that specifies the relevant element.
ref  xs:string  required      
documentation The name of the referenced element that is relevant for the expression/condition that specifies the relevant element.
annotation
documentation Any number of goals that should cause a re-evaluation of this expression.

element MInternalExpression/relevantparameter
diagram
namespace http://jadex.sourceforge.net/jadex
type MRelevantElement
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
eventtype  xs:string  optional      
documentation The eventtype that is of interest for the expression/condition that specifies the relevant element.
ref  xs:string  required      
documentation The name of the referenced element that is relevant for the expression/condition that specifies the relevant element.
annotation
documentation Any number of parameters that should cause a re-evaluation of this expression.

element MInternalExpression/relevantparameterset
diagram
namespace http://jadex.sourceforge.net/jadex
type MRelevantElement
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
eventtype  xs:string  optional      
documentation The eventtype that is of interest for the expression/condition that specifies the relevant element.
ref  xs:string  required      
documentation The name of the referenced element that is relevant for the expression/condition that specifies the relevant element.
annotation
documentation Any number of parameter sets that should cause a re-evaluation of this expression.

complexType MMaintainGoal
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MGoal
children assignto parameter parameterset unique creationcondition contextcondition dropcondition deliberation maintaincondition targetcondition
used by
element MGoalbase/maintaingoal
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
retry  xs:boolean    true    
documentation The retry flag can be used to determine the behaviour on plan failures. If retry is turned on (by default it is on) and a plan fails to achieve the considered goal another plan from the applicables plan list will be chosen for execution.
metalevelreasoning  xs:boolean    true    
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given goal. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean    false    
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
retrydelay  xs:long    0    
documentation With the retrydelay the delay between the failure of one plan and the execution of the next plan can be specified in milliseconds.
exclude  xs:string    when_tried    
documentation The exclude flag can be specified when a plan will be excluded from the applicable plan list. The default is when_tried, which means that a candidate is excluded independently of its state when executed one time for a goal. Other options are when_succeeded, when_failed and never.
posttoall  xs:boolean    false    
documentation When post-to-all is set to true (default is false), a goal is dispatched to all candidates of the applicable plan list at once. This process will only happen one time regardless of the retry settings. A post-to-all goal has implicit or semantics meaning that if one plan achieves the goal all others will be terminated.
recur  xs:boolean    false    
documentation The recur flag. If turned on (default is false) a maintain goal tries to reestablish the maintain state when it is unmaintainable or unknown.
recurdelay  xs:long    0    
documentation Can be used to specify the timeframe between goal failure (could not reestablish the maintain state) and a new try.
annotation
documentation A maintain goal aims at preserving a certain state.

element MMaintainGoal/maintaincondition
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported    prohibited      
evaluationmode    prohibited      
class    prohibited      
trigger    prohibited      
annotation
documentation The mandatory maintain condition represents a world state that should be monitored and re-established whenever it gets violated.

element MMaintainGoal/targetcondition
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported    prohibited      
evaluationmode    prohibited      
class    prohibited      
trigger    prohibited      
annotation
documentation A specalisation of the maintain condition taht should be re-established when the maintain condition is violated.

complexType MMaintainGoalReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MGoalReference
children assignto concrete abstract parameterref parametersetref deliberation
used by
element MGoalbase/maintaingoalref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Reference to a maintain goal.

complexType MMessageEvent
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MEvent
children assignto parameter parameterset
used by
element MEventbase/messageevent
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
posttoall  xs:boolean  optional      
documentation When post-to-all is set to true (default is true only for internal events), an event is dispatched to all candidates of the applicable plan list at once.
metalevelreasoning  xs:boolean  optional      
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given event. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean  optional      
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
direction  xs:string  optional  send_receive    
documentation Specifies the direction of the message. Possible values are send, receive and send_receive.
type  xs:string  required      
documentation The message type defines the predefined names and types of parameters. Possible values are fipa.
annotation
documentation A message event is used for inter-agent communication.

complexType MMessageEventReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MEventReference
children assignto concrete abstract parameterref parametersetref
used by
element MEventbase/messageeventref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Reference to a message event.

complexType MMetaGoal
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MMetaGoalDummy
children assignto parameter parameterset contextcondition dropcondition deliberation targetcondition failurecondition trigger
used by
element MGoalbase/metagoal
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
retry  xs:boolean    true    
documentation The retry flag can be used to determine the behaviour on plan failures. If retry is turned on (by default it is on) and a plan fails to achieve the considered goal another plan from the applicables plan list will be chosen for execution.
metalevelreasoning  xs:boolean    true    
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given goal. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean    false    
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
retrydelay  xs:long    0    
documentation With the retrydelay the delay between the failure of one plan and the execution of the next plan can be specified in milliseconds.
exclude  xs:string    when_tried    
documentation The exclude flag can be specified when a plan will be excluded from the applicable plan list. The default is when_tried, which means that a candidate is excluded independently of its state when executed one time for a goal. Other options are when_succeeded, when_failed and never.
posttoall  xs:boolean    false    
documentation When post-to-all is set to true (default is false), a goal is dispatched to all candidates of the applicable plan list at once. This process will only happen one time regardless of the retry settings. A post-to-all goal has implicit or semantics meaning that if one plan achieves the goal all others will be terminated.
annotation
documentation A meta goal can be used for meta-level reasoning.

element MMetaGoal/trigger
diagram
namespace http://jadex.sourceforge.net/jadex
type MTrigger
children internalevent messageevent goal filter
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation The trigger for specifying for what kinds of events this meta goal should be used.

complexType MMetaGoalDummy
diagram
namespace http://jadex.sourceforge.net/jadex
type restriction of MQueryGoal
children assignto parameter parameterset contextcondition dropcondition deliberation targetcondition failurecondition
used by
complexType MMetaGoal
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
retry  xs:boolean    true    
documentation The retry flag can be used to determine the behaviour on plan failures. If retry is turned on (by default it is on) and a plan fails to achieve the considered goal another plan from the applicables plan list will be chosen for execution.
metalevelreasoning  xs:boolean    true    
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given goal. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean    false    
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
retrydelay  xs:long    0    
documentation With the retrydelay the delay between the failure of one plan and the execution of the next plan can be specified in milliseconds.
exclude  xs:string    when_tried    
documentation The exclude flag can be specified when a plan will be excluded from the applicable plan list. The default is when_tried, which means that a candidate is excluded independently of its state when executed one time for a goal. Other options are when_succeeded, when_failed and never.
posttoall  xs:boolean    false    
documentation When post-to-all is set to true (default is false), a goal is dispatched to all candidates of the applicable plan list at once. This process will only happen one time regardless of the retry settings. A post-to-all goal has implicit or semantics meaning that if one plan achieves the goal all others will be terminated.
annotation
documentation Used only internally.

element MMetaGoalDummy/assignto
diagram
namespace http://jadex.sourceforge.net/jadex
type MAssign
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.
annotation
documentation Assign this element to an abstract element of another capability.

element MMetaGoalDummy/parameter
diagram
namespace http://jadex.sourceforge.net/jadex
type MParameter
children assignto value bindingoptions
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string  required      
documentation The required Java class of the fact. Used for type checking objects that are asserted as facts.
updaterate  xs:long  optional  0    
documentation For dynamic expressions the update rate defines in what intervals the fact will be re-evaluated. The default update rate is set to 0.
transient  xs:boolean  optional  false    
documentation Transient beliefs or prameter values are not retained, when persisting or migrating an agent. This is useful e.g. when a value class is not serializable.
optional  xs:boolean  optional  false    
documentation If a parameter is declared optional (default is false), it need not to have a value (can null).
direction  xs:string  optional  in    
documentation The direction can be used to explicitly declare e.g. result parameters (out ) or parameters that are both (inout). Per default parameters are in.
annotation
documentation Any number of parameters.

element MMetaGoalDummy/parameterset
diagram
namespace http://jadex.sourceforge.net/jadex
type MParameterSet
children assignto value values
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string  required      
documentation The required Java class of the fact. Used for type checking objects that are asserted as facts.
updaterate  xs:long  optional  0    
documentation For dynamic expressions the update rate defines in what intervals the fact will be re-evaluated. The default update rate is set to 0.
transient  xs:boolean  optional  false    
documentation Transient beliefs or prameter values are not retained, when persisting or migrating an agent. This is useful e.g. when a value class is not serializable.
optional  xs:boolean  optional  false    
documentation If a parameter is declared optional (default is false), it need not to have a value (can have 0 values).
direction  xs:string  optional  in    
documentation The direction can be used to explicitly declare e.g. result parame ters (out) or parameters that are both (inout). Per default parameters are in.
annotation
documentation Any number of parameter sets.

element MMetaGoalDummy/contextcondition
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported    prohibited      
evaluationmode    prohibited      
class    prohibited      
trigger    prohibited      
annotation
documentation The context condition is checked during the whole execution time of a goal. If it becomes invalid the goal will become suspended and is not actively pursued until reactivation.

element MMetaGoalDummy/dropcondition
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported    prohibited      
evaluationmode    prohibited      
class    prohibited      
trigger    prohibited      
annotation
documentation If the dropcondition triggers the goal instance is dropped.

element MMetaGoalDummy/deliberation
diagram
namespace http://jadex.sourceforge.net/jadex
type MDeliberation
children inhibits
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
cardinality  xs:int  optional  -1    
documentation The cardinality specifies how many active goal instances of the given type can exist. The default is -1 meaning that a unlimited number of goals are permitted being active.
annotation
documentation The goal deliberation setting for the easy deliberation strategy.

element MMetaGoalDummy/targetcondition
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported    prohibited      
evaluationmode    prohibited      
class    prohibited      
trigger    prohibited      
annotation
documentation A query goal has the implicit target condition that none of its out parameters may null.

element MMetaGoalDummy/failurecondition
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported    prohibited      
evaluationmode    prohibited      
class    prohibited      
trigger    prohibited      
annotation
documentation Can be used to explicitly state when a goal cannot be pursued any longer and is failed.

complexType MMetaGoalReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MGoalReference
children assignto concrete abstract parameterref parametersetref deliberation
used by
element MGoalbase/metagoalref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Reference to a meta goal.

complexType MParameter
diagram
namespace http://jadex.sourceforge.net/jadex
type restriction of MPlanParameter
children assignto value bindingoptions
used by
elements MMetaGoalDummy/parameter MParameterElement/parameter
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string  required      
documentation The required Java class of the fact. Used for type checking objects that are asserted as facts.
updaterate  xs:long  optional  0    
documentation For dynamic expressions the update rate defines in what intervals the fact will be re-evaluated. The default update rate is set to 0.
transient  xs:boolean  optional  false    
documentation Transient beliefs or prameter values are not retained, when persisting or migrating an agent. This is useful e.g. when a value class is not serializable.
optional  xs:boolean  optional  false    
documentation If a parameter is declared optional (default is false), it need not to have a value (can null).
direction  xs:string  optional  in    
documentation The direction can be used to explicitly declare e.g. result parameters (out ) or parameters that are both (inout). Per default parameters are in.
annotation
documentation A parameter represents a single-valued piece of information belonging to some parameter element.

element MParameter/assignto
diagram
namespace http://jadex.sourceforge.net/jadex
type MAssign
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.
annotation
documentation Assign this element to an abstract element of another capability.

element MParameter/value
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalExpression
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
annotation
documentation An expression that represents the default value. Per default it is static, i.e. it is only evalued only once on creation.

element MParameter/bindingoptions
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalExpression
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
annotation
documentation From a set of binding option values one concrete is selected per instance.

complexType MParameterElement
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MReferenceableElement
children assignto parameter parameterset
used by
complexTypes MDummyPlan MEvent MGoal
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Base type for elements that can have parameters and parameter sets.

element MParameterElement/parameter
diagram
namespace http://jadex.sourceforge.net/jadex
type MParameter
children assignto value bindingoptions
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string  required      
documentation The required Java class of the fact. Used for type checking objects that are asserted as facts.
updaterate  xs:long  optional  0    
documentation For dynamic expressions the update rate defines in what intervals the fact will be re-evaluated. The default update rate is set to 0.
transient  xs:boolean  optional  false    
documentation Transient beliefs or prameter values are not retained, when persisting or migrating an agent. This is useful e.g. when a value class is not serializable.
optional  xs:boolean  optional  false    
documentation If a parameter is declared optional (default is false), it need not to have a value (can null).
direction  xs:string  optional  in    
documentation The direction can be used to explicitly declare e.g. result parameters (out ) or parameters that are both (inout). Per default parameters are in.
annotation
documentation Any number of parameters.

element MParameterElement/parameterset
diagram
namespace http://jadex.sourceforge.net/jadex
type MParameterSet
children assignto value values
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string  required      
documentation The required Java class of the fact. Used for type checking objects that are asserted as facts.
updaterate  xs:long  optional  0    
documentation For dynamic expressions the update rate defines in what intervals the fact will be re-evaluated. The default update rate is set to 0.
transient  xs:boolean  optional  false    
documentation Transient beliefs or prameter values are not retained, when persisting or migrating an agent. This is useful e.g. when a value class is not serializable.
optional  xs:boolean  optional  false    
documentation If a parameter is declared optional (default is false), it need not to have a value (can have 0 values).
direction  xs:string  optional  in    
documentation The direction can be used to explicitly declare e.g. result parame ters (out) or parameters that are both (inout). Per default parameters are in.
annotation
documentation Any number of parameter set elements.

complexType MParameterElementReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElementReference
children assignto concrete abstract parameterref parametersetref
used by
complexTypes MEventReference MGoalReference
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Reference to a parameter element.

element MParameterElementReference/parameterref
diagram
namespace http://jadex.sourceforge.net/jadex
type MParameterReference
children assignto concrete abstract
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string        
documentation The class of the contained value. In the reference this value can be overridden to allow specializations for derived types.
annotation
documentation Any number of parameter references.

element MParameterElementReference/parametersetref
diagram
namespace http://jadex.sourceforge.net/jadex
type MParameterSetReference
children assignto concrete abstract
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string        
documentation The class of the contained value. In the reference this value can be overridden to allow specializations for derived types.
annotation
documentation Any number of parameter set references.

complexType MParameterReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MTypedElementReference
children assignto concrete abstract
used by
element MParameterElementReference/parameterref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string        
documentation The class of the contained value. In the reference this value can be overridden to allow specializations for derived types.
annotation
documentation Reference to a parameter.

complexType MParameterSet
diagram
namespace http://jadex.sourceforge.net/jadex
type restriction of MPlanParameterSet
children assignto value values
used by
elements MMetaGoalDummy/parameterset MParameterElement/parameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string  required      
documentation The required Java class of the fact. Used for type checking objects that are asserted as facts.
updaterate  xs:long  optional  0    
documentation For dynamic expressions the update rate defines in what intervals the fact will be re-evaluated. The default update rate is set to 0.
transient  xs:boolean  optional  false    
documentation Transient beliefs or prameter values are not retained, when persisting or migrating an agent. This is useful e.g. when a value class is not serializable.
optional  xs:boolean  optional  false    
documentation If a parameter is declared optional (default is false), it need not to have a value (can have 0 values).
direction  xs:string  optional  in    
documentation The direction can be used to explicitly declare e.g. result parame ters (out) or parameters that are both (inout). Per default parameters are in.
annotation
documentation A parameter set represents a multi-valued piece of information belonging to some parameter element.

element MParameterSet/assignto
diagram
namespace http://jadex.sourceforge.net/jadex
type MAssign
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.
annotation
documentation Assign this element to an abstract element of another capability.

element MParameterSet/value
diagram
namespace http://jadex.sourceforge.net/jadex
type MStaticValue
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
evaluationmode    prohibited      
annotation
documentation An expression that evaluated to a default value. Only static values are allowed, i.e. it is only evaluated once on creation.

element MParameterSet/values
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalExpression
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
annotation
documentation An expression that is evaluated to a set of default values. Per default it is static, i.e. it is only evalued only once on creation.

complexType MParameterSetReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MTypedElementSetReference
children assignto concrete abstract
used by
element MParameterElementReference/parametersetref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string        
documentation The class of the contained value. In the reference this value can be overridden to allow specializations for derived types.
annotation
documentation Reference to a parameter set.

complexType MPerformGoal
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MGoal
children assignto parameter parameterset unique creationcondition contextcondition dropcondition deliberation
used by
element MGoalbase/performgoal
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
retry  xs:boolean    true    
documentation The retry flag can be used to determine the behaviour on plan failures. If retry is turned on (by default it is on) and a plan fails to achieve the considered goal another plan from the applicables plan list will be chosen for execution.
metalevelreasoning  xs:boolean    true    
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given goal. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean    false    
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
retrydelay  xs:long    0    
documentation With the retrydelay the delay between the failure of one plan and the execution of the next plan can be specified in milliseconds.
exclude  xs:string    when_tried    
documentation The exclude flag can be specified when a plan will be excluded from the applicable plan list. The default is when_tried, which means that a candidate is excluded independently of its state when executed one time for a goal. Other options are when_succeeded, when_failed and never.
posttoall  xs:boolean    false    
documentation When post-to-all is set to true (default is false), a goal is dispatched to all candidates of the applicable plan list at once. This process will only happen one time regardless of the retry settings. A post-to-all goal has implicit or semantics meaning that if one plan achieves the goal all others will be terminated.
annotation
documentation A perform goal aims at executing actions.

complexType MPerformGoalReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MGoalReference
children assignto concrete abstract parameterref parametersetref deliberation
used by
element MGoalbase/performgoalref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Reference to a goal.

complexType MPlan
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MDummyPlan
children assignto parameter parameterset body trigger precondition contextcondition waitqueue
used by
element MPlanbase/plan
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
priority  xs:int  optional  0    
documentation The priority can be used for controlling the plan selection process (default priority is 0). Plans with higher priority have precedence for plans with lower priority.
annotation
documentation A plan contains procedural knowledge. It consits of a plan head and a plan body.

element MPlan/parameter
diagram
namespace http://jadex.sourceforge.net/jadex
type MPlanParameter
children assignto value bindingoptions internaleventmapping messageeventmapping goalmapping
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string  required      
documentation The required Java class of the fact. Used for type checking objects that are asserted as facts.
updaterate  xs:long  optional  0    
documentation For dynamic expressions the update rate defines in what intervals the fact will be re-evaluated. The default update rate is set to 0.
transient  xs:boolean  optional  false    
documentation Transient beliefs or prameter values are not retained, when persisting or migrating an agent. This is useful e.g. when a value class is not serializable.
optional  xs:boolean  optional  false    
documentation If a parameter is declared optional (default is false), it need not to have a value (can null).
direction  xs:string  optional  in    
documentation The direction can be used to explicitly declare e.g. result parameters (out ) or parameters that are both (inout). Per default parameters are in.
annotation
documentation An arbitrary number of plan parameters.

element MPlan/parameterset
diagram
namespace http://jadex.sourceforge.net/jadex
type MPlanParameterSet
children assignto value values internaleventmapping messageeventmapping goalmapping
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string  required      
documentation The required Java class of the fact. Used for type checking objects that are asserted as facts.
updaterate  xs:long  optional  0    
documentation For dynamic expressions the update rate defines in what intervals the fact will be re-evaluated. The default update rate is set to 0.
transient  xs:boolean  optional  false    
documentation Transient beliefs or prameter values are not retained, when persisting or migrating an agent. This is useful e.g. when a value class is not serializable.
optional  xs:boolean  optional  false    
documentation If a parameter is declared optional (default is false), it need not to have a value (can have 0 values).
direction  xs:string  optional  in    
documentation The direction can be used to explicitly declare e.g. result parame ters (out) or parameters that are both (inout). Per default parameters are in.
annotation
documentation An arbitrary number of plan parameter sets.

element MPlan/body
diagram
namespace http://jadex.sourceforge.net/jadex
type MPlanBody
children passed failed aborted
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
evaluationmode    prohibited      
type  xs:string  optional  standard    
documentation The type of the plan body. Default is standard. If mobile agents (migration) is required mobile plans should be used. Mobile plan do not require their own thread.
inline  xs:boolean  optional  false    
documentation Inline plans are completely defined within the ADF. This means that the body code (and optionally succeeded, failed, aborted code) is directly written into the ADF. This is very usable for small plans. Note, this feature is provided only when the Janino parser is used.
annotation
documentation The plan body. If it is a normal plan the body is interpreted as an expression that must be evaluable to a plan object. If it is an inline plan the body (passed, failed, aborted) code is directly contained in this body specification.

element MPlan/trigger
diagram
namespace http://jadex.sourceforge.net/jadex
type MPlanTrigger
children internalevent messageevent goal filter condition beliefchange beliefsetchange factadded factremoved
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation The trigger is used to determine when a plan is applicable for a given event or goal.

element MPlan/precondition
diagram
namespace http://jadex.sourceforge.net/jadex
type MStaticValue
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
evaluationmode    prohibited      
annotation
documentation Only when the precondition holds a plan can be selected for execution. During the execution of the plan the precondition is not checked any more.

element MPlan/contextcondition
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported    prohibited      
evaluationmode    prohibited      
class    prohibited      
trigger    prohibited      
annotation
documentation The context condition of a plan must be valid during the whole time of plan execution. If it becomes invalid the plan will immediately be aborted.

element MPlan/waitqueue
diagram
namespace http://jadex.sourceforge.net/jadex
type MTrigger
children internalevent messageevent goal filter
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation The waitque allows a plan instance to receive events even if it is currently running. With the waitqueue filter a plan instance can declare general interest in certain kinds of events.

complexType MPlanbase
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MBase
children plan
used by
element MCapability/plans
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Container for plans.

element MPlanbase/plan
diagram
namespace http://jadex.sourceforge.net/jadex
type MPlan
children assignto parameter parameterset body trigger precondition contextcondition waitqueue
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
priority  xs:int  optional  0    
documentation The priority can be used for controlling the plan selection process (default priority is 0). Plans with higher priority have precedence for plans with lower priority.
annotation
documentation A plan contains procedural knowledge for achieving goals or handling events. A plan consists of a head and body part. The head specifies the conditions under which the plan is applicabe whereas the body contains the concrete actions to perform.

complexType MPlanBody
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MStaticValue
children passed failed aborted
used by
element MPlan/body
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
evaluationmode    prohibited      
type  xs:string  optional  standard    
documentation The type of the plan body. Default is standard. If mobile agents (migration) is required mobile plans should be used. Mobile plan do not require their own thread.
inline  xs:boolean  optional  false    
documentation Inline plans are completely defined within the ADF. This means that the body code (and optionally succeeded, failed, aborted code) is directly written into the ADF. This is very usable for small plans. Note, this feature is provided only when the Janino parser is used.
annotation
documentation The plan body contains the code (actions) to execute.

element MPlanBody/passed
diagram
namespace http://jadex.sourceforge.net/jadex
type xs:string
annotation
documentation For inline plans only. The passed method code. This code is executed when a plan completes the body method without exception.

element MPlanBody/failed
diagram
namespace http://jadex.sourceforge.net/jadex
type xs:string
annotation
documentation For inline plans only. The failed method code. This code is executed when an uncatched exeception occurs within the plan body.

element MPlanBody/aborted
diagram
namespace http://jadex.sourceforge.net/jadex
type xs:string
annotation
documentation For inline plans only. The failed method code. This code is executed when a plan is aborted. It can either be aborted on succes, i.e. when the goal succeeds or on failure, i.e. when the goal fails.

complexType MPlanParameter
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MTypedElement
children assignto value bindingoptions internaleventmapping messageeventmapping goalmapping
used by
element MPlan/parameter
complexType MParameter
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string  required      
documentation The required Java class of the fact. Used for type checking objects that are asserted as facts.
updaterate  xs:long  optional  0    
documentation For dynamic expressions the update rate defines in what intervals the fact will be re-evaluated. The default update rate is set to 0.
transient  xs:boolean  optional  false    
documentation Transient beliefs or prameter values are not retained, when persisting or migrating an agent. This is useful e.g. when a value class is not serializable.
optional  xs:boolean  optional  false    
documentation If a parameter is declared optional (default is false), it need not to have a value (can null).
direction  xs:string  optional  in    
documentation The direction can be used to explicitly declare e.g. result parameters (out) or parameters that are both (inout). Per default parameters are in.
annotation
documentation Parameter for a plan. Additionally allows mappings being defined.

element MPlanParameter/value
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalExpression
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
annotation
documentation An expression that is the default value.

element MPlanParameter/bindingoptions
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalExpression
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
annotation
documentation From a set of binding option values one concrete is selected per plan instance. If a plan with binding options is created for each possible binding value a new plan instance is created.

element MPlanParameter/internaleventmapping
diagram
namespace http://jadex.sourceforge.net/jadex
type MAssign
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.
annotation
documentation This parameter is considered as a proxy. It is mapped to another parameter in an internal event.

element MPlanParameter/messageeventmapping
diagram
namespace http://jadex.sourceforge.net/jadex
type MAssign
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.
annotation
documentation This parameter is considered as a proxy. It is mapped to another parameter in a message event.

element MPlanParameter/goalmapping
diagram
namespace http://jadex.sourceforge.net/jadex
type MAssign
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.
annotation
documentation This parameter is considered as a proxy. It is mapped to another parameter in a goal.

complexType MPlanParameterSet
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MTypedElementSet
children assignto value values internaleventmapping messageeventmapping goalmapping
used by
element MPlan/parameterset
complexType MParameterSet
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string  required      
documentation The required Java class of the fact. Used for type checking objects that are asserted as facts.
updaterate  xs:long  optional  0    
documentation For dynamic expressions the update rate defines in what intervals the fact will be re-evaluated. The default update rate is set to 0.
transient  xs:boolean  optional  false    
documentation Transient beliefs or prameter values are not retained, when persisting or migrating an agent. This is useful e.g. when a value class is not serializable.
optional  xs:boolean  optional  false    
documentation If a parameter is declared optional (default is false), it need not to have a value (can have 0 values).
direction  xs:string  optional  in    
documentation The direction can be used to explicitly declare e.g. result parameters (out) or parameters that are both (inout). Per default parameters are in.
annotation
documentation Parameter set for a plan. Additionally allows mappings being defined.

element MPlanParameterSet/value
diagram
namespace http://jadex.sourceforge.net/jadex
type MStaticValue
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
evaluationmode    prohibited      

element MPlanParameterSet/values
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalExpression
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
evaluationmode  xs:string  optional      
documentation The evaluation mode determines if an expression is dynamic or static. If declared static it is only evaluated once (on creation).
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      

element MPlanParameterSet/internaleventmapping
diagram
namespace http://jadex.sourceforge.net/jadex
type MAssign
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.

element MPlanParameterSet/messageeventmapping
diagram
namespace http://jadex.sourceforge.net/jadex
type MAssign
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.

element MPlanParameterSet/goalmapping
diagram
namespace http://jadex.sourceforge.net/jadex
type MAssign
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.

complexType MPlanReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElementReference
children assignto concrete abstract
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Reference to a plan. Not yet used.

complexType MPlanTrigger
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MTrigger
children internalevent messageevent goal filter condition beliefchange beliefsetchange factadded factremoved
used by
element MPlan/trigger
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation The trigger for plans also reacting on conditions, belief and belief set changes.

element MPlanTrigger/condition
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MBindingCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported    prohibited      
evaluationmode    prohibited      
class    prohibited      
trigger    prohibited      

element MPlanTrigger/beliefchange
diagram
namespace http://jadex.sourceforge.net/jadex
type MAssign
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.

element MPlanTrigger/beliefsetchange
diagram
namespace http://jadex.sourceforge.net/jadex
type MAssign
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.

element MPlanTrigger/factadded
diagram
namespace http://jadex.sourceforge.net/jadex
type MAssign
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.

element MPlanTrigger/factremoved
diagram
namespace http://jadex.sourceforge.net/jadex
type MAssign
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.

complexType MPropertybase
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MBase
children property
used by
elements properties MCapability/properties
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Container for properties.

element MPropertybase/property
diagram
namespace http://jadex.sourceforge.net/jadex
type MStaticValue
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
evaluationmode    prohibited      
annotation
documentation A property can be used to specify a user defined value. It is interpreted as non-dynamic program code expression that is evaluted once on initialization.

complexType MQueryGoal
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MGoal
children assignto parameter parameterset unique creationcondition contextcondition dropcondition deliberation targetcondition failurecondition
used by
element MGoalbase/querygoal
complexType MMetaGoalDummy
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
retry  xs:boolean    true    
documentation The retry flag can be used to determine the behaviour on plan failures. If retry is turned on (by default it is on) and a plan fails to achieve the considered goal another plan from the applicables plan list will be chosen for execution.
metalevelreasoning  xs:boolean    true    
documentation The meta-level reasoning flag can be used to determine the behaviour when more than plan is applicable for a given goal. If meta-level reasoning is turned on (by default it is on) and more than one plan are applicable, meta-level reasoning is used to select among the different plan candidates. If turned on, a meta-goal will be searched and used to select among the candidates. If turned off, a simple ranking is build depending on the priority of the candidate. To further distinguish between candidates with the same priority the rank is used (plan instance -> plan -> plan waitqueue). If also the rank is equal the declaration order of plans n the ADF is used for the selection.
randomselection  xs:boolean    false    
documentation Random selection can be used to choose among applicable plans for a given goal randomly. If used this flag makes the order of plan declaration within the ADF unimportantly, i.e. only random selection is only applied to plans of the same priority and rank (cf. mlreasoning comment). The mechanism is implemented in the jadex.impl.DefaultMetaLevelReasoner.
retrydelay  xs:long    0    
documentation With the retrydelay the delay between the failure of one plan and the execution of the next plan can be specified in milliseconds.
exclude  xs:string    when_tried    
documentation The exclude flag can be specified when a plan will be excluded from the applicable plan list. The default is when_tried, which means that a candidate is excluded independently of its state when executed one time for a goal. Other options are when_succeeded, when_failed and never.
posttoall  xs:boolean    false    
documentation When post-to-all is set to true (default is false), a goal is dispatched to all candidates of the applicable plan list at once. This process will only happen one time regardless of the retry settings. A post-to-all goal has implicit or semantics meaning that if one plan achieves the goal all others will be terminated.
annotation
documentation A query goal aims at retrieving information.

element MQueryGoal/targetcondition
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported    prohibited      
evaluationmode    prohibited      
class    prohibited      
trigger    prohibited      
annotation
documentation A query goal has the implicit target condition that none of its out parameters may null.

element MQueryGoal/failurecondition
diagram
namespace http://jadex.sourceforge.net/jadex
type MInternalCondition
children relevantbelief relevantbeliefset relevantgoal relevantparameter relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported    prohibited      
evaluationmode    prohibited      
class    prohibited      
trigger    prohibited      
annotation
documentation Can be used to explicitly state when a goal cannot be pursued any longer and is failed.

complexType MQueryGoalReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MGoalReference
children assignto concrete abstract parameterref parametersetref deliberation
used by
element MGoalbase/querygoalref
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Reference to a query goal.

complexType MReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElement
children parameter
used by
elements MTrigger/goal MTrigger/internalevent MTrigger/messageevent
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element in the same capability.
annotation
documentation Reference to another element. Used in trigger to match an event or goal.

element MReference/parameter
diagram
namespace http://jadex.sourceforge.net/jadex
type MReferenceParameter
children value
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.
annotation
documentation Any number of parameters that are matched against parameters of the event/goal.

complexType MReferenceableElement
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElement
children assignto
used by
complexTypes MElementReference MExpression MParameterElement MTypedElement MTypedElementSet
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
annotation
documentation Base type for elements contained in bases. Exported elements can be used in outer capabilities.

element MReferenceableElement/assignto
diagram
namespace http://jadex.sourceforge.net/jadex
type MAssign
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.
annotation
documentation Assign this element to an abstract element of another capability.

complexType MReferenceParameter
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElement
children value
used by
element MReference/parameter
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element.
annotation
documentation A parameter value for a reference. Used in trigger to match a parameter value.

element MReferenceParameter/value
diagram
namespace http://jadex.sourceforge.net/jadex
type MStaticValue
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
evaluationmode    prohibited      
annotation
documentation The value is matched against the parameter value of the event/goal.

complexType MRelevantElement
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElement
used by
elements MExpression/relevantbelief MInternalExpression/relevantbelief MInternalCondition/relevantbelief MExpression/relevantbeliefset MInternalExpression/relevantbeliefset MInternalCondition/relevantbeliefset MExpression/relevantgoal MInternalExpression/relevantgoal MInternalCondition/relevantgoal MExpression/relevantparameter MInternalExpression/relevantparameter MInternalCondition/relevantparameter MExpression/relevantparameterset MInternalExpression/relevantparameterset MInternalCondition/relevantparameterset
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
eventtype  xs:string  optional      
documentation The eventtype that is of interest for the expression/condition that specifies the relevant element.
ref  xs:string  required      
documentation The name of the referenced element that is relevant for the expression/condition that specifies the relevant element.
annotation
documentation A relevant element can be used to define on which elements an expression depends.

complexType MStaticValue
diagram
namespace http://jadex.sourceforge.net/jadex
type restriction of MInternalExpression
used by
elements MBeliefSet/fact MInitialBeliefSet/fact MTrigger/filter MPlan/precondition MPropertybase/property MParameterSet/value MPlanParameterSet/value MReferenceParameter/value MInitialParameterSet/value
complexType MPlanBody
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
evaluationmode  xs:string  prohibited      
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported  xs:boolean  prohibited  false    
annotation
documentation For a value that is only once computed.

complexType MTrigger
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElement
children internalevent messageevent goal filter
used by
elements MMetaGoal/trigger MPlan/waitqueue
complexType MPlanTrigger
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Base trigger type allows reaction on goals, internal and message events and filters. All declared elements are considered as OR combined.

element MTrigger/internalevent
diagram
namespace http://jadex.sourceforge.net/jadex
type MReference
children parameter
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element in the same capability.
annotation
documentation Any number of internal events that are triggers.

element MTrigger/messageevent
diagram
namespace http://jadex.sourceforge.net/jadex
type MReference
children parameter
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element in the same capability.
annotation
documentation Any number of message events that are triggers.

element MTrigger/goal
diagram
namespace http://jadex.sourceforge.net/jadex
type MReference
children parameter
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
ref  xs:string  required      
documentation The name of the referenced element in the same capability.
annotation
documentation Any number of goals that are triggers.

element MTrigger/filter
diagram
namespace http://jadex.sourceforge.net/jadex
type MStaticValue
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
class  xs:string  optional      
documentation The required Java class of the expression. Used for type checking the evaluation result.
exported    prohibited      
evaluationmode    prohibited      
annotation
documentation Deprecated. Can be used to specify an arbitrary complex filter expression that must evaluate to a IFilter and will be used to check if triggers.

complexType MTypedElement
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MReferenceableElement
children assignto
used by
complexTypes MBelief MPlanParameter
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string  required      
documentation The required Java class of the fact. Used for type checking objects that are asserted as facts.
updaterate  xs:long  optional  0    
documentation For dynamic expressions the update rate defines in what intervals the fact will be re-evaluated. The default update rate is set to 0.
transient  xs:boolean  optional  false    
documentation Transient beliefs or prameter values are not retained, when persisting or migrating an agent. This is useful e.g. when a value class is not serializable.
annotation
documentation Base type for single-valued elements with a type.

complexType MTypedElementReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElementReference
children assignto concrete abstract
used by
complexTypes MBeliefReference MParameterReference
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string        
documentation The class of the contained value. In the reference this value can be overridden to allow specializations for derived types.
annotation
documentation Reference to a typed element.

complexType MTypedElementSet
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MReferenceableElement
children assignto
used by
complexTypes MBeliefSet MPlanParameterSet
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string  required      
documentation The required Java class of the fact. Used for type checking objects that are asserted as facts.
updaterate  xs:long  optional  0    
documentation For dynamic expressions the update rate defines in what intervals the fact will be re-evaluated. The default update rate is set to 0.
transient  xs:boolean  optional  false    
documentation Transient beliefs or prameter values are not retained, when persisting or migrating an agent. This is useful e.g. when a value class is not serializable.
annotation
documentation Base type for multi-valued elements with a type.

complexType MTypedElementSetReference
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElementReference
children assignto concrete abstract
used by
complexTypes MBeliefSetReference MParameterSetReference
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
exported  xs:boolean  optional  false    
documentation If an element is exported it can be referenced from an outer capability. The default for this attribute is false.
class  xs:string        
documentation The class of the contained value. In the reference this value can be overridden to allow specializations for derived types.
annotation
documentation Reference to a typed element set.

complexType MUnique
diagram
namespace http://jadex.sourceforge.net/jadex
type extension of MElement
children exclude
used by
element MGoal/unique
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string        
documentation The elements name.
description  xs:string  optional      
documentation The elements optional description text.
annotation
documentation Uniqueness settings for goals. Excluded parameters will not affect if goals are considered equal.

element MUnique/exclude
diagram
namespace http://jadex.sourceforge.net/jadex
attributes
Name  Type  Use  Default  Fixed  Annotation
parameterref  xs:string  required      
annotation
documentation Any number of excluded parameters.


XML Schema documentation generated with
XMLSPY Schema Editor http://www.altova.com/xmlspy