gov.nasa.arc.brahms.common.rt
Interface IDetectCtx

All Superinterfaces:

IBrahmsObjectCtx, IDetectableActionCtx

All Known Implementing Classes:

DetectCtx, VMDetectCtx

public interface IDetectCtx
extends IBrahmsObjectCtx, IDetectableActionCtx

The IDetectCtx interface is the interface for a detectable action that maintains the information about when a detection took place, what fact was detected and what belief was created as a result of the detection.

Version:

4 August 2000

Author:

Ron van Hoof

See Also:

IDetectableActionCtx, IDetectableCtx

Method Summary

void	addUsedVariable(IVariableCtx var) Adds the specified variable as a variable used by this detectable.
IBeliefCtx	getCreatedBelief() Returns the belief created by the detectable in this detect action.
IFactCtx	getDetectedFact() Returns the fact detected by the detectable in this detect action.
java.util.Enumeration	getUsedVariables() Returns a list of all the variables used by this detectable.
void	removeUsedVariable(IVariableCtx var) Removes the specified variable as a variable used by this detectable.
void	setCreatedBelief(IBeliefCtx belief) Sets the belief that was created as a result of the fact detection.
void	setDetectedFact(IFactCtx fact) Sets the fact that is detected by the detectable in this detect action instance.

Methods inherited from interface gov.nasa.arc.brahms.common.rt.IBrahmsObjectCtx

addNote, getContextFor, getEndTime, getID, getNote, getNotes, getStartTime, removeNote, setEndTime, setID, setStartTime

Methods inherited from interface gov.nasa.arc.brahms.common.rt.IDetectableActionCtx

getParent

Method Detail

setDetectedFact

void setDetectedFact(IFactCtx fact)
                     throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Sets the fact that is detected by the detectable in this detect action instance.

Parameters:

fact - the detected fact

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if the specified fact is null

getDetectedFact

IFactCtx getDetectedFact()
                         throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns the fact detected by the detectable in this detect action.

Returns:

IFactCtx the detected fact

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if the detected fact is null

setCreatedBelief

void setCreatedBelief(IBeliefCtx belief)
                      throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Sets the belief that was created as a result of the fact detection.

Parameters:

belief - the created belief

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if the specified belief is null

getCreatedBelief

IBeliefCtx getCreatedBelief()
                            throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns the belief created by the detectable in this detect action.

Returns:

IBeliefCtx the created belief

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if the created belief is null

addUsedVariable

void addUsedVariable(IVariableCtx var)
                     throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Adds the specified variable as a variable used by this detectable.

Parameters:

var - the variable (IVariableCtx) to be added

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if var is null

removeUsedVariable

void removeUsedVariable(IVariableCtx var)
                        throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Removes the specified variable as a variable used by this detectable.

Parameters:

var - the variable (IVariableCtx) to be removed

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if variable is null, no variables are present, or the variable is not found

getUsedVariables

java.util.Enumeration getUsedVariables()
                                       throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns a list of all the variables used by this detectable.

Returns:

Enumeration an enumeration of IVariableCtx

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if there are no variables