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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CommunicateActivity, VMBroadcastActivity

public class BroadcastActivity
extends PrimitiveActivity

The broadcast activity is a primitive activity but allows for the initiator to broadcast information into a location. By default every agent in the same location as the initiator will receive the broadcasted belief. The model builder can instead also specify to what areas the beliefs are to be broadcast indicating whether their sub areas should be included or not. If the model builder specifies a list of areas then the broadcast will communicate all beliefs to be broadcast to all agents located in those specified areas. The model builder can specify when the actual transfer has to take place by setting the trigger value to either start or end. The user can in this case not specify with whom or what should be communicated.

Version:

$Revision: 1.2 $ $Date: 2009/11/23 19:06:40 $ $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

BroadcastActivity()
Constructor, creates a new broadcast activity.

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

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

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

Method Summary

boolean	addToArea(Area obj) Adds a new area as a 'to' area to the activity.
boolean	addToArea(Parameter p) Adds a new 'to' area referenced by the specified parameter to the activity.
boolean	addTransferDefinition(TransferDefinition td)
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	getToAreas() Returns all the to-areas specified in the activity
java.lang.Object	getToSubAreas() Indicates whether the broadcast should send beliefs not only to the areas listed by the 'to' property but also to its sub areas.
java.util.Enumeration	getTransferDefinitions()
int	getType()
Parameter	getTypeParameter()
int	getWhen()
Parameter	getWhenParameter()
boolean	hasToAreas() Returns whether the activity specifies to-areas.
boolean	hasTransferDefinitions()
protected void	setID() Sets the unique identifier.
void	setToSubAreas(java.lang.Boolean b) Sets the indicator whether the broadcast should send beliefs not only to the areas listed by the 'to' property but also to its sub areas.
void	setToSubAreas(Parameter p) Sets the indicator whether the broadcast should send beliefs not only to the areas listed by the 'to' property but also to its sub areas.
void	setType(int i)
void	setType(Parameter p)
void	setWhen(int i)
void	setWhen(Parameter p)

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

BroadcastActivity

public BroadcastActivity()

Constructor, creates a new broadcast activity.

BroadcastActivity

public BroadcastActivity(java.lang.String name)

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

Parameters:

name - the name of the broadcast activity

BroadcastActivity

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

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

Parameters:

file - the file in which the broadcast activity is specified

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

BroadcastActivity

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

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

Parameters:

name - the name of the broadcast activity

file - the file in which the broadcast 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 PrimitiveActivity

setType

public void setType(int i)

setType

public void setType(Parameter p)

getType

public int getType()

getTypeParameter

public Parameter getTypeParameter()

addToArea

public boolean addToArea(Parameter p)

Adds a new 'to' area referenced by the specified parameter to the activity.

Parameters:

p - the parameter referencing the area

Returns:

boolean true if added, false otherwise

addToArea

public boolean addToArea(Area obj)

Adds a new area as a 'to' area to the activity.

Parameters:

obj - the to-Area

Returns:

boolean true if added, false otherwise

hasToAreas

public boolean hasToAreas()

Returns whether the activity specifies to-areas.

Returns:

boolean true if the activity specifies to-areas, false otherwise

getToAreas

public java.util.Enumeration getToAreas()

Returns all the to-areas specified in the activity

Returns:

Enumeration a list of the to-areas, Parameters and/or Areas

setToSubAreas

public void setToSubAreas(Parameter p)

Sets the indicator whether the broadcast should send beliefs not only to the areas listed by the 'to' property but also to its sub areas.

Parameters:

p - the parameter specifying the boolean value.

setToSubAreas

public void setToSubAreas(java.lang.Boolean b)

Sets the indicator whether the broadcast should send beliefs not only to the areas listed by the 'to' property but also to its sub areas.

Parameters:

b - the Boolean value specifying.

getToSubAreas

public java.lang.Object getToSubAreas()

Indicates whether the broadcast should send beliefs not only to the areas listed by the 'to' property but also to its sub areas.

Returns:

Object a Boolean or Parameter

See Also:

setToSubAreas(gov.nasa.arc.brahms.common.data.Parameter)

addTransferDefinition

public boolean addTransferDefinition(TransferDefinition td)

getTransferDefinitions

public java.util.Enumeration getTransferDefinitions()

hasTransferDefinitions

public boolean hasTransferDefinitions()

setWhen

public void setWhen(int i)

setWhen

public void setWhen(Parameter p)

getWhen

public int getWhen()

getWhenParameter

public Parameter getWhenParameter()

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 PrimitiveActivity

Returns:

IActivityCtx the activity's context