gov.nasa.arc.brahms.common.rt
Class PutActivityCtx

java.lang.Object
  gov.nasa.arc.brahms.common.rt.BrahmsObjectCtx
      gov.nasa.arc.brahms.common.rt.ActivityCtx
          gov.nasa.arc.brahms.common.rt.PrimitiveActivityCtx
              gov.nasa.arc.brahms.common.rt.ContainmentActivityCtx
                  gov.nasa.arc.brahms.common.rt.PutActivityCtx

All Implemented Interfaces:

IActivityCtx, IBrahmsObjectCtx, IContainmentActivityCtx, IPrimitiveActivityCtx, IPutActivityCtx, IRuntimeConstants, java.io.Serializable

public class PutActivityCtx
extends ContainmentActivityCtx
implements IPutActivityCtx

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

See Also:

Serialized Form

Field Summary

Fields inherited from interface gov.nasa.arc.brahms.common.rt.IRuntimeConstants

ABORTED, ACTIVE, ACTIVITY, AVAILABLE, COMPLETED, CONSEQUENCE, DETECTABLE, ENDED, ENGINE, EXTERNAL_AGENT, FROM, IMPASSED, INITIAL, INTERRUPTED, JAVA_PROPERTY, sABORTED, sACTIVE, sAVAILABLE, sCOMPLETED, sENDED, sIMPASSED, sINTERRUPTED, sUNAVAILABLE, TO, TRANSFER, UNAVAILABLE

Constructor Summary

PutActivityCtx(PutActivity act)
Constructor, creates a new context for the specified PutActivity.

Method Summary

ParameterCtx	getDestination() Returns the put activity's destination agent.
void	setDestination(ParameterCtx destination) Sets the put activity's destination agent, object or area.

Methods inherited from class gov.nasa.arc.brahms.common.rt.ContainmentActivityCtx

addItem, getItemCount, getItems, getWhen, removeItem, setWhen

Methods inherited from class gov.nasa.arc.brahms.common.rt.PrimitiveActivityCtx

addResource, getDuration, getElapsedTime, getMaxDuration, getMinDuration, getRandom, getResourceCount, getResources, removeResource, setDuration, setElapsedTime, setMaxDuration, setMinDuration, setRandom

Methods inherited from class gov.nasa.arc.brahms.common.rt.ActivityCtx

getCompletionCause, getDisplayText, getParentFrame, getPerformedBy, getPriority, getReferencedBy, getState, getStatus, setCompletionCause, setDisplayText, setParentFrame, setPerformedBy, setPriority, setReferencedBy, setState, setState, setStatus, toString

Methods inherited from class gov.nasa.arc.brahms.common.rt.BrahmsObjectCtx

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Constructor Detail

PutActivityCtx

public PutActivityCtx(PutActivity act)

Constructor, creates a new context for the specified PutActivity.

Parameters:

act - the PutActivity for which to create a context

Method Detail

setDestination

public void setDestination(ParameterCtx destination)
                    throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Sets 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.

Parameters:

destination - the ParameterCtx containing the destination

Throws:

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

getDestination

public 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.

Specified by:

getDestination in interface IPutActivityCtx

Returns:

ParameterCtx the destination, null if no destination is specified

Throws:

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