org.primordion.xholon.base
Interface IMessage

All Superinterfaces:

IXholon

All Known Implementing Classes:

Message

public interface IMessage

extends IXholon

ROOM/UML2 message.

Since:

0.1 (Created on Aug 17, 2005)

Author:

Ken Webb

Field Summary

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

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.

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

Method Detail

getData

public java.lang.Object getData()

Get the optional data included with the message.

Returns:

Any data that was sent with the message, or null.

setData

public void setData(java.lang.Object data)

Set the data to be sent with the message.

Parameters:

data - The data to include with the message.

getReceiver

public IXholon getReceiver()

Get the intended receiver of the message.

Returns:

The receiver.

setReceiver

public void setReceiver(IXholon receiver)

Set the intended receiver of the message.

Parameters:

receiver - The receiver.

getSender

public IXholon getSender()

Get the sender of the message.

Returns:

The sender.

setSender

public void setSender(IXholon sender)

Set which Xholon instance sent the message.

Parameters:

sender - The sender.

getSignal

public int getSignal()

Get the signal that identifies the type of message.

Returns:

The signal.

setSignal

public void setSignal(int signal)

Set the signal that identifies the message type.

Parameters:

signal - The signal.

getIndex

public int getIndex()

Get the index.

Returns:

The index.

setIndex

public void setIndex(int index)

Set the index.

Parameters:

index - The index.