IActiveInstance (Brahms Agent 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.2 $ $Date: 2009/11/29 21:37:35 $ $Author: rnado $
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`	`addBeliefRelationConcept(IConcept lhsConcept, java.lang.String relationName, IConcept rhsConcept, IContext ctx)` Adds a concept as a value of a named relation for a concept by asserting a new belief into the belief state.
`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, byte 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, char 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, float 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, byte 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, char 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, float 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.lang.Object 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, short 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.lang.Object 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, short 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, byte 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, char 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, float 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.lang.Object 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, short 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.
`boolean`	`getBeliefAttributeBoolean(IConcept lhsConcept, java.lang.String attributeName, IContext ctx)` Retrieves a boolean value for an attribute of a concept from a belief in the belief state
`boolean`	`getBeliefAttributeBoolean(IConcept lhsConcept, java.lang.String attributeName, int index, IContext ctx)` Retrieves a boolean value for a collection attribute of a concept at a given integer index from a belief in the belief state
`boolean`	`getBeliefAttributeBoolean(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, IContext ctx)` Retrieves a boolean value for a collection attribute of a concept at a given String key from a belief in the belief state
`byte`	`getBeliefAttributeByte(IConcept lhsConcept, java.lang.String attributeName, IContext ctx)` Retrieves a byte value for an attribute of a concept from the active instance's belief state
`byte`	`getBeliefAttributeByte(IConcept lhsConcept, java.lang.String attributeName, int index, IContext ctx)` Retrieves a byte value for a collection attribute of a concept at a given integer index from a belief in the belief state
`byte`	`getBeliefAttributeByte(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, IContext ctx)` Retrieves a byte value for a collection attribute of a concept at a given String key from a belief in the belief state
`char`	`getBeliefAttributeChar(IConcept lhsConcept, java.lang.String attributeName, IContext ctx)` Retrieves a char value for an attribute of a concept from the active instance's belief state
`char`	`getBeliefAttributeChar(IConcept lhsConcept, java.lang.String attributeName, int index, IContext ctx)` Retrieves a char value for a collection attribute of a concept at a given integer index from a belief in the belief state
`char`	`getBeliefAttributeChar(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, IContext ctx)` Retrieves a char value for a collection attribute of a concept at a given String key from a belief in the belief state
`IConcept`	`getBeliefAttributeConcept(IConcept lhsConcept, java.lang.String attributeName, IContext ctx)` Retrieves an IConcept value for an attribute of a concept from a belief in the belief state
`IConcept`	`getBeliefAttributeConcept(IConcept lhsConcept, java.lang.String attributeName, int index, IContext ctx)` Retrieves an IConcept value for a collection attribute of a concept at a given integer index from a belief in the belief state
`IConcept`	`getBeliefAttributeConcept(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, IContext ctx)` Retrieves an IConcept value for a collection attribute of a concept at a given String key from a belief in the belief state
`double`	`getBeliefAttributeDouble(IConcept lhsConcept, java.lang.String attributeName, IContext ctx)` Retrieves a double value for an attribute of a concept from a belief in the belief state
`double`	`getBeliefAttributeDouble(IConcept lhsConcept, java.lang.String attributeName, int index, IContext ctx)` Retrieves a double value for a collection attribute of a concept at a given integer index from a belief in the belief state
`double`	`getBeliefAttributeDouble(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, IContext ctx)` Retrieves a double value for a collection attribute of a concept at a given String key from a belief in the belief state
`float`	`getBeliefAttributeFloat(IConcept lhsConcept, java.lang.String attributeName, IContext ctx)` Retrieves a float value for an attribute of a concept from the active instance's belief state
`float`	`getBeliefAttributeFloat(IConcept lhsConcept, java.lang.String attributeName, int index, IContext ctx)` Retrieves a float value for a collection attribute of a concept at a given integer index from a belief in the belief state
`float`	`getBeliefAttributeFloat(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, IContext ctx)` Retrieves a float value for a collection attribute of a concept at a given String key from a belief in the belief state
`int`	`getBeliefAttributeInt(IConcept lhsConcept, java.lang.String attributeName, IContext ctx)` Retrieves an int value for an attribute of a concept from the active instance's belief state
`int`	`getBeliefAttributeInt(IConcept lhsConcept, java.lang.String attributeName, int index, IContext ctx)` Retrieves an int value for a collection attribute of a concept at a given integer index from a belief in the belief state
`int`	`getBeliefAttributeInt(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, IContext ctx)` Retrieves an int value for a collection attribute of a concept at a given String key from a belief in the belief state
`java.io.Serializable`	`getBeliefAttributeJava(IConcept lhsConcept, java.lang.String attributeName, IContext ctx)` Retrieves a Serializable value for an attribute of a concept from a belief in the belief state
`java.io.Serializable`	`getBeliefAttributeJava(IConcept lhsConcept, java.lang.String attributeName, int index, IContext ctx)` Retrieves a Serializable value for a collection attribute of a concept at a given integer index from a belief in the belief state
`java.io.Serializable`	`getBeliefAttributeJava(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, IContext ctx)` Retrieves a Serializable value for a collection attribute of a concept at a given String key from a belief in the belief state
`long`	`getBeliefAttributeLong(IConcept lhsConcept, java.lang.String attributeName, IContext ctx)` Retrieves a long value for an attribute of a concept from a belief in the belief state
`long`	`getBeliefAttributeLong(IConcept lhsConcept, java.lang.String attributeName, int index, IContext ctx)` Retrieves a long value for a collection attribute of a concept at a given integer index from a belief in the belief state
`long`	`getBeliefAttributeLong(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, IContext ctx)` Retrieves a long value for a collection attribute of a concept at a given String key from a belief in the belief state
`java.util.Map<java.lang.Object,java.lang.Object>`	`getBeliefAttributeMap(IConcept lhsConcept, java.lang.String attributeName, boolean includeUnknown, IContext ctx)` Returns a Map representing the values for a map attribute of a concept from beliefs in the belief state Entries with values of unknown are included in the returned Map if the includeUnknown parameter is true.
`short`	`getBeliefAttributeShort(IConcept lhsConcept, java.lang.String attributeName, IContext ctx)` Retrieves a short value for an attribute of a concept from the active instance's belief state
`short`	`getBeliefAttributeShort(IConcept lhsConcept, java.lang.String attributeName, int index, IContext ctx)` Retrieves a short value for a collection attribute of a concept at a given integer index from a belief in the belief state
`short`	`getBeliefAttributeShort(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, IContext ctx)` Retrieves a short value for a collection attribute of a concept at a given String key from a belief in the belief state
`java.util.SortedMap<java.lang.Object,java.lang.Object>`	`getBeliefAttributeSortedMap(IConcept lhsConcept, java.lang.String attributeName, boolean includeUnknown, IContext ctx)` Returns a sorted Map representing the values for a map attribute of a concept from beliefs in the belief state Entries with values of unknown are included in the returned Map if the includeUnknown parameter is true.
`java.lang.String`	`getBeliefAttributeString(IConcept lhsConcept, java.lang.String attributeName, IContext ctx)` Retrieves a String value for an attribute of a concept from a belief in the belief state The attribute's Brahms type may be either string or symbol.
`java.lang.String`	`getBeliefAttributeString(IConcept lhsConcept, java.lang.String attributeName, int index, IContext ctx)` Retrieves a String value for a collection attribute of a concept at a given integer index from a belief in the belief state The Brahms type of the value may be either string or symbol.
`java.lang.String`	`getBeliefAttributeString(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, IContext ctx)` Retrieves a String value for a collection attribute of a concept at a given String key from a belief in the belief state The Brahms type of the value may be either string or symbol.
`java.lang.Object`	`getBeliefAttributeValue(IConcept lhsConcept, java.lang.String attributeName, IContext ctx)` Retrieves the value for an attribute of a concept from a belief in the belief state Returns null if there is no corresponding belief in the belief state.
`java.lang.Object`	`getBeliefAttributeValue(IConcept lhsConcept, java.lang.String attributeName, int index, IContext ctx)` Retrieves the value for a collection attribute of a concept at a given integer index from a belief in the belief state Returns null if there is no corresponding belief in the belief state.
`java.lang.Object`	`getBeliefAttributeValue(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, IContext ctx)` Retrieves the value for a collection attribute of a concept at a given String key from a belief in the belief state Returns null if there is no corresponding belief in the belief state.
`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.List<IConcept>`	`getBeliefRelationConcepts(IConcept lhsConcept, java.lang.String relationName, IContext ctx)` Retrieves a list of concepts that are related to a given concept by a named relation by inspecting the beliefs in the current belief state.
`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, byte 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, char 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, float 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.lang.Object 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, short 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.
`boolean`	`hasBeliefAttributeAnyValue(IConcept lhsConcept, java.lang.String attributeName, boolean includeUnknown, IContext ctx)` Tests whether a concept has any value for a named attribute based on the beliefs in the belief state.
`boolean`	`hasBeliefAttributeAnyValue(IConcept lhsConcept, java.lang.String attributeName, int index, boolean includeUnknown, IContext ctx)` Tests whether a concept has any value for a named collection attribute at a given integer index based on the beliefs in the belief state.
`boolean`	`hasBeliefAttributeAnyValue(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, boolean includeUnknown, IContext ctx)` Tests whether a concept has any value for a named collection attribute at a given String key based on the beliefs in the belief state.
`boolean`	`hasBeliefAttributeValue(IConcept lhsConcept, java.lang.String attributeName, int index, java.lang.Object value, IContext ctx)` Tests whether a concept has a specified value for a named attribute based on the beliefs in the belief state.
`boolean`	`hasBeliefAttributeValue(IConcept lhsConcept, java.lang.String attributeName, java.lang.Object value, IContext ctx)` Tests whether a concept has a specified value for a named attribute based on the beliefs in the belief state.
`boolean`	`hasBeliefAttributeValue(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, java.lang.Object value, IContext ctx)` Tests whether a concept has a specified value for a named attribute based on the beliefs in the belief state.
`boolean`	`hasBeliefRelationAnyValue(IConcept lhsConcept, java.lang.String relationName, boolean includeUnknown, IContext ctx)` Tests whether there are any true beliefs for a given concept and named relation in the current belief state.
`boolean`	`hasBeliefRelationValue(IConcept lhsConcept, java.lang.String relationName, java.lang.Object value, IContext ctx)` Tests whether a concept is related to a value by a named relation by inspecting the beliefs in the current belief state.
`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.
`java.util.List<IConcept>`	`removeAllBeliefRelationValues(IConcept lhsConcept, java.lang.String relationName, IContext ctx)` Removes any existing concepts as values of a named relation for a concept by retracting beliefs from the belief state.
`void`	`removeBeliefRelationConcept(IConcept lhsConcept, java.lang.String relationName, IConcept rhsConcept, IContext ctx)` Removes a concept as a value of a named relation for a concept by retracting the corresponding belief from the belief state.
`void`	`retractBelief(IBelief belief, IContext ctx)` Schedules the retraction of the specified belief from the active instance's belief set.
`void`	`setBeliefAttributeBoolean(IConcept lhsConcept, java.lang.String attributeName, boolean value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified boolean value for a named attribute
`void`	`setBeliefAttributeBoolean(IConcept lhsConcept, java.lang.String attributeName, int index, boolean value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified boolean value for a named collection attribute at an int index
`void`	`setBeliefAttributeBoolean(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, boolean value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified boolean value for a named collection attribute at a String key
`void`	`setBeliefAttributeByte(IConcept lhsConcept, java.lang.String attributeName, byte value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified byte value for a named attribute
`void`	`setBeliefAttributeByte(IConcept lhsConcept, java.lang.String attributeName, int index, byte value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified byte value for a named collection attribute at an int index
`void`	`setBeliefAttributeByte(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, byte value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified byte value for a named collection attribute at a String key
`void`	`setBeliefAttributeChar(IConcept lhsConcept, java.lang.String attributeName, char value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified char value for a named attribute
`void`	`setBeliefAttributeChar(IConcept lhsConcept, java.lang.String attributeName, int index, char value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified char value for a named collection attribute at an int index
`void`	`setBeliefAttributeChar(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, char value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified char value for a named collection attribute at a String key
`void`	`setBeliefAttributeConcept(IConcept lhsConcept, java.lang.String attributeName, IConcept value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified IConcept value for a named attribute
`void`	`setBeliefAttributeConcept(IConcept lhsConcept, java.lang.String attributeName, int index, IConcept value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified IConcept value for a named collection attribute at an int index
`void`	`setBeliefAttributeConcept(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, IConcept value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified IConcept value for a named collection attribute at a String key
`void`	`setBeliefAttributeDouble(IConcept lhsConcept, java.lang.String attributeName, double value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified double value for a named attribute
`void`	`setBeliefAttributeDouble(IConcept lhsConcept, java.lang.String attributeName, int index, double value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified double value for a named collection attribute at an int index
`void`	`setBeliefAttributeDouble(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, double value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified double value for a named collection attribute at a String key
`void`	`setBeliefAttributeFloat(IConcept lhsConcept, java.lang.String attributeName, float value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified float value for a named attribute
`void`	`setBeliefAttributeFloat(IConcept lhsConcept, java.lang.String attributeName, int index, float value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified float value for a named collection attribute at an int index
`void`	`setBeliefAttributeFloat(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, float value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified float value for a named collection attribute at a String key
`void`	`setBeliefAttributeInt(IConcept lhsConcept, java.lang.String attributeName, int value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified int value for a named attribute
`void`	`setBeliefAttributeInt(IConcept lhsConcept, java.lang.String attributeName, int index, int value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified int value for a named collection attribute at an int index
`void`	`setBeliefAttributeInt(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, int value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified int value for a named collection attribute at a String key
`void`	`setBeliefAttributeJava(IConcept lhsConcept, java.lang.String attributeName, int index, java.lang.Object value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified Java Object value for a named collection attribute at an int index
`void`	`setBeliefAttributeJava(IConcept lhsConcept, java.lang.String attributeName, int index, java.io.Serializable value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified Java Serializable value for a named collection attribute at an int index
`void`	`setBeliefAttributeJava(IConcept lhsConcept, java.lang.String attributeName, java.lang.Object value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified Java Object value for a named attribute
`void`	`setBeliefAttributeJava(IConcept lhsConcept, java.lang.String attributeName, java.io.Serializable value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified Java Serializable value for a named attribute
`void`	`setBeliefAttributeJava(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, java.lang.Object value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified Java Object value for a named collection attribute at a String key
`void`	`setBeliefAttributeJava(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, java.io.Serializable value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified Java Serializable value for a named collection attribute at a String key
`void`	`setBeliefAttributeLong(IConcept lhsConcept, java.lang.String attributeName, int index, long value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified long value for a named collection attribute at an int index
`void`	`setBeliefAttributeLong(IConcept lhsConcept, java.lang.String attributeName, long value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified long value for a named attribute
`void`	`setBeliefAttributeLong(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, long value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified long value for a named collection attribute at a String key
`void`	`setBeliefAttributeShort(IConcept lhsConcept, java.lang.String attributeName, int index, short value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified short value for a named collection attribute at an int index
`void`	`setBeliefAttributeShort(IConcept lhsConcept, java.lang.String attributeName, short value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified short value for a named attribute
`void`	`setBeliefAttributeShort(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, short value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified short value for a named collection attribute at a String key
`void`	`setBeliefAttributeString(IConcept lhsConcept, java.lang.String attributeName, int index, java.lang.String value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified string value for a named collection attribute at an int index
`void`	`setBeliefAttributeString(IConcept lhsConcept, java.lang.String attributeName, java.lang.String value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified string value for a named attribute
`void`	`setBeliefAttributeString(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, java.lang.String value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified string value for a named collection attribute at a String key
`void`	`setBeliefAttributeSymbol(IConcept lhsConcept, java.lang.String attributeName, int index, java.lang.String value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified symbol value for a named collection attribute at an int index
`void`	`setBeliefAttributeSymbol(IConcept lhsConcept, java.lang.String attributeName, java.lang.String value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified symbol value for a named attribute
`void`	`setBeliefAttributeSymbol(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, java.lang.String value, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has a specified symbol value for a named collection attribute at a String key
`void`	`setBeliefAttributeUnknown(IConcept lhsConcept, java.lang.String attributeName, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has the unknown value for a named attribute
`void`	`setBeliefAttributeUnknown(IConcept lhsConcept, java.lang.String attributeName, int index, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has the unknown value for a named collection attribute at an int index
`void`	`setBeliefAttributeUnknown(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, IContext ctx)` Creates and asserts a new belief in the belief state representing that an IConcept has the unknown value for a named collection attribute at a String key
`void`	`setBeliefRelationUnknown(IConcept lhsConcept, java.lang.String relationName, IContext ctx)` Removes any existing concepts as values of a named relation for a concept by giving the relation a value of unknown.

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