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

All Superinterfaces:

IActivityCtx, IBrahmsObjectCtx, IPrimitiveActivityCtx

All Known Implementing Classes:

CreateAreaActivityCtx, VMCreateAreaActivityCtx

public interface ICreateAreaActivityCtx
extends IPrimitiveActivityCtx

The ICreateAreaActivityCtx interface is the interface for create area activity contexts. A CreateAreaActivityCtx maintains the context of a create area 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, parent area definition, aggregate area, destination variable, name of the destination area, and when the creation is to take place.

Version:

21 June 2002

Author:

Ron van Hoof

Method Summary

void	addBoundVariable(VariableCtx var) Adds the specified variable as a variable bound by this activity.
java.util.Enumeration	getBoundVariables() Returns a list of all the variables used by this activity.
ParameterCtx	getDestination() Returns the create area's destination variable.
ParameterCtx	getDestinationName() Returns the name for the created area.
java.util.Enumeration	getInhabitants() Returns a list of the agents or objects that have to be added as inhabitants to the new area.
ParameterCtx	getInstanceOf() Returns the area definition the new area is to be made an instance of.
ParameterCtx	getPartOf() Returns the area the new area is to be made a part/sub area of.
ParameterCtx	getWhen() Returns when the create area action is to take place (start or end).
void	removeBoundVariable(VariableCtx var) Removes the specified variable as a variable bound by this activity.

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

getInstanceOf

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

Returns the area definition the new area is to be made an instance of. The area definition is set through a parameter context containing either the actual value (AreaDef) or a reference to a variable containing the area definition.

Returns:

ParameterCtx the area definition

Throws:

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

getPartOf

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

Returns the area the new area is to be made a part/sub area of. The area is set through a parameter context containing either the actual value (Area) or a reference to a variable containing the area.

Returns:

ParameterCtx the area

Throws:

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

getInhabitants

java.util.Enumeration getInhabitants()
                                     throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns a list of the agents or objects that have to be added as inhabitants to the new area. Each agent and object is specified through a parameter context containing either the actual value (Agent or ObjectInstance) or a reference to a variable containing the value.

Returns:

Enumeration an enumeration of ParameterCtx referencing Agents or ObjectInstances

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if there are no inhabitants

getWhen

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

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

Returns:

ParameterCtx the when value defining when the create area action is to occur

Throws:

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

getDestination

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

Returns the create area's destination variable. The destination is specified through a parameter context containing a reference to a variable containing the value.

Returns:

ParameterCtx the destination

Throws:

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

getDestinationName

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

Returns the name for the created area. The destination name is specified through a parameter context containing either the actual value (String) or a reference to a variable containing the value.

Returns:

ParameterCtx the destination name

Throws:

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

addBoundVariable

void addBoundVariable(VariableCtx var)
                      throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Adds the specified variable as a variable bound by this activity.

Parameters:

var - the variable (VariableCtx) to be added

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if var is null

removeBoundVariable

void removeBoundVariable(VariableCtx var)
                         throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Removes the specified variable as a variable bound by this activity.

Parameters:

var - the variable (VariableCtx) to be removed

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if variable is null, no variables are present, or the variable is not found

getBoundVariables

java.util.Enumeration getBoundVariables()
                                        throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns a list of all the variables used by this activity.

Returns:

Enumeration an enumeration of VariableCtx

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if there are no variables