org.primordion.xholon.base
Class Message

java.lang.Object
  extended byorg.primordion.xholon.base.Xholon
      extended byorg.primordion.xholon.base.Message
All Implemented Interfaces:
IMessage, IXholon

public class Message
extends Xholon
implements IMessage

ROOM/UML2 message.

Since:
0.1 (Created on Aug 17, 2005)
Author:
Ken Webb

Field Summary
 
Fields inherited from class org.primordion.xholon.base.Xholon
DEFAULT_LEVEL, interaction, interactionsEnabled
 
Fields inherited from interface org.primordion.xholon.base.IXholon
DEFAULT_SIZE_MSG_Q, NINCLUDE_PSC, NINCLUDE_PSx, NINCLUDE_PxC, NINCLUDE_Pxx, NINCLUDE_xSC, NINCLUDE_xSx, NINCLUDE_xxC, NINCLUDE_xxx
 
Constructor Summary
Message(int signal, java.lang.Object data, IXholon sender, IXholon receiver)
          Constructor.
Message(int signal, java.lang.Object data, IXholon sender, IXholon receiver, int index)
          Constructor.
Message(Message msg)
          Constructor.
 
Method Summary
 java.lang.Object getData()
          Get the optional data included with the message.
 int getIndex()
          Get the index.
 IXholon getReceiver()
          Get the intended receiver of the message.
 IXholon getSender()
          Get the sender of the message.
 int getSignal()
          Get the signal that identifies the type of message.
 void setData(java.lang.Object data)
          Set the data to be sent with the message.
 void setIndex(int index)
          Set the index.
 void setReceiver(IXholon receiver)
          Set the intended receiver of the message.
 void setSender(IXholon sender)
          Set which Xholon instance sent the message.
 void setSignal(int signal)
          Set the signal that identifies the message type.
 java.lang.String toString()
           
 
Methods inherited from class org.primordion.xholon.base.Xholon
act, appendChild, appendChild, appendChild, cleanup, configure, configure, createStructure, decVal, decVal, depth, draw, getChildNodes, getFirstChild, getFirstSibling, getId, getLastChild, getLastSibling, getName, getNeighbors, getNextId, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumSiblings, getParentNode, getPort, getPreviousSibling, getRoleName, getRootNode, getSiblings, getSizeMessageQ, getUid, getVal_boolean, getVal_byte, getVal_char, getVal_double, getVal_float, getVal_int, getVal_long, getVal_Object, getVal_short, getVal_String, getVal, getXhc, getXhcId, getXhcName, getXhType, handleNodeSelection, hasAncestor, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, height, incVal, incVal, initialize, initStatics, inOrderPrint, insertAfter, insertBefore, insertFirstChild, isActiveObject, isBound, isContainer, isExternal, isInternal, isLeaf, isPassiveObject, isRootNode, performActivity, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performGuard, performVoidActivity, postAct, postConfigure, postOrderPrint, postReconfigure, preAct, preConfigure, preOrderPrint, preReconfigure, print, println, processMessageQ, processReceivedMessage, reconfigure, remove, removeChild, resetNextId, sendMessage, sendMessage, sendMessage, setAttributeVal, setFactory, setFirstChild, setId, setNextSibling, setParentChildLinks, setParentNode, setParentSiblingLinks, setPorts, setRoleName, setSizeMessageQ, setUid, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVariableValue, setXhc, swapNode, terminate, treeSize, writeXml
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.primordion.xholon.base.IXholon
act, appendChild, appendChild, appendChild, cleanup, configure, configure, createStructure, decVal, decVal, depth, draw, getChildNodes, getFirstChild, getFirstSibling, getId, getLastChild, getLastSibling, getName, getNeighbors, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumSiblings, getParentNode, getPort, getPreviousSibling, getRoleName, getRootNode, getSiblings, getUid, getVal_boolean, getVal_byte, getVal_char, getVal_double, getVal_float, getVal_int, getVal_long, getVal_Object, getVal_short, getVal_String, getVal, getXhc, getXhcId, getXhcName, getXhType, handleNodeSelection, hasAncestor, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, height, incVal, incVal, initialize, initStatics, inOrderPrint, insertAfter, insertBefore, insertFirstChild, isActiveObject, isBound, isContainer, isExternal, isInternal, isLeaf, isPassiveObject, isRootNode, performActivity, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performGuard, performVoidActivity, postAct, postConfigure, postOrderPrint, postReconfigure, preAct, preConfigure, preOrderPrint, preReconfigure, print, println, processMessageQ, processReceivedMessage, reconfigure, remove, removeChild, sendMessage, sendMessage, sendMessage, setAttributeVal, setFirstChild, setId, setNextSibling, setParentChildLinks, setParentNode, setParentSiblingLinks, setPorts, setRoleName, setUid, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVariableValue, setXhc, swapNode, terminate, treeSize, writeXml
 

Constructor Detail

Message

public Message(int signal,
               java.lang.Object data,
               IXholon sender,
               IXholon receiver)
Constructor.

Parameters:
signal - An identifier for this message.
data - Any data that may be transmitted with the message.
sender - Which Xholon instance sent the message.
receiver - Which Xholon instance should receive the message.

Message

public Message(int signal,
               java.lang.Object data,
               IXholon sender,
               IXholon receiver,
               int index)
Constructor.

Parameters:
signal - An identifier for this message.
data - Any data that may be transmitted with the message.
sender - Which Xholon instance sent the message.
receiver - Which Xholon instance should receive the message.
index - The index of the replicated receiver port.

Message

public Message(Message msg)
Constructor.

Parameters:
msg - An existing message.
Method Detail

getData

public java.lang.Object getData()
Description copied from interface: IMessage
Get the optional data included with the message.

Specified by:
getData in interface IMessage
Returns:
Any data that was sent with the message, or null.

setData

public void setData(java.lang.Object data)
Description copied from interface: IMessage
Set the data to be sent with the message.

Specified by:
setData in interface IMessage
Parameters:
data - The data to include with the message.

getReceiver

public IXholon getReceiver()
Description copied from interface: IMessage
Get the intended receiver of the message.

Specified by:
getReceiver in interface IMessage
Returns:
The receiver.

setReceiver

public void setReceiver(IXholon receiver)
Description copied from interface: IMessage
Set the intended receiver of the message.

Specified by:
setReceiver in interface IMessage
Parameters:
receiver - The receiver.

getSender

public IXholon getSender()
Description copied from interface: IMessage
Get the sender of the message.

Specified by:
getSender in interface IMessage
Returns:
The sender.

setSender

public void setSender(IXholon sender)
Description copied from interface: IMessage
Set which Xholon instance sent the message.

Specified by:
setSender in interface IMessage
Parameters:
sender - The sender.

getSignal

public int getSignal()
Description copied from interface: IMessage
Get the signal that identifies the type of message.

Specified by:
getSignal in interface IMessage
Returns:
The signal.

setSignal

public void setSignal(int signal)
Description copied from interface: IMessage
Set the signal that identifies the message type.

Specified by:
setSignal in interface IMessage
Parameters:
signal - The signal.

getIndex

public int getIndex()
Description copied from interface: IMessage
Get the index.

Specified by:
getIndex in interface IMessage
Returns:
The index.

setIndex

public void setIndex(int index)
Description copied from interface: IMessage
Set the index.

Specified by:
setIndex in interface IMessage
Parameters:
index - The index.

toString

public java.lang.String toString()
Overrides:
toString in class Xholon