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

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.Concept
                  gov.nasa.arc.brahms.common.data.GeographyConcept
                      gov.nasa.arc.brahms.common.data.Path
                          gov.nasa.arc.brahms.vm.data.VMPath

All Implemented Interfaces:

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

public class VMPath
extends Path
implements IVMInstance

The VMPath is a Path with extensions for use in the Brahms virtual machine. A path connects two areas together and represents a route that can be taken by an agent or object to travel from one area to another. For the path is specified how long it takes to travel from one area to the other.

Version:

$Revision: 1.3 $ $Date: 2009/11/23 22:12:31 $ $Author: rnado $

Author:

Ron van Hoof

See Also:

Serialized Form

Field Summary

Fields inherited from class gov.nasa.arc.brahms.common.data.Concept

ATTRIBUTES_PROPERTY, RELATIONS_PROPERTY

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

VMPath()
Constructor, creates a new path for use in the virtual machine.

VMPath(java.lang.String name)
Constructor, creates a new path with the specified name for use in the virtual machine.

VMPath(java.lang.String file, int line)
Constructor, creates a new path for use in the virtual machine and for which its specification is stored in the specified file at the specified line number.

VMPath(java.lang.String name, java.lang.String file, int line)
Constructor, creates a new path with the specified name for use in the virtual machine and for which its specification is stored in the specified file at the specified line number.

Method Summary

IConceptCtx	createContext() Creates a new context for this concept for use in a virtual machine.
boolean	equals(java.lang.Object obj) Tests whether two VMPaths are equal.

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

delete, getArea1, getArea2, getDistance, setArea1, setArea2, setDistance, setID

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

addInitialFact, getInitialFacts, hasInitialFacts

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

addAttribute, addRelation, compareTypes, getAttribute, getAttribute, getAttributes, getAttributes, getContext, getFullyQualifiedName, getIcon, getModel, getName, getPackage, getRelation, getRelation, getRelations, getRelations, getType, hasAttributes, hasRelations, isLocal, isSerializable, removeAttribute, removeRelation, setContext, setIcon, setLocal, setModel, setPackage, setSerializable, toString

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

getDisplayText, getOwner, setDisplayText, setFullyQualifiedName, setName, setOwner

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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface gov.nasa.arc.brahms.vm.data.IVMInstance

getContext, getFullyQualifiedName, getID, getName, isDynamic, isLocal, isSerializable, setDynamic, setSerializable

Methods inherited from interface gov.nasa.arc.brahms.common.data.Type

getSerialNumber

Constructor Detail

VMPath

public VMPath()

Constructor, creates a new path for use in the virtual machine.

VMPath

public VMPath(java.lang.String name)

Constructor, creates a new path with the specified name for use in the virtual machine.

Parameters:

name - the name of the path

VMPath

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

Constructor, creates a new path for use in the virtual machine and for which its specification is stored in the specified file at the specified line number.

Parameters:

file - the file in which the path is specified

line - the line number at which the path's specification starts in the file

VMPath

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

Constructor, creates a new path with the specified name for use in the virtual machine and for which its specification is stored in the specified file at the specified line number.

Parameters:

name - the name of the path

file - the file in which the path is specified

line - the line number at which the path's specification starts in the file

Method Detail

createContext

public IConceptCtx createContext()

Creates a new context for this concept 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 Concept

Returns:

IConceptCtx the concept's context

equals

public boolean equals(java.lang.Object obj)

Tests whether two VMPaths are equal. The VM maintains a single instance of any VMPath with a given FQN in its static model, so the equality check can be reduced to an identity check

Overrides:

equals in class Concept

Parameters:

obj - the Object to be compared for equality

Returns:

true if the two VMPaths are equal, false otherwise