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

All Superinterfaces:

IActivityCtx, IBrahmsObjectCtx, IPrimitiveActivityCtx

All Known Implementing Classes:

MoveActivityCtx, VMMoveActivityCtx

public interface IMoveActivityCtx
extends IPrimitiveActivityCtx

The IMoveActivityCtx interface is the interface for move activity contexts. A 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

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.

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

getStartLocation

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.

Returns:

ParameterCtx the start location

Throws:

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

getDestinationLocation

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.

Returns:

ParameterCtx the destination location

Throws:

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