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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

VMCreateAreaActivity

public class CreateAreaActivity
extends PrimitiveActivity

A create area activity is a primitive activity allowing to dynamically create new areas. The user can specify what parent area definition the area has to be made an instance of, what area it is to be a sub area of (part of) and when the actual creation has to take place by setting the 'when' value to either start or end.

Version:

$Revision: 1.1 $ $Date: 2007/10/10 14:12:12 $ $Author: rvhoof $

Author:

Ron van Hoof

See Also:

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

CreateAreaActivity()
Constructor, creates a new create area activity.

CreateAreaActivity(java.lang.String name)
Constructor, creates a new create area activity with the specified name.

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

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

Method Summary

boolean	addInhabitant(Concept obj) Adds the specified concept as an inhabitant for the newly created area.
boolean	addInhabitant(Parameter p) Adds the specified parameter as a parameter specifying an agent or object that is to be added as an inhabitant of the newly created area.
static int	convertWhenSymbolToInt(java.lang.String when) Converts the when indicator represented as a symbol to an integer constant.
IActivityCtx	createContext() Creates a new context for this activity for use in a virtual machine.
NamedModelElement	getDestination()
java.lang.Object	getDestinationName()
java.util.Enumeration	getInhabitants() Returns a list of inhabitants to be added to the newly created area.
NamedModelElement	getInstanceOf() Returns the area definition the newly created area is to be made an instance of.
NamedModelElement	getPartOf() Returns the area the newly created area is to be made a part/sub area of.
int	getWhen()
Parameter	getWhenParameter()
boolean	hasInhabitants() Indicates whether inhabitants are specified for the create agent activity.
void	setDestination(Parameter p)
void	setDestinationName(Parameter p)
void	setDestinationName(java.lang.String name)
protected void	setID() Sets the unique identifier.
void	setInstanceOf(AreaDef a) Sets the area definition the newly created area is to be made an instance of.
void	setInstanceOf(Parameter p) Sets the parameter indicating the area definition the newly created area is to be made an instance of.
void	setPartOf(Area a) Sets the area the newly created area is to be made a part of, making it a sub area of the specified area.
void	setPartOf(Parameter p) Sets the parameter indicating the area the newly created area is to be made a part of, making it a sub area of the specified area.
void	setWhen(int i)
void	setWhen(Parameter p)

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

addResource, addResource, addTouchedObject, addTouchedObject, getMaxDuration, getMinDuration, getRandom, getResources, getTouchedObjects, hasResources, hasTouchedObjects, 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

CreateAreaActivity

public CreateAreaActivity()

Constructor, creates a new create area activity.

CreateAreaActivity

public CreateAreaActivity(java.lang.String name)

Constructor, creates a new create area activity with the specified name.

Parameters:

name - the name of the create area activity

CreateAreaActivity

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

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

Parameters:

file - the file in which the create area activity is specified

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

CreateAreaActivity

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

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

Parameters:

name - the name of the create area activity

file - the file in which the create area 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

setID

protected void setID()

Sets the unique identifier.

Overrides:

setID in class PrimitiveActivity

setInstanceOf

public void setInstanceOf(Parameter p)

Sets the parameter indicating the area definition the newly created area is to be made an instance of.

Parameters:

p - the Parameter specifying the parent area definition

setInstanceOf

public void setInstanceOf(AreaDef a)

Sets the area definition the newly created area is to be made an instance of.

Parameters:

a - the parent area definition for the new area

getInstanceOf

public NamedModelElement getInstanceOf()

Returns the area definition the newly created area is to be made an instance of. The NamedModelElement can be a Parameter referencing an AreaDef or an AreaDef.

Returns:

NamedModelElement a Parameter or an AreaDef, can be null, in that case BaseAreaDef should be assumed.

setPartOf

public void setPartOf(Parameter p)

Sets the parameter indicating the area the newly created area is to be made a part of, making it a sub area of the specified area.

Parameters:

p - the Parameter specifying the area the new area is to be made a part/sub area of.

setPartOf

public void setPartOf(Area a)

Sets the area the newly created area is to be made a part of, making it a sub area of the specified area.

Parameters:

a - the Area the new area is to be made a part/sub area of.

getPartOf

public NamedModelElement getPartOf()

Returns the area the newly created area is to be made a part/sub area of. The NamedModelElement can be a Parameter referencing an Area or an Area.

Returns:

NamedModelElement a Parameter or an Area, can be null, in that case the new area is not a sub area of any other area.

addInhabitant

public boolean addInhabitant(Parameter p)

Adds the specified parameter as a parameter specifying an agent or object that is to be added as an inhabitant of the newly created area.

Parameters:

p - the Parameter referencing an agent or object

Returns:

true if the inhabitant was added successfully, false otherwise

addInhabitant

public boolean addInhabitant(Concept obj)

Adds the specified concept as an inhabitant for the newly created area. Te concept must be one of Agent or Object.

Parameters:

obj - the Agent or Object to be added as an inhabitant

Returns:

true if the inhabitant was added successfully, false otherwise

hasInhabitants

public boolean hasInhabitants()

Indicates whether inhabitants are specified for the create agent activity.

Returns:

true if inhabitants are specified, false otherwise

getInhabitants

public java.util.Enumeration getInhabitants()

Returns a list of inhabitants to be added to the newly created area. The list can consist of Parameters, Agents and ObjectInstances.

Returns:

Enumeration the inhabitants.

setDestination

public void setDestination(Parameter p)

getDestination

public NamedModelElement getDestination()

setDestinationName

public void setDestinationName(Parameter p)

setDestinationName

public void setDestinationName(java.lang.String name)

getDestinationName

public java.lang.Object getDestinationName()

setWhen

public void setWhen(int i)

setWhen

public void setWhen(Parameter p)

getWhen

public int getWhen()

getWhenParameter

public Parameter getWhenParameter()

createContext

public IActivityCtx createContext()

Creates a new context for this activity for use in a virtual machine.

Note: This method always returns a new instance and does not verify whether one is already created.

Overrides:

createContext in class PrimitiveActivity

Returns:

IActivityCtx the activity's context