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

java.lang.Object
  extended by gov.nasa.arc.brahms.common.data.BrahmsObject
      extended by gov.nasa.arc.brahms.common.data.ModelElement
          extended by gov.nasa.arc.brahms.common.data.NamedModelElement
              extended by gov.nasa.arc.brahms.common.data.Activity
                  extended by gov.nasa.arc.brahms.common.data.PrimitiveActivity
                      extended by gov.nasa.arc.brahms.common.data.CreateAgentActivity
All Implemented Interfaces:
gov.nasa.arc.brahms.common.IConstants, java.io.Serializable
Direct Known Subclasses:
VMCreateAgentActivity

public class CreateAgentActivity
extends PrimitiveActivity

A create agent activity is a primitive activity allowing to dynamically create new agents. The user can specify how many agents have to be created and what the group membership of the agent is to be 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:11 $ $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
CreateAgentActivity()
          Constructor, creates a new create agent activity.
CreateAgentActivity(java.lang.String name)
          Constructor, creates a new create agent activity with the specified name.
CreateAgentActivity(java.lang.String file, int line)
          Constructor, creates a new create agent activity that is specified in the specified file at the specified line number.
CreateAgentActivity(java.lang.String name, java.lang.String file, int line)
          Constructor, creates a new create agent activity with the specified name that is specified in the specified file at the specified line number.
 
Method Summary
 boolean addMemberOf(Group obj)
           
 boolean addMemberOf(Parameter p)
           
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()
           
 NamedModelElement getLocation()
           
 java.util.Enumeration getMemberOf()
           
 java.lang.Object getQuantity()
           
 int getWhen()
           
 Parameter getWhenParameter()
           
 boolean hasMemberOf()
           
 void setDestination(Parameter p)
           
 void setDestinationName(Parameter p)
           
 void setDestinationName(java.lang.String name)
           
protected  void setID()
          Sets the unique identifier.
 void setLocation(Area area)
           
 void setLocation(Parameter p)
           
 void setQuantity(java.lang.Integer i)
           
 void setQuantity(Parameter p)
           
 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

CreateAgentActivity

public CreateAgentActivity()
Constructor, creates a new create agent activity.


CreateAgentActivity

public CreateAgentActivity(java.lang.String name)
Constructor, creates a new create agent activity with the specified name.

Parameters:
name - the name of the create agent activity

CreateAgentActivity

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

Parameters:
file - the file in which the create agent activity is specified
line - the line number at which the specification starts in the file

CreateAgentActivity

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

Parameters:
name - the name of the create agent activity
file - the file in which the create agent 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

addMemberOf

public boolean addMemberOf(Parameter p)

addMemberOf

public boolean addMemberOf(Group obj)

hasMemberOf

public boolean hasMemberOf()

getMemberOf

public java.util.Enumeration getMemberOf()

setQuantity

public void setQuantity(Parameter p)

setQuantity

public void setQuantity(java.lang.Integer i)

getQuantity

public java.lang.Object getQuantity()

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()

setLocation

public void setLocation(Parameter p)

setLocation

public void setLocation(Area area)

getLocation

public NamedModelElement getLocation()

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


Copyright © 1997-2012 All Rights Reserved.