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

All Superinterfaces:

IActivityCtx, IBrahmsObjectCtx, IContainmentActivityCtx, IPrimitiveActivityCtx

All Known Implementing Classes:

GetActivityCtx, VMGetActivityCtx

public interface IGetActivityCtx
extends IContainmentActivityCtx

The IGetActivityCtx interface is the interface for get activity contexts. A GetActivityCtx maintains the context of a get activity being or to be executed by an active instance. The context maintains the start and end times for an activity, the duration, priority, status, randomness, duration, resources, what items (agent or objects) were picked up in the activity and when the activity was executed.

Version:

4 September 2001

Author:

Ron van Hoof

Method Summary

ParameterCtx

getSource() Returns the get activity's source agent.

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

addItem, getItemCount, getItems, getWhen, removeItem

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

addResource, getDuration, getElapsedTime, getMaxDuration, getMinDuration, getRandom, getResourceCount, getResources, removeResource, setElapsedTime

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

getCompletionCause, getDisplayText, getParentFrame, getPerformedBy, getPriority, getReferencedBy, getStatus, setCompletionCause, setDisplayText, setParentFrame, setPerformedBy, setReferencedBy, setStatus

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

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

Method Detail

getSource

ParameterCtx getSource()
                       throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns the get activity's source agent. object or area. The source is specified through a parameter context containing either the actual value (ConceptCtx) or a reference to a variable containing the value.

Returns:

ParameterCtx the source, null if no source is specified

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if an internal error occurs