gov.nasa.arc.brahms.vm.api.jagt
Class AbstractExternalAgent

java.lang.Object
  gov.nasa.arc.brahms.vm.api.jagt.AbstractExternalAgent

All Implemented Interfaces:

IExternalAgent

Direct Known Subclasses:

AbstractCommunicationAgent

public abstract class AbstractExternalAgent
extends java.lang.Object
implements IExternalAgent

The AbstractExternalAgent is an interface for external agents implemented in Java loaded into the virtual machine to participate in a simulation or real-time agent environment. The external agent can perform any Java actions. This abstract implementation provides access to the concepts loaded in the virtual machine and the world state to allow for communications with these concepts and to allow for world state changes to be triggered by this agent.

Version:

$Revision: 1.2 $ $Date: 2007/11/08 18:47:18 $ $Author: rvhoof $

Author:

Ron van Hoof

Constructor Summary

AbstractExternalAgent()
Constructor, creates a new AbstractExternalAgent

Method Summary

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.
IFact	conclude(IConcept concept, IAttribute attribute, int relop, boolean value, int factcertainty) Concludes a new IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is a boolean.
IFact	conclude(IConcept concept, IAttribute attribute, int relop, double value, int factcertainty) Concludes a new IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is a double.
IFact	conclude(IConcept concept, IAttribute attribute, int relop, IConcept value, int factcertainty) Concludes a new IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is an IConcept.
IFact	conclude(IConcept concept, IAttribute attribute, int collectionIndex, int relop, boolean value, int factcertainty) Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is a boolean.
IFact	conclude(IConcept concept, IAttribute attribute, int collectionIndex, int relop, double value, int factcertainty) Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is a double.
IFact	conclude(IConcept concept, IAttribute attribute, int collectionIndex, int relop, IConcept value, int factcertainty) Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is an IConcept.
IFact	conclude(IConcept concept, IAttribute attribute, int relop, int value, int factcertainty) Concludes a new IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is an integer.
IFact	conclude(IConcept concept, IAttribute attribute, int collectionIndex, int relop, int value, int factcertainty) Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is an integer.
IFact	conclude(IConcept concept, IAttribute attribute, int collectionIndex, int relop, IUnknown value, int factcertainty) Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is the value 'unknown'.
IFact	conclude(IConcept concept, IAttribute attribute, int collectionIndex, int relop, long value, int factcertainty) Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is an integer.
IFact	conclude(IConcept concept, IAttribute attribute, int collectionIndex, int relop, java.io.Serializable value, int factcertainty) Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is a Java Serializable Object.
IFact	conclude(IConcept concept, IAttribute attribute, int collectionIndex, int relop, java.lang.String value, boolean symbol, int factcertainty) Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is a String.
IFact	conclude(IConcept concept, IAttribute attribute, int relop, IUnknown value, int factcertainty) Concludes a new IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is the value 'unknown'.
IFact	conclude(IConcept concept, IAttribute attribute, int relop, long value, int factcertainty) Concludes a new IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is an integer.
IFact[]	conclude(IConcept concept, IAttribute attribute, int relop, java.util.Map collection, int factcertainty) Concludes new IFact(s) of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS.
IFact	conclude(IConcept concept, IAttribute attribute, int relop, java.io.Serializable value, int factcertainty) Concludes a new IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is a Java Serializable Object.
IFact	conclude(IConcept concept, IAttribute attribute, int relop, java.lang.String value, boolean symbol, int factcertainty) Concludes a new IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is a String.
IFact	conclude(IConcept concept, IAttribute attribute, java.lang.String collectionIndex, int relop, boolean value, int factcertainty) Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is a boolean.
IFact	conclude(IConcept concept, IAttribute attribute, java.lang.String collectionIndex, int relop, double value, int factcertainty) Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is a double.
IFact	conclude(IConcept concept, IAttribute attribute, java.lang.String collectionIndex, int relop, IConcept value, int factcertainty) Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is an IConcept.
IFact	conclude(IConcept concept, IAttribute attribute, java.lang.String collectionIndex, int relop, int value, int factcertainty) Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is an integer.
IFact	conclude(IConcept concept, IAttribute attribute, java.lang.String collectionIndex, int relop, IUnknown value, int factcertainty) Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is the value 'unknown'.
IFact	conclude(IConcept concept, IAttribute attribute, java.lang.String collectionIndex, int relop, long value, int factcertainty) Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is an integer.
IFact	conclude(IConcept concept, IAttribute attribute, java.lang.String collectionIndex, int relop, java.io.Serializable value, int factcertainty) Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is a Java Serializable Object.
IFact	conclude(IConcept concept, IAttribute attribute, java.lang.String collectionIndex, int relop, java.lang.String value, boolean symbol, int factcertainty) Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is a String.
IFact	conclude(IConcept lhsConcept, IRelation relation, IConcept rhsConcept, int factcertainty) Concludes a new IFact of the form concept relation concept.
IFact	conclude(IConcept lhsConcept, IRelation relation, IConcept rhsConcept, int truthValue, int factcertainty) Concludes a new IFact of the form concept relation concept with the specified truth value.
IFact	conclude(IConcept lhsConcept, IRelation relation, IUnknown rhsConcept, int factcertainty) Concludes a new IFact of the form concept relation concept.
IFact	conclude(IConcept lhsConcept, IRelation relation, IUnknown rhsConcept, int truthValue, int factcertainty) Concludes a new IFact of the form concept relation concept with the specified truth value.
protected void	deregisterForMonitoring() Deregisters this agent with the agent monitor to no longer have this agent monitored for unexpected termination and failures.
abstract void	doWork() The virtual machine takes care of having the agent run in its own thread of execution.
IAgent	getBrahmsAgent() Returns the Brahms agent reference for this agent.
IContext	getContext() Returns this activity's context
protected IModel	getModel() Returns a reference to the model loaded in the virtual machine.
int	getModeOfOperation() Returns the agent's mode of operation.
protected IVMController	getVMController() Returns the virtual machine's controller usable by this agent.
protected IWorldState	getWorldState() Returns a reference to the world state managing the fact set.
abstract void	initialize() Initialize is used to initialize the external agent after it has been loaded into the virtual machine.
boolean	isAcceptingFacts() Indicates whether the agent wants to be notified of any fact related events (assertion/retraction).
boolean	isAutoReady() Indicates whether the agent should automatically notify the scheduler it is ready for more events after it was notified of the current set of events and after onProcess was called.
boolean	isValidTruthValue(int truth) Checks whether the specified value is a valid truth value.
void	notifyNewEvents() Notifies the scheduler (only in simulation mode) that the external agent has new events ready for distribution.
abstract void	onAssert(IFact fact) onAssert is called by the virtual machine whenever a new fact is asserted in the world state.
void	onProcess(long time) onProcess is called by the virtual machine when the virtual machine is in simulation mode and the agent is notified by the scheduler that it is allowed to process any events for the specified time.
abstract void	onReceive(IBelief belief) onReceive is called by the virtual machine whenever a new belief is communicated to the external agent by another agent or object.
abstract void	onRetract(IFact fact) onRetract is called by the virtual machine whenever a fact is retracted from the world state.
void	onThreadEnd() onThreadEnd is the last method called just before the agent's thread is gracefully ending.
abstract void	pause() Pauses the external agent.
void	ready() Notifies the scheduler that the agent completed its processing and is ready to receive more events.
protected void	registerForMonitoring() Registers this agent with the agent monitor to have this agent monitored for unexpected termination and failures.
abstract void	reset() Resets the external agent to the initialized state as it was placed in using the initialize method, performing any additional clean-up if necessary.
abstract void	resume() Resumes the external agent from a pause.
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	setAcceptingFacts(boolean acceptFacts) Sets whether the agent wants to be notified of any fact related events (assertion/retraction).
void	setAgentCtx(gov.nasa.arc.brahms.common.rt.IActiveInstanceCtx agt) Sets the agent to be wrapped by this external agent.
void	setAutoReady(boolean autoReady) Indicates whether the agent should automatically notify the scheduler it is ready for more events after it was notified of the current set of events and after onProcess was called.
void	setBrahmsAgent(IAgent agent) Sets the Brahms agent reference for this agent.
void	setProperties(java.util.Properties p) Sets the properties for the activity.
void	setVMController(gov.nasa.arc.brahms.vm.controller.VMController vmc) Sets the virtual machine's controller.
abstract void	start() Starts the external agent.
abstract void	stop() Stops the external agent.
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

AbstractExternalAgent

public AbstractExternalAgent()

Constructor, creates a new AbstractExternalAgent

Method Detail

setBrahmsAgent

public void setBrahmsAgent(IAgent agent)

Sets the Brahms agent reference for this agent. This method is called by the Brahms virtual machine. The Brahms agent reference is required to notify other agents of this agent.

Specified by:

setBrahmsAgent in interface IExternalAgent

Parameters:

agent - the Brahms agent reference for this external agent

getBrahmsAgent

public IAgent getBrahmsAgent()

Returns the Brahms agent reference for this agent. This method is called by the Brahms virtual machine. The Brahms agent reference is required to notify other agents of this agent. return IAgent the Brahms agent reference for this external agent

Specified by:

getBrahmsAgent in interface IExternalAgent

setProperties

public final void setProperties(java.util.Properties p)
                         throws ExternalException

Sets the properties for the activity. The properties specify the allowed capabilities of the external activity. This method is called by the virtual machine and can not be called in the doActivity method.

Parameters:

p - the Properties set by the virtual machine.

Throws:

ExternalException - if the properties were already set.

setVMController

public final void setVMController(gov.nasa.arc.brahms.vm.controller.VMController vmc)
                           throws ExternalException

Sets the virtual machine's controller. This controller is set by the virtual machine and cannot be replaced.

Parameters:

vmc - the VMController

Throws:

ExternalException

setAgentCtx

public final void setAgentCtx(gov.nasa.arc.brahms.common.rt.IActiveInstanceCtx agt)
                       throws ExternalException

Sets the agent to be wrapped by this external agent. This method is called by the virtual machine and can not be called by the external agent.

Parameters:

agt - the IActiveInstanceCtx for the agent

Throws:

ExternalException - if a null agent is specified or if the external agent already wraps another agent

getContext

public final IContext getContext()

Returns this activity's context

Returns:

IContext the context for this activity

getModeOfOperation

public int getModeOfOperation()

Returns the agent's mode of operation. One of: SIMULATION_MODE, REALTIME_MODE or DISTRIBUTED_MODE

Returns:

int the mode of operation

See Also:

IVMController.SIMULATION_MODE, IVMController.REALTIME_MODE, IVMController.DISTRIBUTED_MODE

getVMController

protected final IVMController getVMController()
                                       throws ExternalException

Returns the virtual machine's controller usable by this agent.

Returns:

IVMController the virtual machine's controller

Throws:

ExternalException

getModel

protected final IModel getModel()
                         throws ExternalException

Returns a reference to the model loaded in the virtual machine.

Returns:

IModel the model loaded in the virtual machine.

Throws:

ExternalException - is an internal error occurs.

getWorldState

protected final IWorldState getWorldState()
                                   throws ExternalException

Returns a reference to the world state managing the fact set.

Returns:

IWorldState the virtual machine's world state

Throws:

ExternalException - if an internal error occurs.

registerForMonitoring

protected final void registerForMonitoring()

Registers this agent with the agent monitor to have this agent monitored for unexpected termination and failures.

deregisterForMonitoring

protected final void deregisterForMonitoring()

Deregisters this agent with the agent monitor to no longer have this agent monitored for unexpected termination and failures.

isValidTruthValue

public final boolean isValidTruthValue(int truth)

Checks whether the specified value is a valid truth value.

Parameters:

truth - the truth value to be tested

Returns:

true if the truth value is valid, false otherwise

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            int relop,
                            IUnknown value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is the value 'unknown'.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the value 'unknown' to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

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 certainty is less than 0 or more than 100.

See Also:

IUnknown.UNKNOWN

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            int relop,
                            int value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is an integer. The attribute's type must be int or double.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the integer value to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

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 certainty is less than 0 or more than 100.

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            int relop,
                            long value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is an integer. The attribute's type must be int or double.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the long value to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

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 certainty is less than 0 or more than 100.

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            int relop,
                            double value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is a double. The attribute's type must be double.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the double value to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

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 certainty is less than 0 or more than 100.

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            int relop,
                            boolean value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is a boolean. The attribute's type must be boolean.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the boolean value to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

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 certainty is less than 0 or more than 100.

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            int relop,
                            java.lang.String value,
                            boolean symbol,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is a String. The attribute's type must be symbol or string.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the String value to be assigned to the attribute

symbol - indicates if the value is a symbol or string

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

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 certainty is less than 0 or more than 100.

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            int relop,
                            IConcept value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is an IConcept. The attribute's type must be an IMetaType or IConcept. The attribute name must not be 'location'. The 'location' attribute's value is managed by the virtual machine.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the IConcept value to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

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 certainty is less than 0 or more than 100.

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            int relop,
                            java.io.Serializable value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute relop value where relop is one of EQUALS or NOT_EQUALS and the value is a Java Serializable Object. The attribute's type must be an IJavaType.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the Java Serializable Object to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

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 certainty is less than 0 or more than 100.

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            int collectionIndex,
                            int relop,
                            IUnknown value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is the value 'unknown'.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

collectionIndex - the index/key in the collection for the specified value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the value 'unknown' to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

ExternalException - if the attribute is not specified for the given concept, if the attribute is not of a collection type, if the collection index is invalid, if the attribute is the location attribute, if an invalid relational operator is specified or if the fact certainty is less than 0 or more than 100.

See Also:

IUnknown.UNKNOWN

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            java.lang.String collectionIndex,
                            int relop,
                            IUnknown value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is the value 'unknown'.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

collectionIndex - the index/key in the collection for the specified value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the value 'unknown' to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

ExternalException - if the attribute is not specified for the given concept, if the attribute is not of a collection type, if the collection index is invalid, if the attribute is the location attribute, if an invalid relational operator is specified or if the fact certainty is less than 0 or more than 100.

See Also:

IUnknown.UNKNOWN

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            int collectionIndex,
                            int relop,
                            int value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is an integer. The attribute's type must be int or double.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

collectionIndex - the index/key in the collection for the specified value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the integer value to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

ExternalException - if the attribute is not specified for the given concept, if the attribute is not of a collection type, if the collection index is invalid, if the attribute is the location attribute, if an invalid relational operator is specified or if the fact certainty is less than 0 or more than 100.

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            java.lang.String collectionIndex,
                            int relop,
                            int value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is an integer. The attribute's type must be int or double.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

collectionIndex - the index/key in the collection for the specified value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the integer value to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

ExternalException - if the attribute is not specified for the given concept, if the attribute is not of a collection type, if the collection index is invalid, if the attribute is the location attribute, if an invalid relational operator is specified or if the fact certainty is less than 0 or more than 100.

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            int collectionIndex,
                            int relop,
                            long value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is an integer. The attribute's type must be int or double.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

collectionIndex - the index/key in the collection for the specified value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the long value to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

ExternalException - if the attribute is not specified for the given concept, if the attribute is not of a collection type, if the collection index is invalid, if the attribute is the location attribute, if an invalid relational operator is specified or if the fact certainty is less than 0 or more than 100.

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            java.lang.String collectionIndex,
                            int relop,
                            long value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is an integer. The attribute's type must be int or double.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

collectionIndex - the index/key in the collection for the specified value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the long value to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

ExternalException - if the attribute is not specified for the given concept, if the attribute is not of a collection type, if the collection index is invalid, if the attribute is the location attribute, if an invalid relational operator is specified or if the fact certainty is less than 0 or more than 100.

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            int collectionIndex,
                            int relop,
                            double value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is a double. The attribute's type must be double.

Parameters:

concept - the IConcept for which an attribute value is specified

collectionIndex - the index/key in the collection for the specified value

attribute - the IAttribute defined for the concept to which to assign a value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the double value to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

ExternalException - if the attribute is not specified for the given concept, if the attribute is not of a collection type, if the collection index is invalid, if the attribute is the location attribute, if an invalid relational operator is specified or if the fact certainty is less than 0 or more than 100.

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            java.lang.String collectionIndex,
                            int relop,
                            double value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is a double. The attribute's type must be double.

Parameters:

concept - the IConcept for which an attribute value is specified

collectionIndex - the index/key in the collection for the specified value

attribute - the IAttribute defined for the concept to which to assign a value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the double value to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

ExternalException - if the attribute is not specified for the given concept, if the attribute is not of a collection type, if the collection index is invalid, if the attribute is the location attribute, if an invalid relational operator is specified or if the fact certainty is less than 0 or more than 100.

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            int collectionIndex,
                            int relop,
                            boolean value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is a boolean. The attribute's type must be boolean.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

collectionIndex - the index/key in the collection for the specified value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the boolean value to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

ExternalException - if the attribute is not specified for the given concept, if the attribute is not of a collection type, if the collection index is invalid, if the attribute is the location attribute, if an invalid relational operator is specified or if the fact certainty is less than 0 or more than 100.

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            java.lang.String collectionIndex,
                            int relop,
                            boolean value,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is a boolean. The attribute's type must be boolean.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

collectionIndex - the index/key in the collection for the specified value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the boolean value to be assigned to the attribute

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

ExternalException - if the attribute is not specified for the given concept, if the attribute is not of a collection type, if the collection index is invalid, if the attribute is the location attribute, if an invalid relational operator is specified or if the fact certainty is less than 0 or more than 100.

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            int collectionIndex,
                            int relop,
                            java.lang.String value,
                            boolean symbol,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is a String. The attribute's type must be symbol or string.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

collectionIndex - the index/key in the collection for the specified value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the String value to be assigned to the attribute

symbol - indicates if the value is a symbol or string

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

ExternalException - if the attribute is not specified for the given concept, if the attribute is not of a collection type, if the collection index is invalid, if the attribute is the location attribute, if an invalid relational operator is specified or if the fact certainty is less than 0 or more than 100.

conclude

public final IFact conclude(IConcept concept,
                            IAttribute attribute,
                            java.lang.String collectionIndex,
                            int relop,
                            java.lang.String value,
                            boolean symbol,
                            int factcertainty)
                     throws ExternalException

Concludes a new IFact of the form concept.attribute(index) relop value where relop is one of EQUALS or NOT_EQUALS and the value is a String. The attribute's type must be symbol or string.

Parameters:

concept - the IConcept for which an attribute value is specified

attribute - the IAttribute defined for the concept to which to assign a value

collectionIndex - the index/key in the collection for the specified value

relop - the relational operator, one of IRelationalOperator.EQUALS or IRelationalOperator.NOT_EQUALS.

value - the String value to be assigned to the attribute

symbol - indicates if the value is a symbol or string

factcertainty - the percentage certainty that the fact indeed is created

Returns:

IFact either a wrapper for the created fact that was asserted to the world state or null if no fact was created and asserted due to the fact certainty.

Throws:

ExternalException - if the attribute is not specified for the given concept, if the attribute is not of a collection type, if the collection index is invalid, if the attribute is the location attribute, if an invalid relational operator is specified or if the fact certainty is less than 0 or more than 100.

conclude

public final IFact conclude(