gov.nasa.arc.brahms.vm.rt
Class VMGetActivityCtx

java.lang.Object
  gov.nasa.arc.brahms.common.rt.BrahmsObjectCtx
      gov.nasa.arc.brahms.common.rt.ActivityCtx
          gov.nasa.arc.brahms.vm.rt.VMActivityCtx
              gov.nasa.arc.brahms.vm.rt.VMPrimitiveActivityCtx
                  gov.nasa.arc.brahms.vm.rt.VMContainmentActivityCtx
                      gov.nasa.arc.brahms.vm.rt.VMGetActivityCtx

All Implemented Interfaces:

IActivityCtx, IBrahmsObjectCtx, IContainmentActivityCtx, IGetActivityCtx, IPrimitiveActivityCtx, IRuntimeConstants, gov.nasa.arc.brahms.vm.events.IDiscreteEventData, gov.nasa.arc.brahms.vm.events.IDiscreteEventHandler, java.io.Serializable

public class VMGetActivityCtx
extends VMContainmentActivityCtx
implements IGetActivityCtx

A VMGetActivityCtx is a GetActivityCtx with extensions for the virtual machine that 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:

$Revision: 1.1 $ $Date: 2007/10/10 14:04:24 $ $Author: rvhoof $

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

	VMGetActivityCtx(VMGetActivity act) Constructor, creates a new context for the specified VMGetActivity.
protected	VMGetActivityCtx(VMGetActivity act, java.lang.String id) Constructor, creates a new context for the specified VMGetActivity.

Method Summary

protected void	doActivityAction(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt) Picks up the items specified in the activity making the agent or object performing the activity the container for the items.
ParameterCtx	getSource() Returns the get activity's source agent, object or area.
protected void	sendAbortEvent(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt) Sends an abort event to the event notifier.
protected void	sendCompleteEvent(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt) Sends a complete event to the event notifier.
protected void	sendContinueEvent(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt) Sends a continue event to the event notifier.
protected void	sendContinueFromImpasseEvent(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt) Sends a continue from impasse event to the event notifier.
protected void	sendEndEvent(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt) Sends an end event to the event notifier.
protected void	sendImpasseEvent(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt) Sends an impasse event to the event notifier.
protected void	sendInterruptEvent(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt) Sends an interrupt event to the event notifier.
protected void	sendStartEvent(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt) Sends a start event to the event notifier.

Methods inherited from class gov.nasa.arc.brahms.vm.rt.VMContainmentActivityCtx

addItem, getItemCount, getItems, getWhen, onEnd, onStart, removeItem

Methods inherited from class gov.nasa.arc.brahms.vm.rt.VMPrimitiveActivityCtx

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

Methods inherited from class gov.nasa.arc.brahms.vm.rt.VMActivityCtx

getDisplayText, getParameterCtx, getPriority, handleDiscreteEvent, handleDiscreteEvent, onAbort, onComplete, onContinue, onContinueFromImpasse, onImpasse, onInterrupt, resolveParameters

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

getCompletionCause, getParentFrame, getPerformedBy, 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

VMGetActivityCtx

public VMGetActivityCtx(VMGetActivity act)

Constructor, creates a new context for the specified VMGetActivity.

Parameters:

act - the VMGetActivity for which to create a context

VMGetActivityCtx

protected VMGetActivityCtx(VMGetActivity act,
                           java.lang.String id)

Constructor, creates a new context for the specified VMGetActivity.

Parameters:

act - the VMGetActivity for which to create a context

id - the unique identifier for the activity context

Method Detail

getSource

public 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. If source is null it will return the executing active instance's current location. If the active instance has no location, null will be returned.

Specified by:

getSource in interface IGetActivityCtx

Returns:

ParameterCtx the source

Throws:

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

doActivityAction

protected void doActivityAction(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt)

Picks up the items specified in the activity making the agent or object performing the activity the container for the items. The activity generates the facts and beliefs about the containment of the items by the performing agent/object.

Specified by:

doActivityAction in class VMContainmentActivityCtx

Parameters:

evt - the DiscreteEvent that triggered the execution of the code

sendStartEvent

protected void sendStartEvent(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt)

Sends a start event to the event notifier.

Note that this method is created for the different implementations by the sub classes of VMActivityCtx.

Overrides:

sendStartEvent in class VMPrimitiveActivityCtx

Parameters:

evt - the DiscreteEvent that triggered the state change

sendEndEvent

protected void sendEndEvent(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt)

Sends an end event to the event notifier.

Note that this method is created for the different implementations by the sub classes of VMActivityCtx.

Overrides:

sendEndEvent in class VMPrimitiveActivityCtx

Parameters:

evt - the DiscreteEvent that triggered the state change

sendInterruptEvent

protected void sendInterruptEvent(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt)

Sends an interrupt event to the event notifier.

Note that this method is created for the different implementations by the sub classes of VMActivityCtx.

Overrides:

sendInterruptEvent in class VMPrimitiveActivityCtx

Parameters:

evt - the DiscreteEvent that triggered the state change

sendContinueEvent

protected void sendContinueEvent(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt)

Sends a continue event to the event notifier.

Note that this method is created for the different implementations by the sub classes of VMActivityCtx.

Overrides:

sendContinueEvent in class VMPrimitiveActivityCtx

Parameters:

evt - the DiscreteEvent that triggered the state change

sendImpasseEvent

protected void sendImpasseEvent(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt)

Sends an impasse event to the event notifier.

Note that this method is created for the different implementations by the sub classes of VMActivityCtx.

Overrides:

sendImpasseEvent in class VMPrimitiveActivityCtx

Parameters:

evt - the DiscreteEvent that triggered the state change

sendContinueFromImpasseEvent

protected void sendContinueFromImpasseEvent(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt)

Sends a continue from impasse event to the event notifier.

Note that this method is created for the different implementations by the sub classes of VMActivityCtx.

Overrides:

sendContinueFromImpasseEvent in class VMPrimitiveActivityCtx

Parameters:

evt - the DiscreteEvent that triggered the state change

sendCompleteEvent

protected void sendCompleteEvent(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt)

Sends a complete event to the event notifier.

Note that this method is created for the different implementations by the sub classes of VMActivityCtx.

Overrides:

sendCompleteEvent in class VMPrimitiveActivityCtx

Parameters:

evt - the DiscreteEvent that triggered the state change

sendAbortEvent

protected void sendAbortEvent(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt)

Sends an abort event to the event notifier.

Note that this method is created for the different implementations by the sub classes of VMActivityCtx.

Overrides:

sendAbortEvent in class VMPrimitiveActivityCtx

Parameters:

evt - the DiscreteEvent that triggered the state change