gov.nasa.arc.brahms.common.data
Class ContainmentActivity

java.lang.Object
  gov.nasa.arc.brahms.common.data.BrahmsObject
      gov.nasa.arc.brahms.common.data.ModelElement
          gov.nasa.arc.brahms.common.data.NamedModelElement
              gov.nasa.arc.brahms.common.data.Activity
                  gov.nasa.arc.brahms.common.data.PrimitiveActivity
                      gov.nasa.arc.brahms.common.data.ContainmentActivity

All Implemented Interfaces:

gov.nasa.arc.brahms.common.IConstants, java.io.Serializable

Direct Known Subclasses:

GetActivity, PutActivity

public abstract class ContainmentActivity
extends PrimitiveActivity

The containment activity class is a generic class for the put and get activities managing the containment of agents and objects by other agents or objects.

Version:

29 May 2001

Author:

Ron van Hoof

See Also:

GetActivity, PutActivity, Serialized Form

Field Summary

Fields inherited from class gov.nasa.arc.brahms.common.data.NamedModelElement

NAME_PROPERTY

Fields inherited from interface gov.nasa.arc.brahms.common.IConstants

ABORT, ACTIVECLASS, ACTIVECONCEPT, ACTIVEINSTANCE, AGENT, ANONYMOUS, ANYAGENT, AREA, AREADEF, ASSIGNED, ATTRIBUTE, BASEAREADEF, BASECLASS, BASECONCEPTUALCLASS, BASEGROUP, BASELIBRARY, BOOLEAN, BROADCAST, BUILDING, BYTE, CCLOCK, CDATE, CHAR, CITY, CLASS, CLOCK, COLLECTALL, COMMUNICATE, COMPLETE, COMPOSITE, COMPUTER, CONCEPT, CONCEPTUALCLASS, CONCEPTUALCONCEPT, CONCEPTUALOBJECT, CONTINUE, COPY, CREATEAGENT, CREATEAREA, CREATEOBJECT, current, CURRENT, DATAFRAME, DATE, DB, DETECTABLE, DIV, DOUBLE, EMAIL, EMPTY_STRING, END, ENDACTIVITY, ENTAGENT, EQ, EXCEPTION, EXPR, FACE2FACE, FACTFRAME, FALSE, FAX, FLOAT, FOREACH, FORONE, G2, GE, GEOGRAPHYCONCEPT, GESTURE, GET, GROUP, GT, IMPASSE, INT, INVALID, JAVA, JAVA_TYPE, KNOWN_MODIFIER, KNOWNVAL_MODIFIER, LE, LOCAL, LONG, LT, MAP, MINUS, MOD, MOVE, MULT, NE, NEW, NONE, NOT_MODIFIER, NOWORK, O, OA, OBJECT, ONTOLOGY, PAGER, PARAMETER, PATH, PHONE, PLUS, PRIMITIVE, PRIVATE, PROAGENT, PROTECTED, PRSAGENT, PUBLIC, PUT, RECEIVE, RELATION, sACTIVECLASS, sACTIVECONCEPT, sACTIVEINSTANCE, sAGENT, sARCHIVE, sAREA, sAREADEF, sBOOLEAN, sBYTE, sBYTECODEEXT, sCHAR, sCLASS, sCOMPUTER, sCONCEPT, sCONCEPTUALCLASS, sCONCEPTUALCONCEPT, sCONCEPTUALOBJECT, sCOPY, sCURRENT, sDETECTABLE, sDOUBLE, sEMAIL, sEND, SEND, sFACE2FACE, sFAX, sFILEEXT, sFLOAT, sGEOGRAPHYCONCEPT, sGROUP, SHORT, SIMAGENT, sINT, sJAVA_TYPE, sLONG, sMAP, sNEW, sNONE, sNOWORK, sOBJECT, SOURCECODE, sPAGER, sPARAMETER, sPATH, sPHONE, sPRIVATE, sPROJECTEXT, sPROTECTED, sPUBLIC, sSHORT, sSTART, sSTRING, sSYMBOL, START, STRING, sUNKNOWN, sVOID, SYMBOL, TRUE, UDT, UML, UNASSIGNED, UNDEFINED, unknown, UNKNOWN, UNKNOWN_MODIFIER, V, VARIABLE, VOID, WHENEVER, WORKFRAME, WORLD, XML

Constructor Summary

ContainmentActivity()
Constructor, creates a new containment activity.

ContainmentActivity(java.lang.String name)
Constructor, creates a new containment activity with the specified name.

ContainmentActivity(java.lang.String file, int line)
Constructor, creates a new containment activity that is specified in the specified file at the specified line number.

ContainmentActivity(java.lang.String name, java.lang.String file, int line)
Constructor, creates a new containment activity with the specified name that is specified in the specified file at the specified line number.

Method Summary

boolean	addItem(ActiveInstance item) Adds a new object instance as an item to the activity.
boolean	addItem(Parameter p) Adds a new item referenced by the specified parameter passed to the activity.
static int	convertWhenSymbolToInt(java.lang.String when) Converts the when indicator represented as a symbol to an integer constant.
java.util.Enumeration	getItems() Returns all the item specified for the activity
int	getWhen() Returns when the pick-up or drop of items is to be executed, at the start or end of the activity.
Parameter	getWhenParameter() Returns the parameter indicating when the pick-up or drop of items is to be executed, at the start or end of the activity.
void	setWhen(int i) Sets when the pick-up or drop of items is to be executed, at the start or end of the activity.
void	setWhen(Parameter p) Sets the parameter indicating when the pick-up or drop of items is to be executed, at the start or end of the activity.

Methods inherited from class gov.nasa.arc.brahms.common.data.PrimitiveActivity

addResource, addResource, addTouchedObject, addTouchedObject, createContext, getMaxDuration, getMinDuration, getRandom, getResources, getTouchedObjects, hasResources, hasTouchedObjects, setID, setMaxDuration, setMaxDuration, setMinDuration, setMinDuration, setRandom, setRandom

Methods inherited from class gov.nasa.arc.brahms.common.data.Activity

addParameter, addReference, delete, getActivityDescriptor, getDisplayText, getFullyQualifiedName, getParameter, getParameter, getParameterCount, getParameters, getPriority, getQualifiedName, getReferences, hasParameters, removeParameter, removeReference, setActivityDescriptor, setDisplayText, setDisplayText, setOwner, setOwner, setPriority, setPriority

Methods inherited from class gov.nasa.arc.brahms.common.data.NamedModelElement

getName, getOwner, setFullyQualifiedName, setName, setOwner, toString

Methods inherited from class gov.nasa.arc.brahms.common.data.BrahmsObject

export, getFile, getID, getLine, getSerialNumber, isBCC, isDynamic, isLoaded, isResolved, setBCC, setDynamic, setFile, setID, setLine, setLoaded, setResolved, setSerialNumber

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ContainmentActivity

public ContainmentActivity()

Constructor, creates a new containment activity.

ContainmentActivity

public ContainmentActivity(java.lang.String name)

Constructor, creates a new containment activity with the specified name.

Parameters:

name - the name of the containment activity

ContainmentActivity

public ContainmentActivity(java.lang.String file,
                           int line)

Constructor, creates a new containment activity that is specified in the specified file at the specified line number.

Parameters:

file - the file in which the containment activity is specified

line - the line number at which the specification starts in the file

ContainmentActivity

public ContainmentActivity(java.lang.String name,
                           java.lang.String file,
                           int line)

Constructor, creates a new containment activity with the specified name that is specified in the specified file at the specified line number.

Parameters:

name - the name of the containmentva activity

file - the file in which the containment activity is specified

line - the line number at which the specification starts in the file

Method Detail

convertWhenSymbolToInt

public static int convertWhenSymbolToInt(java.lang.String when)

Converts the when indicator represented as a symbol to an integer constant.

Parameters:

type - the symbol representation

Returns:

int the constant value

addItem

public boolean addItem(Parameter p)

Adds a new item referenced by the specified parameter passed to the activity.

Parameters:

p - the parameter referencing the item

Returns:

boolean true if added, false otherwise

addItem

public boolean addItem(ActiveInstance item)

Adds a new object instance as an item to the activity.

Parameters:

item - the ActiveInstance item

Returns:

boolean true if added, false otherwise

getItems

public java.util.Enumeration getItems()

Returns all the item specified for the activity

Returns:

Enumeration a list of the items, Parameters and/or ActiveInstances

setWhen

public void setWhen(int i)

Sets when the pick-up or drop of items is to be executed, at the start or end of the activity.

Parameters:

i - one of ContainmentActivity.START or ContainmentActivity.END

See Also:

IConstants.START, IConstants.END

setWhen

public void setWhen(Parameter p)

Sets the parameter indicating when the pick-up or drop of items is to be executed, at the start or end of the activity. The parameter must be of type 'symbol' and can as values have ContainmentActivity.sSTART or ContainmentActivity.sEND.

Parameters:

p - the symbol Parameter

See Also:

IConstants.sSTART, IConstants.sEND

getWhen

public int getWhen()

Returns when the pick-up or drop of items is to be executed, at the start or end of the activity.

Returns:

int one of ContainmentActivity.START, ContainmentActivity.END or ContainmentActivity.PARAMETER if the when is specified through a parameter

See Also:

IConstants.START, IConstants.END, IConstants.PARAMETER

getWhenParameter

public Parameter getWhenParameter()

Returns the parameter indicating when the pick-up or drop of items is to be executed, at the start or end of the activity. The parameter must be of type 'symbol' and can as values have ContainmentActivity.sSTART or ContainmentActivityivity.sEND.

Returns:

Parameter the symbol Parameter

See Also:

IConstants.sSTART, IConstants.sEND