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

All Superinterfaces:

IBrahmsObjectCtx, IConditionCtx

All Known Implementing Classes:

DetectableCtx, VMDetectableCtx

public interface IDetectableCtx
extends IConditionCtx

The IDetectableCtx defines the interface for the context for a fired detectable defining the detectable that was fired, in what frame or composite activity the detectable was fired, the fact or belief detected and the belief created by the detectable.

Version:

11 July 2000

Author:

Ron van Hoof

Method Summary

void	addDetectableAction(IDetectableActionCtx action) Adds the specified detectable action to the list of detectable actions executed by this detectable.
java.util.Enumeration	getDetectableActions() Returns a list of all the detectable actions executed by this detectable.
IBrahmsObjectCtx	getParent() Returns the parent context (frame or composite activity) in which this detectable is fired.
void	removeDetectableAction(IDetectableActionCtx action) Removes the specified detectable action from the list of detectable actions executed by this detectable.
void	setParent(ICompositeActivityCtx parent) Sets the parent composite activity context in which this detectable is fired.
void	setParent(IFrameCtx parent) Sets the parent frame context in which this detectable is fired.

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

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

Method Detail

setParent

void setParent(IFrameCtx parent)
               throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Sets the parent frame context in which this detectable is fired.

Parameters:

parent - the IFrameCtx in which the detectable is fired

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if a null parent is specified

setParent

void setParent(ICompositeActivityCtx parent)
               throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Sets the parent composite activity context in which this detectable is fired.

Parameters:

parent - the ICompositeActivityCtx in which the detectable is fired

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if a null parent is specified

getParent

IBrahmsObjectCtx getParent()
                           throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns the parent context (frame or composite activity) in which this detectable is fired.

Returns:

IBrahmsObjectCtx the parent context in which the detectable is fired

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if no parent is specified

addDetectableAction

void addDetectableAction(IDetectableActionCtx action)
                         throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Adds the specified detectable action to the list of detectable actions executed by this detectable.

Parameters:

action - the IDetectableActionCtx to be added

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if a null action is specified

removeDetectableAction

void removeDetectableAction(IDetectableActionCtx action)
                            throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Removes the specified detectable action from the list of detectable actions executed by this detectable.

Parameters:

action - the IDetectableActionCtx to be removed

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if the specified action is null, or no no actions are specified for the detectable, or the specified action is not found in the list of detectable actions.

getDetectableActions

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

Returns a list of all the detectable actions executed by this detectable.

Returns:

Enumeration a list of IDetectableActionCtx

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if no detectable actions are specified for the detectable.