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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

VMGestureActivity

public class GestureActivity
extends PrimitiveActivity

A gesture activity is a primitive activity but is used to have an agent or object make a gesture. This gesture has no affects on the state of an agent in a simulation or agent-based system but is only used to drive the visualization in a virtual reality environment.

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

GestureActivity()
Constructor, creates a new gesture activity.

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

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

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

Method Summary

IActivityCtx	createContext() Creates a new context for this activity for use in a virtual machine.
java.lang.String	getGesture() Returns the gesture to be made by an agent or object.
Parameter	getGestureParameter() Returns the parameter that specifies the gesture.
void	setGesture(java.lang.String gesture) Sets the gesture.
void	setGestureParameter(Parameter p) Sets the parameter that specifies the gesture.
protected void	setID() Sets the unique identifier.

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, 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

GestureActivity

public GestureActivity()

Constructor, creates a new gesture activity.

GestureActivity

public GestureActivity(java.lang.String name)

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

Parameters:

name - the name of the gesture activity

GestureActivity

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

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

Parameters:

file - the file in which the gesture activity is specified

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

GestureActivity

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

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

Parameters:

name - the name of the gesture activity

file - the file in which the gesture 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 PrimitiveActivity

setGestureParameter

public void setGestureParameter(Parameter p)

Sets the parameter that specifies the gesture.

Parameters:

p - the Parameter specifying the gesture

getGestureParameter

public Parameter getGestureParameter()

Returns the parameter that specifies the gesture.

Returns:

Parameter the parameter specifying the gesture, null if the gesture is not specified by a parameter but just by its value.

See Also:

getGesture()

setGesture

public void setGesture(java.lang.String gesture)

Sets the gesture. The gesture must be a value conforming to the rules of the value being a symbol.

Parameters:

gesture - the gesture to be made by the agent or object

getGesture

public java.lang.String getGesture()

Returns the gesture to be made by an agent or object.

Returns:

String the gesture, returns null if the gesture is specified through a parameter

See Also:

getGestureParameter()

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