IActiveInstance (Brahms Agent Hosting Environment JAPI)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

gov.nasa.arc.brahms.vm.api.common
Interface IActiveInstance

All Superinterfaces:: IActiveConcept, IConcept, IType, IUserDefinedType

All Known Subinterfaces:: IAgent, IObject

public interface IActiveInstance
extends IActiveConcept
extends IActiveConcept

An ActiveInstance is a generic concept that indicates that the instance can have behavior. It is a concept that can reason with beliefs or facts and can perform activities.

Version:: $Revision: 1.3 $ $Date: 2008/02/28 19:46:50 $ $Author: rvhoof $
Author:: Ron van Hoof

Field Summary

Fields inherited from interface gov.nasa.arc.brahms.vm.api.common.IUserDefinedType
`UDT`

Method Summary
`boolean`	`acquireMemoryReference(IContext ctx)` Has the calling agent acquire a reference to this IActiveInstance indicating that it wishes to use this reference and to ensure that this IActiveInstance will not get deleted.
`void`	`assertBelief(IBelief belief, IContext ctx)` Schedules the assertion of the specified belief to the active instance's belief set.
`void`	`assertBeliefs(IBelief[] beliefs, IContext ctx)` Schedules the assertion of the specified beliefs to the active instance's belief set.
`void`	`deregisterForMonitoring()` Deregisters this agent with the agent monitor to no longer have this agent monitored for unexpected termination and failures.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, int relop, boolean value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, int relop, double value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, int relop, IConcept value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, boolean value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, double value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, IConcept value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, int relop, int value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, int value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, IUnknown value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, long value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, java.io.Serializable value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, java.lang.String value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, int relop, IUnknown value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, int relop, long value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, int relop, java.io.Serializable value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, int relop, java.lang.String value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, boolean value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, double value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, IConcept value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, int value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, IUnknown value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, long value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, java.io.Serializable value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, java.lang.String value, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IRelation relation, IConcept rhsConcept, int truthValue, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBelief(IConcept lhsConcept, IRelation relation, IUnknown rhsConcept, int truthValue, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBeliefForIndex(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`IBelief`	`getBeliefForIndex(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, IContext ctx)` Find the belief using the specified parameters and return the belief if found, null if the belief was not found.
`java.util.Enumeration`	`getBeliefs(IAttribute lhsAttribute, IContext ctx)` Returns a list of all the beliefs that have the specified attribute on their left hand side regardless of their lhs concept, relational operator or value.
`java.util.Enumeration`	`getBeliefs(IConcept lhsConcept, IAttribute lhsAttribute, IContext ctx)` Returns a list of all the beliefs that have the specified concept and attribute on their left hand side regardless of their relational operator or value.
`java.util.Enumeration`	`getBeliefs(IConcept lhsConcept, IAttribute lhsAttribute, int relop, boolean value, IContext ctx)` Returns a list of all the beliefs that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
`java.util.Enumeration`	`getBeliefs(IConcept lhsConcept, IAttribute lhsAttribute, int relop, double value, IContext ctx)` Returns a list of all the beliefs that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
`java.util.Enumeration`	`getBeliefs(IConcept lhsConcept, IAttribute lhsAttribute, int relop, IConcept value, IContext ctx)` Returns a list of all the beliefs that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
`java.util.Enumeration`	`getBeliefs(IConcept lhsConcept, IAttribute lhsAttribute, int relop, IContext ctx)` Returns a list of all the beliefs that have the specified concept and attribute on their left hand side and that use the specified relational operator.
`java.util.Enumeration`	`getBeliefs(IConcept lhsConcept, IAttribute lhsAttribute, int relop, int value, IContext ctx)` Returns a list of all the beliefs that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
`java.util.Enumeration`	`getBeliefs(IConcept lhsConcept, IAttribute lhsAttribute, int relop, IUnknown value, IContext ctx)` Returns a list of all the beliefs that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
`java.util.Enumeration`	`getBeliefs(IConcept lhsConcept, IAttribute lhsAttribute, int relop, long value, IContext ctx)` Returns a list of all the beliefs that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
`java.util.Enumeration`	`getBeliefs(IConcept lhsConcept, IAttribute lhsAttribute, int relop, java.io.Serializable value, IContext ctx)` Returns a list of all the beliefs that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
`java.util.Enumeration`	`getBeliefs(IConcept lhsConcept, IAttribute lhsAttribute, int relop, java.lang.String value, IContext ctx)` Returns a list of all the beliefs that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
`java.util.Enumeration`	`getBeliefs(IConcept lhsConcept, IRelation relation, IContext ctx)` Returns a list of all the beliefs that have the specified left hand side concept and relation regardless of their right hand side concept.
`java.util.Enumeration`	`getBeliefs(IConcept lhsConcept, IRelation relation, int truthvalue, IContext ctx)` Returns a list of all the beliefs that have the specified left hand side concept, relation and truth value regardless of their right hand side concept.
`java.util.Enumeration`	`getBeliefs(IContext ctx)` Returns the active instance's belief set.
`java.util.Enumeration`	`getBeliefs(IRelation relation, IConcept rhsConcept, int truthvalue, IContext ctx)` Returns a list of all the beliefs that have the specified relation and right hand side concept, and truth value regardless of their left hand side concept.
`java.util.Enumeration`	`getBeliefs(IRelation relation, IContext ctx)` Returns a list of all the beliefs that have the specified relation regardless of their left and right hand side concept.
`java.util.Enumeration`	`getBeliefs(IRelation relation, IUnknown rhsConcept, int truthvalue, IContext ctx)` Returns a list of all the beliefs that have the specified relation, as right hand side 'unknown', and the specified truth value regardless of their left hand side concept.
`void`	`registerForMonitoring()` Registers this agent with the agent monitor to have this agent monitored for unexpected termination and failures.
`void`	`releaseMemoryReference(IContext ctx)` Has the calling agent release a reference to this IActiveInstance indicating that it no longer wishes to use this reference and to allow for this IActiveInstance to be deleted.
`void`	`retractBelief(IBelief belief, IContext ctx)` Schedules the retraction of the specified belief from the active instance's belief set.

Methods inherited from interface gov.nasa.arc.brahms.vm.api.common.IActiveConcept
`hasThoughtframes, hasWorkframes`

Methods inherited from interface gov.nasa.arc.brahms.vm.api.common.IConcept
`getAttribute, getAttributes, getRelation, getRelations, isLocal`

Methods inherited from interface gov.nasa.arc.brahms.vm.api.common.IType
`getName, getType`

Method Detail

registerForMonitoring

void registerForMonitoring()

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

deregisterForMonitoring

void deregisterForMonitoring()

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

acquireMemoryReference

boolean acquireMemoryReference(IContext ctx)
                               throws ExternalException

Has the calling agent acquire a reference to this IActiveInstance indicating that it wishes to use this reference and to ensure that this IActiveInstance will not get deleted.

Note that multiple calls to this method will result in only one reference to be maintained for the calling agent.

This method should only be used by external agents.

Parameters:: ctx - the IContext for the acquisition providing information about the agent acquiring the reference
Returns:: boolean true if the reference could be acquired, false if this IActiveInstance is not a memory managed element.
Throws:: ExternalException - if IActiveInstance is a memory managed element and was already deleted or if an internal error occurs.

releaseMemoryReference

void releaseMemoryReference(IContext ctx)
                            throws ExternalException

Has the calling agent release a reference to this IActiveInstance indicating that it no longer wishes to use this reference and to allow for this IActiveInstance to be deleted.

Note that multiple calls to this method will result in the removal of the single reference maintained for the calling agent, once removed the operation has no effect on subsequent calls.

This method should only be used by external agents.

Parameters:: ctx - the IContext for the acquisition providing information about the agent acquiring the reference
Throws:: ExternalException - if an internal error occurs.

assertBelief

void assertBelief(IBelief belief,
                  IContext ctx)
                  throws ExternalException

Schedules the assertion of the specified belief to the active instance's belief set. The assertion of the belief is scheduled on the active instance's discrete event queue for processing by the active instance. The belief will not immediately be asserted in the belief set.

Note: If multiple beliefs are to be asserted to a remote agent use the assert method to which multiple beliefs can be passed to reduce communication overhead. The beliefs will be bundled in one communication package in that case, while with this method for each belief a separate communication package is created.

Parameters:: belief - the IBelief to be asserted; ctx - the IContext for the action
Throws:: ExternalException - ExternalException if an internal error occurs, in case of a communication failure the linked exception will be one of ServiceException, NoSuchActorException, ActorNotActiveException, NotLocatableException, TransportFailure, or SecurityFailure
See Also:: ServiceException, SecurityFailure, NoSuchActorException, ActorNotActiveException, NotLocatableException, TransportFailure

assertBeliefs

void assertBeliefs(IBelief[] beliefs,
                   IContext ctx)
                   throws ExternalException

Schedules the assertion of the specified beliefs to the active instance's belief set. The assertion of the beliefs is scheduled on the active instance's discrete event queue for processing by the active instance. The belief will not immediately be asserted in the belief set.

Note: If multiple beliefs are to be transmitted to a remote agent this method should be used to reduce communication overhead. The beliefs will be bundled in one communication package.

Parameters:: beliefs - the set of IBelief to be asserted; ctx - the IContext for the action
Throws:: ExternalException - ExternalException if an internal error occurs, in case of a communication failure the linked exception will be one of ServiceException, NoSuchActorException, ActorNotActiveException, NotLocatableException, TransportFailure, or SecurityFailure
See Also:: ServiceException, SecurityFailure, NoSuchActorException, ActorNotActiveException, NotLocatableException, TransportFailure

retractBelief

void retractBelief(IBelief belief,
                   IContext ctx)
                   throws ExternalException

Schedules the retraction of the specified belief from the active instance's belief set. The retraction of the belief is scheduled on the active instance's discrete event queue for processing by the active instance. The belief will not immediately be retracted from the belief set.

Parameters:: belief - the IBelief to be asserted; ctx - the IContext for the action
Throws:: ExternalException - if an internal error occurs