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

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

All Implemented Interfaces:

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

public class VMJavaActivityCtx
extends VMPrimitiveActivityCtx
implements IJavaActivityCtx

The VMJavaActivityCtx is a java activity context with extensions for use in the virtual machine that maintains the start and end times for an activity, the duration, priority, status, randomness, duration, resources, what java class it used to execute the activity and when the activity was executed.

Version:

$Revision: 1.2 $ $Date: 2009/11/23 23:56:45 $ $Author: rnado $

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

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

Method Summary

protected void	doJavaActivity(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt) Creates an instance of the Java class specified in this activity and executes its activity code.
ParameterCtx	getJavaClass() Returns the fully qualified name of the class that is to be used to perform the Java activity.
ParameterCtx	getWhen() Returns when the java activity is to take place (start or end).
protected void	onEnd(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt) Ends the activity, handling any completion initializations and executing any actions that are to be executed at the end of the activity as specified for the activity.
protected boolean	onStart(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt) Starts the activity, handling any startup initialization and executing any actions that are to be executed at the start of the activity as specified for the activity.
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.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.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

VMJavaActivityCtx

public VMJavaActivityCtx(VMJavaActivity act)

Constructor, creates a new context for the specified VMJavaActivity.

Parameters:

act - the VMJavaActivity for which to create a context

VMJavaActivityCtx

protected VMJavaActivityCtx(VMJavaActivity act,
                            java.lang.String id)

Constructor, creates a new context for the specified VMJavaActivity.

Parameters:

act - the VMJavaActivity for which to create a context

id - the unique identifier for the activity context

Method Detail

getJavaClass

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

Returns the fully qualified name of the class that is to be used to perform the Java activity. The name is set through a parameter contect containing either a String value with the name or a reference to a variable containing the name of the class.

Specified by:

getJavaClass in interface IJavaActivityCtx

Returns:

ParameterCtx the java class defining the java code to be executed

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if the when value is not defined

getWhen

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

Returns when the java activity is to take place (start or end). The when value is set through a parameter context containing either the actual value or a reference to a variable containing the when value.

Specified by:

getWhen in interface IJavaActivityCtx

Returns:

ParameterCtx the when value defining when the java activity is to occur

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if the when value is not defined

doJavaActivity

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

Creates an instance of the Java class specified in this activity and executes its activity code.

Parameters:

evt - the DiscreteEvent that triggered the execution of the code

onStart

protected boolean onStart(gov.nasa.arc.brahms.vm.events.DiscreteEvent evt)

Starts the activity, handling any startup initialization and executing any actions that are to be executed at the start of the activity as specified for the activity. If the activity specifies that the java code execution is to occur at the start, it will execute the java code.

Overrides:

onStart in class VMActivityCtx

Parameters:

evt - the DiscreteEvent that initiated the start of the activity

Returns:

boolean true if the activity was started, false if not

onEnd

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

Ends the activity, handling any completion initializations and executing any actions that are to be executed at the end of the activity as specified for the activity. If the activity specifies that the java code execution is to occur at the end, it will execute the java code.

Overrides:

onEnd in class VMActivityCtx

Parameters:

evt - the DiscreteEvent that initiated the end of the activity

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