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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BroadcastActivity, ContainmentActivity, CreateAgentActivity, CreateAreaActivity, CreateObjectActivity, GestureActivity, JavaActivity, MoveActivity, VMPrimitiveActivity

public class PrimitiveActivity
extends Activity

A primitive activity is the lowest level of activity an agent or object works on for a specified amount of time. A primitive activity has no side-effects.

Version:

$Revision: 1.2 $ $Date: 2009/11/23 19:06:41 $ $Author: rnado $

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

PrimitiveActivity()
Constructor, creates a new primitive activity.

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

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

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

Method Summary

boolean	addResource(ObjectInstance obj) Adds a new object instance as a resource to the activity.
boolean	addResource(Parameter p) Adds a new resource referenced by the specified parameter to the activity.
boolean	addTouchedObject(ObjectInstance obj) Deprecated.
boolean	addTouchedObject(Parameter p) Deprecated.
IActivityCtx	createContext() Creates a new context for this activity for use in a virtual machine.
java.lang.Object	getMaxDuration()
java.lang.Object	getMinDuration()
java.lang.Object	getRandom()
java.util.Enumeration	getResources() Returns all the resources used in the activity
java.util.Enumeration	getTouchedObjects() Deprecated.
boolean	hasResources() Returns whether the activity uses resources.
boolean	hasTouchedObjects() Deprecated.
protected void	setID() Sets the unique identifier.
void	setMaxDuration(java.lang.Integer i)
void	setMaxDuration(Parameter p)
void	setMinDuration(java.lang.Integer i)
void	setMinDuration(Parameter p)
void	setRandom(java.lang.Boolean b)
void	setRandom(Parameter p)

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

addParameter, addReference, convertWhenSymbolToInt, 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

PrimitiveActivity

public PrimitiveActivity()

Constructor, creates a new primitive activity.

PrimitiveActivity

public PrimitiveActivity(java.lang.String name)

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

Parameters:

name - the name of the primitive activity

PrimitiveActivity

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

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

Parameters:

file - the file in which the primitive activity is specified

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

PrimitiveActivity

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

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

Parameters:

name - the name of the primitive activity

file - the file in which the primitive activity is specified

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

Method Detail

setID

protected void setID()

Sets the unique identifier.

Overrides:

setID in class BrahmsObject

setRandom

public void setRandom(Parameter p)

setRandom

public void setRandom(java.lang.Boolean b)

getRandom

public java.lang.Object getRandom()

setMinDuration

public void setMinDuration(Parameter p)

setMinDuration

public void setMinDuration(java.lang.Integer i)

getMinDuration

public java.lang.Object getMinDuration()

setMaxDuration

public void setMaxDuration(Parameter p)

setMaxDuration

public void setMaxDuration(java.lang.Integer i)

getMaxDuration

public java.lang.Object getMaxDuration()

addTouchedObject

public boolean addTouchedObject(Parameter p)

Deprecated.

addTouchedObject

public boolean addTouchedObject(ObjectInstance obj)

Deprecated.

hasTouchedObjects

public boolean hasTouchedObjects()

Deprecated.

getTouchedObjects

public java.util.Enumeration getTouchedObjects()

Deprecated.

addResource

public boolean addResource(Parameter p)

Adds a new resource referenced by the specified parameter to the activity.

Parameters:

p - the parameter referencing the resource

Returns:

boolean true if added, false otherwise

addResource

public boolean addResource(ObjectInstance obj)

Adds a new object instance as a resource to the activity.

Parameters:

obj - the ObjectInstance resource

Returns:

boolean true if added, false otherwise

hasResources

public boolean hasResources()

Returns whether the activity uses resources.

Returns:

boolean true if the activity uses resources, false otherwise

getResources

public java.util.Enumeration getResources()

Returns all the resources used in the activity

Returns:

Enumeration a list of the resources, Parameters and/or ObjectInstances

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 Activity

Returns:

IActivityCtx the activity's context