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

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.BroadcastActivity
                          gov.nasa.arc.brahms.common.data.CommunicateActivity

All Implemented Interfaces:

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

Direct Known Subclasses:

VMCommunicateActivity

public class CommunicateActivity
extends BroadcastActivity

A communicate activity is a primitive activity but allows for the communication of beliefs between the initiating agent or object and another agent or object. The user can specify when the actual transfer has to take place by setting the 'when' value to either start or end.

Version:

$Revision: 1.2 $ $Date: 2009/06/16 21:36:17 $ $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

CommunicateActivity()
Constructor, creates a new communicate activity.

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

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

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

Method Summary

boolean	addWith(Agent agt)
boolean	addWith(ObjectInstance obj)
boolean	addWith(Parameter p)
static int	convertCommunicationTypeSymbolToInt(java.lang.String type) Converts the communication type represented as a symbol to an integer constant.
static int	convertWhenSymbolToInt(java.lang.String when) Converts the when indicator represented as a symbol to an integer constant.
IActivityCtx	createContext() Creates a new context for this activity for use in a virtual machine.
java.util.Enumeration	getWith()
boolean	hasWith()
protected void	setID() Sets the unique identifier.

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

addToArea, addToArea, addTransferDefinition, getToAreas, getToSubAreas, getTransferDefinitions, getType, getTypeParameter, getWhen, getWhenParameter, hasToAreas, hasTransferDefinitions, setToSubAreas, setToSubAreas, setType, setType, setWhen, setWhen

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

CommunicateActivity

public CommunicateActivity()

Constructor, creates a new communicate activity.

CommunicateActivity

public CommunicateActivity(java.lang.String name)

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

Parameters:

name - the name of the communicate activity

CommunicateActivity

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

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

Parameters:

file - the file in which the communicate activity is specified

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

CommunicateActivity

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

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

Parameters:

name - the name of the communicate activity

file - the file in which the communicate activity is specified

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

Method Detail

convertCommunicationTypeSymbolToInt

public static int convertCommunicationTypeSymbolToInt(java.lang.String type)

Converts the communication type represented as a symbol to an integer constant.

Parameters:

type - the symbol representation

Returns:

int the constant value

convertWhenSymbolToInt

public static int convertWhenSymbolToInt(java.lang.String when)

Converts the when indicator represented as a symbol to an integer constant.

Parameters:

type - the symbol representation

Returns:

int the constant value

setID

protected void setID()

Sets the unique identifier.

Overrides:

setID in class BroadcastActivity

addWith

public boolean addWith(Parameter p)

addWith

public boolean addWith(ObjectInstance obj)

addWith

public boolean addWith(Agent agt)

getWith

public java.util.Enumeration getWith()

hasWith

public boolean hasWith()

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 BroadcastActivity

Returns:

IActivityCtx the activity's context