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

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

All Implemented Interfaces:

IActivityCtx, IBrahmsObjectCtx, IMoveActivityCtx, IPrimitiveActivityCtx, IRuntimeConstants, java.io.Serializable

public class MoveActivityCtx
extends PrimitiveActivityCtx
implements IMoveActivityCtx

The MoveActivityCtx maintains the context of a move 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, start location and destination location.

Version:

29 November 1999

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

MoveActivityCtx(MoveActivity act)
Constructor, creates a new context for the specified MoveActivity.

Method Summary

ParameterCtx	getDestinationLocation() Returns the destination location for the move.
ParameterCtx	getStartLocation() Returns the start location for the move, the start location of the active instance when starting the move.
void	setDestinationLocation(ParameterCtx location) Sets the destination location for the move.
void	setStartLocation(ParameterCtx location) Sets the start location for the move, the start location of the active instance when starting the move.

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

MoveActivityCtx

public MoveActivityCtx(MoveActivity act)

Constructor, creates a new context for the specified MoveActivity.

Parameters:

act - the MoveActivity for which to create a context

Method Detail

setStartLocation

public void setStartLocation(ParameterCtx location)
                      throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Sets the start location for the move, the start location of the active instance when starting the move. The start location is defined through a parameter context referencing an AreaCtx.

Parameters:

location - the start location (ParameterCtx)

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if a null start location is specified

getStartLocation

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

Returns the start location for the move, the start location of the active instance when starting the move. The start location is defined through a parameter context referencing an AreaCtx.

Specified by:

getStartLocation in interface IMoveActivityCtx

Returns:

ParameterCtx the start location

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if no start location is specified

setDestinationLocation

public void setDestinationLocation(ParameterCtx location)
                            throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Sets the destination location for the move. The destination location is defined through a parameter context referencing an AreaCtx.

Parameters:

location - the destination location (ParameterCtx)

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if a null destination location is specified

getDestinationLocation

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

Returns the destination location for the move. The destination location is defined through a parameter context referencing an AreaCtx.

Specified by:

getDestinationLocation in interface IMoveActivityCtx

Returns:

ParameterCtx the destination location

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if no destination location is specified