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

All Superinterfaces:

IBrahmsObjectCtx, IFrameCtx

All Known Implementing Classes:

VMWorkframeCtx, WorkframeCtx

public interface IWorkframeCtx
extends IFrameCtx

The IWorkframeCtx is the interface for workframe contexts that maintain tthe state for a workframe. In addition to keeping track of the state information as defined in the IFrameCtx the workframe context also tracks the activity currently executed in the frame, the activities that have completed and the detectable contexts defining the detectables that were executed in the context of the workframe.

Version:

11 July 2000

Author:

Ron van Hoof

See Also:

IFrameCtx

Method Summary

void	addActiveDetectable(IDetectableCtx detectable) Adds the specified detectable as an active detectable to the list of active detectables.
void	addCompletedActivity(ActivityCtx act) Adds the specified activity as a completed activity to the list of completed activities.
java.util.ListIterator	getActiveDetectables() Returns the list of active detectables.
java.util.ListIterator	getCompletedActivities() Returns the list of completed activities.
ActivityCtx	getCurrentActivity() Returns the activity currently active in the workframe
void	removeActiveDetectable(IDetectableCtx detectable) Removes the specified detectable as an active detectable from the list of active detectables.
void	removeCompletedActivity(ActivityCtx act) Removes the specified activity as a completed activity from the list of completed activities.
void	setCurrentActivity(ActivityCtx act) Sets the activity currently active in the workframe

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

addBinding, addFiredConsequence, getBinding, getBindings, getFiredConsequences, getPerformedBy, getPerformedIn, getPriority, getState, getStatus, getTimeAvailable, removeBinding, removeFiredConsequence, setPerformedBy, setPerformedIn, setPriority, setState, setState, setStatus, setTimeAvailable

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

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

Method Detail

setCurrentActivity

void setCurrentActivity(ActivityCtx act)

Sets the activity currently active in the workframe

Parameters:

act - the current activity (ActivityCtx)

getCurrentActivity

ActivityCtx getCurrentActivity()

Returns the activity currently active in the workframe

Returns:

ActivityCtx the current activity (ActivityCtx) of the workframe context, null if the workframe context has no activity active

addCompletedActivity

void addCompletedActivity(ActivityCtx act)
                          throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Adds the specified activity as a completed activity to the list of completed activities.

Parameters:

act - the ActivityCtx for the activity completed in the workframe

Throws:

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

removeCompletedActivity

void removeCompletedActivity(ActivityCtx act)
                             throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Removes the specified activity as a completed activity from the list of completed activities.

Parameters:

act - the ActivityCtx for the activity to be removed as a completed activity

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if the activity is null or no completed activities exist or the specified activity is not found

getCompletedActivities

java.util.ListIterator getCompletedActivities()
                                              throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns the list of completed activities.

Returns:

ListIterator the list of completed activities (ActivityCtx)

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if no completed activities exist

addActiveDetectable

void addActiveDetectable(IDetectableCtx detectable)
                         throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Adds the specified detectable as an active detectable to the list of active detectables. An active detectable is actively checked while the workframe is active.

Parameters:

detectable - the IDetectableCtx for the detectable active in the workframe

Throws:

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

removeActiveDetectable

void removeActiveDetectable(IDetectableCtx detectable)
                            throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Removes the specified detectable as an active detectable from the list of active detectables.

Parameters:

detectable - the IDetectableCtx for the detectable to be removed as an active detectable

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if the detectable is null or no active detectables exist or the specified detectable is not found

getActiveDetectables

java.util.ListIterator getActiveDetectables()
                                            throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns the list of active detectables.

Returns:

ListIterator the list of active detectables (IDetectableCtx)

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if no active detectables exist