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

All Superinterfaces:

IActivityCtx, IBrahmsObjectCtx, IPrimitiveActivityCtx

All Known Implementing Classes:

CreateAgentActivityCtx, VMCreateAgentActivityCtx

public interface ICreateAgentActivityCtx
extends IPrimitiveActivityCtx

The ICreateAgentActivityCtx interface is the interface for create agent activity contexts. A CreateAgentActivityCtx maintains the context of a create agent 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, group membership, number of agents, destination variable, name and location of the destination agent(s), and when the creation is to take place.

Version:

6 July 2001

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 agent's destination variable.
ParameterCtx	getDestinationLocation() Returns the location for the created agent.
ParameterCtx	getDestinationName() Returns the name for the created agent.
java.util.Enumeration	getMemberOf() Returns a list of the groups the created agent(s) are made a member of.
ParameterCtx	getQuantity() Returns the number of agents created.
ParameterCtx	getWhen() Returns when the create agent 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

getMemberOf

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

Returns a list of the groups the created agent(s) are made a member of. Each group is specified through a parameter context containing either the actual value (Group) or a reference to a variable containing the value.

Returns:

Enumeration an enumeration of ParameterCtx referencing Groups

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if there is no group membership

getQuantity

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

Returns the number of agents created. The quantity is set through a parameter context containing either the actual value or a reference to a variable containing the quantity value.

Returns:

ParameterCtx the quantity

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if no quantity is defined

getWhen

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

Returns when the create agent 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 agent 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 agent'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 agent. 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

getDestinationLocation

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

Returns the location for the created agent. The destination location is specified through a parameter context containing either the actual value (AreaCtx) or a reference to a variable containing the value.

Returns:

ParameterCtx the destination location

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if no destination location 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