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

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.AreaDef
                          gov.nasa.arc.brahms.vm.data.VMAreaDef

All Implemented Interfaces:

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

public class VMAreaDef
extends AreaDef
implements IVMClass

The VMAreaDef is an AreaDef with extensions for use in the Brahms virtual machine. An area definition is used for defining area constructs used for representing geographical information in a model. Area definitions are similar to classes in their use. Examples of area definitions are 'World', 'Building', and 'Floor'.

Version:

4 November 2003

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

VMAreaDef()
Constructor, creates a new area definition for use in the virtual machine.

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

VMAreaDef(java.lang.String file, int line)
Constructor, creates a new area definition for use in the virtual machine.

VMAreaDef(java.lang.String name, java.lang.String file, int line)
Constructor, creates a new area definition with the specified name for use in the virtual machine.

Method Summary

IVMInstance	createInstance(java.lang.String name) Creates a new area instance with this area definition as its parent.
boolean	equals(java.lang.Object obj) Tests whether two VMAreaDefs are equal.

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

addMember, addSubClass, addSuperClass, delete, getAttribute, getAttributeRecursive, getAttributes, getAttributesRecursive, getInitialFacts, getInitialFactsRecursive, getMember, getMembers, getMembers, getMembersRecursive, getRelation, getRelationRecursive, getRelations, getRelationsRecursive, getSubClass, getSubClasses, getSuperClass, getSuperClasses, getSuperClasses, hasMembers, hasSubClasses, hasSuperClasses, isSubClassOf, isSubClassOf, removeMember, removeSubClass, removeSuperClass, 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, createContext, getAttribute, getAttributes, getContext, getFullyQualifiedName, getIcon, getModel, getName, getPackage, getRelation, 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.IVMClass

isSerializable

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

getSerialNumber

Constructor Detail

VMAreaDef

public VMAreaDef()

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

VMAreaDef

public VMAreaDef(java.lang.String name)

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

Parameters:

name - the unique name of the area definition

VMAreaDef

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

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

Parameters:

file - the name of the file in which the area definition is specified

line - the line number at which the definition of the area definition starts

VMAreaDef

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

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

Parameters:

name - the unique name of the area definition

file - the name of the file in which the area definition is specified

line - the line number at which the definition of the area definition starts

Method Detail

createInstance

public IVMInstance createInstance(java.lang.String name)

Creates a new area instance with this area definition as its parent.

Specified by:

createInstance in interface IVMClass

Parameters:

name - the unique name in the runtime model for the instance.

Returns:

IVMInstance a new Area

equals

public boolean equals(java.lang.Object obj)

Tests whether two VMAreaDefs are equal. The VM maintains a single instance of any VMAreaDef 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 VMAreaDef are equal, false otherwise