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

All Superinterfaces:

IActivityCtx, IBrahmsObjectCtx, IContainmentActivityCtx, IPrimitiveActivityCtx

All Known Implementing Classes:

PutActivityCtx, VMPutActivityCtx

public interface IPutActivityCtx
extends IContainmentActivityCtx

The IPutActivityCtx interface is the interface for put activity contexts. A PutActivityCtx maintains the context of a put 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 dropped off in the activity and when the activity was executed.

Version:

4 September 2001

Author:

Ron van Hoof

Method Summary

ParameterCtx

getDestination() Returns the put activity's destination 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

getDestination

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

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

Returns:

ParameterCtx the destination, null if no destination is specified

Throws:

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