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

java.lang.Object
  gov.nasa.arc.brahms.common.data.BrahmsObject
      gov.nasa.arc.brahms.common.data.ModelElement
          gov.nasa.arc.brahms.common.data.Assignment

All Implemented Interfaces:

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

Direct Known Subclasses:

VMAssignment

public class Assignment
extends ModelElement

Assignment specifies an assignment operation in the body of workframe used to assign a value to a variable or parameter.

Version:

$Revision: 1.1 $ $Date: 2009/11/23 18:28:41 $ $Author: rnado $

Author:

Bob Nado

See Also:

Serialized Form

Field Summary

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

Assignment()
Constructor, creates a new Assignment operation.

Assignment(IAssignmentLhs lhs, IExpression rhs, java.lang.String file, int line)
Constructor, creates a new Assignment operation which is located as Brahms source code in the given file at the given line number.

Assignment(java.lang.String file, int line)
Constructor, creates a new Assignment operation which is located as brahms source code in the given file at the given line number.

Method Summary

void	delete() Deletes this element from the model and removes all references to this element in other model elements.
Type	getCollectType() Returns the Brahms element type when this assignment has a lhs with a Java Collection type that can be assigned a list containing elements of the right-hand side expression's type.
IAssignmentLhs	getLhs() Returns the element to be assigned a value.
Workframe	getOwner() Returns the Workframe in which the assignment operation is declared.
IExpression	getRhs() Returns the rhs of the assignment.
void	setCollectType(Type type) Sets the Brahms element type when this assignment has a lhs with a Java Collection type that can contain elements of the right-hand side expression's type.
protected void	setID() Sets the unique identifier.
void	setLhs(IAssignmentLhs var) Sets the element to be assigned a value.
void	setOwner(Workframe owner) Sets the Workframe in which the assignment operation is declared.
void	setRhs(IExpression rhs) Sets the rhs expression to be evaluated.
java.lang.String	toString() Returns the source code representation for this Assignment operation.

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

Assignment

public Assignment()

Constructor, creates a new Assignment operation.

Assignment

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

Constructor, creates a new Assignment operation which is located as brahms source code in the given file at the given line number.

Parameters:

file - the name of the file

line - the line number in the file

Assignment

public Assignment(IAssignmentLhs lhs,
                  IExpression rhs,
                  java.lang.String file,
                  int line)

Constructor, creates a new Assignment operation which is located as Brahms source code in the given file at the given line number.

Parameters:

lhs - an ILhsExpression indicating the element to be assigned a new value

rhs - an IRhsExpression to be evaluated to give the new value

file - the name of the file

line - the line number in the file

Method Detail

setID

protected void setID()

Sets the unique identifier.

Overrides:

setID in class BrahmsObject

setLhs

public void setLhs(IAssignmentLhs var)

Sets the element to be assigned a value.

Parameters:

var - the variable to be assigned

getLhs

public IAssignmentLhs getLhs()

Returns the element to be assigned a value.

Returns:

BrahmsObject one of Variable, Parameter, or ArrayAccess

setRhs

public void setRhs(IExpression rhs)

Sets the rhs expression to be evaluated.

Parameters:

rhs - the expression to be evaluated to get the assigned value

getRhs

public IExpression getRhs()

Returns the rhs of the assignment.

Returns:

IAssignmentRhs the rhs expression for the assignment

setOwner

public void setOwner(Workframe owner)

Sets the Workframe in which the assignment operation is declared.

Parameters:

owner - the Workframe

setCollectType

public void setCollectType(Type type)

Sets the Brahms element type when this assignment has a lhs with a Java Collection type that can contain elements of the right-hand side expression's type.

Parameters:

type - the Brahms type for the collection elements if the assignment should add all right-hand side values to a collection assigned to the lhs variable or parameter

getCollectType

public Type getCollectType()

Returns the Brahms element type when this assignment has a lhs with a Java Collection type that can be assigned a list containing elements of the right-hand side expression's type.

Returns:

Type the Brahms type for the collection elements if the assignment should add all right-hand side values to a collection assigned to the lhs variable or parameter

getOwner

public Workframe getOwner()

Returns the Workframe in which the assignment operation is declared.

Returns:

Workframe the owner

delete

public void delete()

Deletes this element from the model and removes all references to this element in other model elements.

Overrides:

delete in class BrahmsObject

toString

public java.lang.String toString()

Returns the source code representation for this Assignment operation.

Overrides:

toString in class java.lang.Object

Returns:

String the source code representation