gov.nasa.arc.brahms.vm.data
Class VMParameter

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.Parameter
                  gov.nasa.arc.brahms.vm.data.VMParameter

All Implemented Interfaces:

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

public class VMParameter
extends Parameter

The VMParameter is a Parameter with additional behavior specific for the virtual machine.

Version:

$Revision: 1.2 $ $Date: 2009/11/23 22:21: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

VMParameter()
Constructor, creates a new VMParameter.

VMParameter(java.lang.String file, int line)
Constructor, creates a new VMParameter specified in the given file at the specified line number.

VMParameter(java.lang.String name, java.lang.String file, int line)
Constructor, creates a new VMParameter.

Method Summary

java.lang.Object

resolve(gov.nasa.arc.brahms.vm.engine.rsn.IRSNFrameNode frame, gov.nasa.arc.brahms.vm.engine.rsn.RSNActivityRefNode actref) Resolves the parameter to a value using the specified frame and activity reference nodes.

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

getActivity, getFullyQualifiedName, getIndex, getType, getValue, setActivity, setID, setIndex, setType

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

getDisplayText, getName, getOwner, setDisplayText, setFullyQualifiedName, setName, setOwner, toString

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

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

VMParameter

public VMParameter()

Constructor, creates a new VMParameter.

VMParameter

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

Constructor, creates a new VMParameter specified in the given file at the specified line number.

Parameters:

file - the name of the file in which the parameter is defined

line - the line number at which the parameter is defined in the file

VMParameter

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

Constructor, creates a new VMParameter.

Parameters:

name - the name of the parameter

file - the name of the file in which the parameter is defined

line - the line number at which the parameter is defined in the file

Method Detail

resolve

public java.lang.Object resolve(gov.nasa.arc.brahms.vm.engine.rsn.IRSNFrameNode frame,
                                gov.nasa.arc.brahms.vm.engine.rsn.RSNActivityRefNode actref)

Resolves the parameter to a value using the specified frame and activity reference nodes. Since values for parameters can be passed on to composite activities, a nesting can occur. For a parameter to be resolved its value might have to be found by traversing up the composite activity hierarchy through activity references.

Parameters:

frame - the IRSNFrameNode for the frame in which the parameter is used.

actref - the RSNActivityRefNode for the activity reference in which a value is assigned to the parameter.

Returns:

Object the value (in)directly passed to the parameter, a variable, a concept or an objectified primitive value