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

All Superinterfaces:

IBrahmsObjectCtx, IDetectableActionCtx

All Known Implementing Classes:

TriggerCtx, VMTriggerCtx

public interface ITriggerCtx
extends IBrahmsObjectCtx, IDetectableActionCtx

The ITriggerCtx interface is the interface for a detectable action or custom action that maintains the information about when the trigger or action part of the detectable was executed and what belief or event triggered the action.

Version:

2 October 2003

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	getTriggeringBelief() Returns the belief that triggered this trigger.
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	setTriggeringBelief(IBeliefCtx belief) Sets the belief that activated this trigger.

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

setTriggeringBelief

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

Sets the belief that activated this trigger.

Parameters:

belief - the belief that triggered this trigger

Throws:

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

getTriggeringBelief

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

Returns the belief that triggered this trigger.

Returns:

IBeliefCtx the belief that triggered this trigger

Throws:

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

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