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

java.lang.Object
  gov.nasa.arc.brahms.common.data.BrahmsObject
      gov.nasa.arc.brahms.common.data.ModelElement
          gov.nasa.arc.brahms.common.data.Condition
              gov.nasa.arc.brahms.common.data.TransferDefinition
                  gov.nasa.arc.brahms.vm.data.VMTransferDefinition

All Implemented Interfaces:

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

public class VMTransferDefinition
extends TransferDefinition

A VMTransferDefinition is a TransferDefinition with extensions for use in the Brahms virtual machine. A TransferDefinition is used in Broadcast and Communication activities and defines what information is to be transferred and in what direction the transfer needs to take place (send = to, receive = from).

Version:

8 August 2001

Author:

Ron van Hoof

See Also:

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

VMTransferDefinition()
Constructor, creates a new transfer definition.

VMTransferDefinition(Comparison c)
Constructor, creates a new transfer definition with the specified comparison specifying the information that needs to be transfered.

VMTransferDefinition(Comparison c, int truth)
Constructor, creates a new transfer definition with the specified comparison specifying the information that needs to be transfered and the truth value of the comparison.

VMTransferDefinition(int action, Comparison c)
Constructor, creates a new transfer definition with the specified comparison specifying the information that needs to be transfered and the action specifying the direction of the transfer.

VMTransferDefinition(int action, Comparison c, int truth)
Constructor, creates a new transfer definition with the specified comparison specifying the information that needs to be transfered, the truth value of the comparison and the action specifying the direction of the transfer.

Method Summary

ITransferDefinitionCtx	createContext() Creates a new context for this transfer definition.
java.util.LinkedList	getCommunicativeActs(VMActiveInstanceCtx agent, VMFrameCtx frame) Returns a list of CommunicativeAct objects defining the messages to be transferred.
java.util.LinkedList	getMatchingStatements(VMActiveInstanceCtx agent, VMFrameCtx frame) Returns a list of Statements that are created after matching the belief set with this condition.

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

getAction, isTransfersCommunicativeAct, setAction, setID, setTransfersCommunicativeAct, toString

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

getComparison, getOwner, getParameters, getTruthValue, getTruthValueAsString, getVariables, setComparison, setOwner, setOwner, setOwner, setTruthValue, toSource

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

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

VMTransferDefinition

public VMTransferDefinition()

Constructor, creates a new transfer definition.

VMTransferDefinition

public VMTransferDefinition(Comparison c)

Constructor, creates a new transfer definition with the specified comparison specifying the information that needs to be transfered.

Parameters:

c - the Comparison

VMTransferDefinition

public VMTransferDefinition(Comparison c,
                            int truth)

Constructor, creates a new transfer definition with the specified comparison specifying the information that needs to be transfered and the truth value of the comparison.

Parameters:

c - the Comparison

truth - the truth value (TRUE, FALSE, UNKNOWN)

See Also:

IConstants.TRUE, IConstants.FALSE, IConstants.UNKNOWN

VMTransferDefinition

public VMTransferDefinition(int action,
                            Comparison c)

Constructor, creates a new transfer definition with the specified comparison specifying the information that needs to be transfered and the action specifying the direction of the transfer.

Parameters:

action - the direction of the transfer (SEND or RECEIVE)

c - the Comparison

See Also:

IConstants.SEND, IConstants.RECEIVE

VMTransferDefinition

public VMTransferDefinition(int action,
                            Comparison c,
                            int truth)

Constructor, creates a new transfer definition with the specified comparison specifying the information that needs to be transfered, the truth value of the comparison and the action specifying the direction of the transfer.

Parameters:

action - the direction of the transfer (SEND or RECEIVE)

c - the Comparison

truth - the truth value (TRUE, FALSE, UNKNOWN)

See Also:

IConstants.SEND, IConstants.RECEIVE, IConstants.TRUE, IConstants.FALSE, IConstants.UNKNOWN

Method Detail

getCommunicativeActs

public java.util.LinkedList getCommunicativeActs(VMActiveInstanceCtx agent,
                                                 VMFrameCtx frame)

Returns a list of CommunicativeAct objects defining the messages to be transferred.

Parameters:

agent - the agent initiating the communication

frame - the frame in which the transfer definition is fired and containing the variable contexts

Returns:

LinkedList the list of VMObjectCtx for the CommunicativeActs.

getMatchingStatements

public java.util.LinkedList getMatchingStatements(VMActiveInstanceCtx agent,
                                                  VMFrameCtx frame)

Returns a list of Statements that are created after matching the belief set with this condition.

Parameters:

agent - the agent with whom's belief set is to be matched

frame - the frame in which the transfer definition is fired and containing the variable contexts

Returns:

LinkedList the list of Statements.

createContext

public ITransferDefinitionCtx createContext()

Creates a new context for this transfer definition.

Note: This method always returns a new instance and does not verify whether one is already created.

Returns:

ITransferDefinitionCtx a context for the transfer definition