|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.nasa.arc.brahms.vm.api.jac.AbstractExternalActivity
public abstract class AbstractExternalActivity
The AbstractExternalActivity is an interface for external activities implemented in Java called by Brahms Java activities. The external activity can perform any Java actions. This abstract class provides access to parameters passed to Brahms Java activities, and allows for adding bindings to unbound variables passed to Brahms java activities through parameters. Any class extending from this class is required to have a constructor with as parameter an IJavaActivityCtx. The activity will be passed to the external activity by the virtual machine.
Constructor Summary | |
---|---|
AbstractExternalActivity()
Constructor, creates a new AbstractExternalActivity |
Method Summary | |
---|---|
protected void |
assertBelief(IBelief belief)
Schedules the assertion of the specified belief to the belief set of the active instance performing this activity. |
protected void |
assertFact(IFact fact)
Schedules the assertion of the specified fact into the world state including the distribution of the fact to all agents and objects. |
IStatement[] |
conclude(IConcept concept,
IAttribute attribute,
int relop,
boolean value,
int beliefcertainty,
int factcertainty)
Concludes a new IBelief and/or IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is a boolean. |
IStatement[] |
conclude(IConcept concept,
IAttribute attribute,
int relop,
double value,
int beliefcertainty,
int factcertainty)
Concludes a new IBelief and/or IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is a double. |
IStatement[] |
conclude(IConcept concept,
IAttribute attribute,
int relop,
IConcept value,
int beliefcertainty,
int factcertainty)
Concludes a new IBelief and/or IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is an IConcept. |
IStatement[] |
conclude(IConcept concept,
IAttribute attribute,
int relop,
int value,
int beliefcertainty,
int factcertainty)
Concludes a new IBelief and/or IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is an integer. |
IStatement[] |
conclude(IConcept concept,
IAttribute attribute,
int relop,
IUnknown value,
int beliefcertainty,
int factcertainty)
Concludes a new IBelief and/or IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is the value 'unknown'. |
IStatement[] |
conclude(IConcept concept,
IAttribute attribute,
int relop,
java.lang.String value,
boolean symbol,
int beliefcertainty,
int factcertainty)
Concludes a new IBelief and/or IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is a String. |
IStatement[] |
conclude(IConcept lhsConcept,
IRelation relation,
IConcept rhsConcept,
int beliefcertainty,
int factcertainty)
Concludes a new IBelief and/or IFact of the form concept relation concept. |
IStatement[] |
conclude(IConcept lhsConcept,
IRelation relation,
IConcept rhsConcept,
int truthValue,
int beliefcertainty,
int factcertainty)
Concludes a new IBelief and/or IFact of the form concept relation concept with the specified truth value. |
IStatement[] |
conclude(IConcept lhsConcept,
IRelation relation,
IUnknown rhsConcept,
int beliefcertainty,
int factcertainty)
Concludes a new IBelief and/or IFact of the form concept relation concept. |
IStatement[] |
conclude(IConcept lhsConcept,
IRelation relation,
IUnknown rhsConcept,
int truthValue,
int beliefcertainty,
int factcertainty)
Concludes a new IBelief and/or IFact of the form concept relation concept with the specified truth value. |
abstract void |
doActivity()
Executes the java activity code. |
protected IContext |
getContext()
Returns this activity's context |
protected IModel |
getModel()
Returns a reference to the model loaded in the virtual machine. |
java.lang.String |
getName()
Returns the name of this activity |
protected IParameter |
getParameter(java.lang.String name)
Returns the parameter with the specified name defined for the external activity. |
protected int |
getParameterCount()
Returns the number of parameters specified for the activity. |
protected IActiveInstance |
getPerformedBy()
Returns the active instance (agent or object) performing this activity. |
protected IVMController |
getVMController()
Returns the virtual machine's controller usable by this activity. |
protected IWorldState |
getWorldState()
Returns a reference to the world state managing the fact set. |
boolean |
isValidTruthValue(int truth)
Checks whether the specified value is a valid truth value. |
protected void |
retractBelief(IBelief belief)
Schedules the retraction of the specified belief from the belief set of the active instance performing this activity. |
protected void |
retractFact(IFact fact)
Schedules the retraction of the specified fact from the world state including the notification of the retraction to all agents and objects. |
protected void |
send(IBelief[] beliefs,
IActiveInstance agent)
Sends the specified set of beliefs to the specified agent, causing the assertion of the beliefs in the specified agent's belief set. |
protected void |
send(IBelief[] beliefs,
IActiveInstance[] agents)
Sends the specified beliefs to the specified agents, causing the assertion of the beliefs in the belief set of every agent in the list of agents. |
protected void |
send(IBelief belief,
IActiveInstance agent)
Sends the specified belief to the specified agent, causing the assertion of the belief in the specified agent's belief set. |
protected void |
send(IBelief belief,
IActiveInstance[] agents)
Sends the specified belief to the specified agents, causing the assertion of the belief in the belief set of every agent in the list of agents. |
void |
setActivity(gov.nasa.arc.brahms.common.rt.IJavaActivityCtx activity)
Sets the activity to be wrapped by this external activity. |
void |
setProperties(java.util.Properties p)
Sets the properties for the activity. |
java.lang.String |
toString()
Returns a string representation of this object |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AbstractExternalActivity()
Method Detail |
---|
public final void setActivity(gov.nasa.arc.brahms.common.rt.IJavaActivityCtx activity) throws ExternalException
activity
- the IJavaActivityCtx for the Java activity
ExternalException
- if a null activity is specified or if the external activity
already wraps another activitypublic final void setProperties(java.util.Properties p) throws ExternalException
p
- the Properties set by the virtual machine.
ExternalException
- if the properties were already set.public final java.lang.String getName() throws ExternalException
ExternalException
protected final IContext getContext()
public abstract void doActivity() throws ExternalException
doActivity
in interface IExternalActivity
ExternalException
- if an internal error occursprotected final IVMController getVMController() throws ExternalException
controller
- the virtual machine's controller
ExternalException
protected final int getParameterCount() throws ExternalException
ExternalException
- if an internal error occursprotected final IParameter getParameter(java.lang.String name) throws ExternalException
name
- the name of the requested parameter
ExternalException
- if the parameter could not be found.protected final IActiveInstance getPerformedBy() throws ExternalException
ExternalException
- if an internal error occursprotected final IModel getModel() throws ExternalException
ExternalException
- is an internal error occurs.protected final IWorldState getWorldState() throws ExternalException
ExternalException
- if an internal error occurs.public final boolean isValidTruthValue(int truth)
truth
- the truth value to be tested
public final IStatement[] conclude(IConcept concept, IAttribute attribute, int relop, IUnknown value, int beliefcertainty, int factcertainty) throws ExternalException
concept
- the IConcept for which an attribute value is specifiedattribute
- the IAttribute defined for the concept to which to assign a valuerelop
- the relational operator, one of IRelationalOperator.EQUALS or
IRelationalOperator.NOT_EQUALS.value
- the 'unknown' value to be assigned to the attributebeliefcertainty
- the percentage certainty that the belief indeed is createdfactcertainty
- the percentage certainty that the fact indeed is created
ExternalException
- if the value does not match with the attribute's
type, the attribute is not specified for the given concept. if an
invalid relational operator is specified or if the fact/belief certainty
is less than 0 or more than 100.IUnknown.UNKNOWN
public final IStatement[] conclude(IConcept concept, IAttribute attribute, int relop, int value, int beliefcertainty, int factcertainty) throws ExternalException
concept
- the IConcept for which an attribute value is specifiedattribute
- the IAttribute defined for the concept to which to assign a valuerelop
- the relational operator, one of IRelationalOperator.EQUALS or
IRelationalOperator.NOT_EQUALS.value
- the integer value to be assigned to the attributebeliefcertainty
- the percentage certainty that the belief indeed is createdfactcertainty
- the percentage certainty that the fact indeed is created
ExternalException
- if the value does not match with the attribute's
type, the attribute is not specified for the given concept. if an
invalid relational operator is specified or if the fact/belief certainty
is less than 0 or more than 100.public final IStatement[] conclude(IConcept concept, IAttribute attribute, int relop, double value, int beliefcertainty, int factcertainty) throws ExternalException
concept
- the IConcept for which an attribute value is specifiedattribute
- the IAttribute defined for the concept to which to assign a valuerelop
- the relational operator, one of IRelationalOperator.EQUALS or
IRelationalOperator.NOT_EQUALS.value
- the double value to be assigned to the attributebeliefcertainty
- the percentage certainty that the belief indeed is createdfactcertainty
- the percentage certainty that the fact indeed is created
ExternalException
- if the value does not match with the attribute's
type, the attribute is not specified for the given concept. if an
invalid relational operator is specified or if the fact/belief certainty
is less than 0 or more than 100.public final IStatement[] conclude(IConcept concept, IAttribute attribute, int relop, boolean value, int beliefcertainty, int factcertainty) throws ExternalException
concept
- the IConcept for which an attribute value is specifiedattribute
- the IAttribute defined for the concept to which to assign a valuerelop
- the relational operator, one of IRelationalOperator.EQUALS or
IRelationalOperator.NOT_EQUALS.value
- the boolean value to be assigned to the attributebeliefcertainty
- the percentage certainty that the belief indeed is createdfactcertainty
- the percentage certainty that the fact indeed is created
ExternalException
- if the value does not match with the attribute's
type, the attribute is not specified for the given concept. if an
invalid relational operator is specified or if the fact/belief certainty
is less than 0 or more than 100.public final IStatement[] conclude(IConcept concept, IAttribute attribute, int relop, java.lang.String value, boolean symbol, int beliefcertainty, int factcertainty) throws ExternalException
concept
- the IConcept for which an attribute value is specifiedattribute
- the IAttribute defined for the concept to which to assign a valuerelop
- the relational operator, one of IRelationalOperator.EQUALS or
IRelationalOperator.NOT_EQUALS.value
- the String value to be assigned to the attributesymbol
- indicates if the value is a symbol or stringbeliefcertainty
- the percentage certainty that the belief indeed is createdfactcertainty
- the percentage certainty that the fact indeed is created
ExternalException
- if the value does not match with the attribute's
type, the attribute is not specified for the given concept. if an
invalid relational operator is specified or if the fact/belief certainty
is less than 0 or more than 100.public final IStatement[] conclude(IConcept concept, IAttribute attribute, int relop, IConcept value, int beliefcertainty, int factcertainty) throws ExternalException
concept
- the IConcept for which an attribute value is specifiedattribute
- the IAttribute defined for the concept to which to assign a valuerelop
- the relational operator, one of IRelationalOperator.EQUALS or
IRelationalOperator.NOT_EQUALS.value
- the IConcept value to be assigned to the attributebeliefcertainty
- the percentage certainty that the belief indeed is createdfactcertainty
- the percentage certainty that the fact indeed is created
ExternalException
- if the value does not match with the attribute's
type, the attribute is not specified for the given concept. if an
invalid relational operator is specified or if the fact/belief certainty
is less than 0 or more than 100.public final IStatement[] conclude(IConcept lhsConcept, IRelation relation, IUnknown rhsConcept, int beliefcertainty, int factcertainty) throws ExternalException
lhsConcept
- the IConcept for which the relation is specifiedrelation
- the IRelation defined for the conceptrhsConcept
- the IUnknown value to be related to the lhsConceptbeliefcertainty
- the percentage certainty that the belief indeed is createdfactcertainty
- the percentage certainty that the fact indeed is created
ExternalException
- if the rhsConcept does not match with the relation's
type, the relation is not specified for the given lhsConcept or if the
fact/belief certainty is less than 0 or more than 100.IUnknown.UNKNOWN
public final IStatement[] conclude(IConcept lhsConcept, IRelation relation, IConcept rhsConcept, int beliefcertainty, int factcertainty) throws ExternalException
lhsConcept
- the IConcept for which the relation is specifiedrelation
- the IRelation defined for the conceptrhsConcept
- the IConcept to be related to the lhsConceptbeliefcertainty
- the percentage certainty that the belief indeed is createdfactcertainty
- the percentage certainty that the fact indeed is created
ExternalException
- if the rhsConcept does not match with the relation's
type, the relation is not specified for the given lhsConcept or if the
fact/belief certainty is less than 0 or more than 100.public final IStatement[] conclude(IConcept lhsConcept, IRelation relation, IUnknown rhsConcept, int truthValue, int beliefcertainty, int factcertainty) throws ExternalException
lhsConcept
- the IConcept for which the relation is specifiedrelation
- the IRelation defined for the conceptrhsConcept
- the IUnknown value to be related to the lhsConcepttruthValue
- the truth value of the relationship (TRUE, FALSE, UNKNOWN)beliefcertainty
- the percentage certainty that the belief indeed is createdbeliefcertainty
- the percentage certainty that the belief indeed is createdfactcertainty
- the percentage certainty that the fact indeed is created
ExternalException
- if the rhsConcept does not match with the relation's
type, the relation is not specified for the given lhsConcept or if the
fact/belief certainty is less than 0 or more than 100.IUnknown.UNKNOWN
,
ITruthValue.TRUE
,
ITruthValue.FALSE
,
ITruthValue.UNKNOWN
public final IStatement[] conclude(IConcept lhsConcept, IRelation relation, IConcept rhsConcept, int truthValue, int beliefcertainty, int factcertainty) throws ExternalException
lhsConcept
- the IConcept for which the relation is specifiedrelation
- the IRelation defined for the conceptrhsConcept
- the IConcept to be related to the lhsConcepttruthValue
- the truth value of the relationship (TRUE, FALSE, UNKNOWN)beliefcertainty
- the percentage certainty that the belief indeed is createdbeliefcertainty
- the percentage certainty that the belief indeed is createdfactcertainty
- the percentage certainty that the fact indeed is created
ExternalException
- if the rhsConcept does not match with the relation's
type, the relation is not specified for the given lhsConcept or if the
fact/belief certainty is less than 0 or more than 100.ITruthValue.TRUE
,
ITruthValue.FALSE
,
ITruthValue.UNKNOWN
protected final void assertBelief(IBelief belief) throws ExternalException
belief
- the IBelief to be asserted
ExternalException
- if an internal error occursprotected final void retractBelief(IBelief belief) throws ExternalException
belief
- the IBelief to be asserted
ExternalException
- if an internal error occursprotected final void assertFact(IFact fact) throws ExternalException
fact
- the IFact to be asserted
ExternalException
- if an internal error occursprotected final void retractFact(IFact fact) throws ExternalException
fact
- the IFact to be retracted
ExternalException
- if an internal error occursprotected final void send(IBelief belief, IActiveInstance agent) throws ExternalException
belief
- the IBelief to be send to the specified agentagent
- the IActiveInstance to which to send the belief
ExternalException
- if an internal error occurs
protected final void send(IBelief belief, IActiveInstance[] agents) throws ExternalException
belief
- the IBelief to be send to the specified agentagents
- the list of IActiveInstance to which to send the belief
ExternalException
- if an internal error occurs
protected final void send(IBelief[] beliefs, IActiveInstance agent) throws ExternalException
beliefs
- the list of IBelief to be send to the specified agentagent
- the IActiveInstance to which to send the belief
ExternalException
- if an internal error occurs
protected final void send(IBelief[] beliefs, IActiveInstance[] agents) throws ExternalException
beliefs
- the list of IBelief to be send to the specified agentsagents
- the list of IActiveInstance to which to send the beliefs
ExternalException
- if an internal error occurs
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |