public interface IInteraction extends IXholon
Modifier and Type | Field and Description |
---|---|
static int |
FORMAT_NONE |
static int |
FORMAT_PLANTUML |
static int |
FORMAT_ROSE |
static int |
FORMAT_SDEDIT |
static int |
FORMAT_SDEDIT_SOCKET |
static int |
FORMAT_UML_GRAPH |
static int |
FORMAT_WEBSD |
static int |
MAX_DATA_LEN
Default max length of msg.data contents to output.
|
static int |
MAX_LIFELINES_STORED
Max number of objects to keep track of.
|
static int |
MAX_MESSAGES_STORED
Max number of messages stored,
|
static int |
MAX_NAME_LEN
Default max length of a class or role name to output.
|
DEFAULT_SIZE_MSG_Q, DEFAULT_SIZE_SYSTEM_MSG_Q, GETNAME_DEFAULT, GETNAME_LOCALPART_ID, GETNAME_NOROLENAME, GETNAME_ROLENAME_OR_CLASSNAME, GETNAME_ROLENAMESEP_, GETNAME_SIZE_TEMPLATE, NINCLUDE_PSC, NINCLUDE_PSx, NINCLUDE_PxC, NINCLUDE_Pxx, NINCLUDE_xSC, NINCLUDE_xSx, NINCLUDE_xxC, NINCLUDE_xxx, XHOLON_ID_DEFAULT, XHOLON_ID_NULL
Modifier and Type | Method and Description |
---|---|
void |
addMessage(IMessage msg)
Add a message to the interaction.
|
void |
addMessage(int signal,
java.lang.Object data,
IXholon sender,
IXholon receiver,
int index)
Add a message to the interaction.
|
void |
addState(IStateMachineEntity state)
Add a state to the sequence diagram, but only if getShowStates() == true.
|
void |
addSyncMessage(IMessage msg)
Add a Synchronous message to the interaction.
|
void |
createSequenceDiagram(java.lang.String modelName)
Create a sequence diagram from the interaction.
|
boolean |
getExcludeAdditionalSystemMessages()
Get whether or not to exclude additional system messages from the sequence diagram.
|
boolean |
getExcludeSystemMessages()
Get whether or not to exclude system messages from the sequence diagram.
|
int |
getMaxDataLen()
Get max length of msg.data contents to output.
|
int |
getMaxNameLen()
Get max length of a class or role name to output.
|
int |
getOutputFormat()
Get the output format.
|
IPortInterface |
getProvidedRequiredInterface()
Get an optional provided and/or required interface.
|
boolean |
getShowStates()
Get whether or not states will be shown on the sequence diagram.
|
java.lang.String |
getSocketHost()
Get the host for a socket connection, if using sdedit as a sequence diagram server.
|
int |
getSocketPort()
Get the port for a socket connection, if using sdedit as a sequence diagram server.
|
void |
processReceivedMessage(IMessage msg)
Process a message that was previously sent from one Xholon instance (the sender)
and added to the Interaction,
and has now been received by another Xholon instance (the receiver).
|
void |
setExcludeAdditionalSystemMessages(boolean excludeAdditionalSystemMessages)
Set whether or not to exclude additional system messages from the sequence diagram.
|
void |
setExcludeSystemMessages(boolean excludeSystemMessages)
Set whether or not to exclude system messages from the sequence diagram.
|
void |
setMaxDataLen(int maxDataLen)
Set max length of msg.data contents to output.
|
void |
setMaxNameLen(int maxNameLen)
Set max length of a class or role name to output.
|
void |
setOutputFormat(int outputFormat)
Set the output format.
|
void |
setProvidedRequiredInterface(IPortInterface providedRequiredInterface)
Set an optional provided and/or required interface.
|
void |
setShowStates(boolean showStates)
Set whether or not to show states on the sequence diagram.
|
void |
setSocketHost(java.lang.String socketHost)
Set the host for a socket connection, if using sdedit as a sequence diagram server.
|
void |
setSocketPort(int socketPort)
Set the port for a socket connection, if using sdedit as a sequence diagram server.
|
act, actNr, appendChild, appendChild, appendChild, appendsOwnChildren, bindPorts, cleanup, configure, configure, consoleLog, decVal, decVal, depth, doAction, findFirstChildWithXhClass, findFirstChildWithXhClass, forwardMessage, forwardSyncMessage, getActionList, getAllPorts, getAnnotation, getApp, getAttributeNodeXh, getAttributeXh, getChildNodes, getClassNode, getClassNode, getFirstChild, getFirstSibling, getId, getLastChild, getLastSibling, getName, getName, getNeighbors, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumLevels, getNumSiblings, getParentNode, getPort, getPort, getPreviousSibling, getRoleName, getRootNode, getSelfAndSiblings, getSelfAndSiblingsIndex, getService, getSiblings, getUid, getUri, getVal_boolean, getVal_byte, getVal_char, getVal_double, getVal_float, getVal_int, getVal_long, getVal_Object, getVal_short, getVal_String, getVal, getXhc, getXhcId, getXhcName, getXholon2Xml, getXhType, getXml2Xholon, handleNodeSelection, handleNodeSelection, hasAncestor, hasAnnotation, hasAttributeXh, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, hasSiblingNodes, height, incVal, incVal, initialize, initStatics, inOrderPrint, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertFirstChild, isActiveObject, isAttributeHandler, isBound, isContainer, isExternal, isInternal, isLeaf, isPassiveObject, isRootNode, isUniqueSibling, isUniqueSiblingRoleName, performActivity, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performGuard, performVoidActivity, postAct, postConfigure, postOrderPrint, postReconfigure, preAct, preConfigure, preOrderPrint, preReconfigure, print, println, processMessageQ, processReceivedSyncMessage, processSystemMessageQ, reconfigure, registerMessageForwardee, remove, removeAttributeNodeXh, removeAttributeXh, removeChild, replaceNode, searchForReferencingNodes, sendMessage, sendMessage, sendMessage, sendSyncMessage, sendSyncMessage, sendSyncMessage, sendSystemMessage, sendSystemMessage, setActionList, setAnnotation, setApp, setAttributeNodeXh, setAttributeVal, setAttributeXh, setFirstChild, setId, setName, setNextSibling, setParentChildLinks, setParentNode, setParentSiblingLinks, setPort, setPort, setPorts, setRoleName, setUid, setUri, setVal_boolean, setVal_byte, setVal_char, setVal_double, setVal_float, setVal_int, setVal_long, setVal_Object, setVal_short, setVal_String, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setXhc, showAnnotation, swapNode, terminate, toXml, toXmlAttribute, toXmlAttributes, toXmlText, treeSize, visit
static final int MAX_MESSAGES_STORED
static final int MAX_LIFELINES_STORED
static final int MAX_NAME_LEN
static final int MAX_DATA_LEN
static final int FORMAT_NONE
static final int FORMAT_UML_GRAPH
static final int FORMAT_SDEDIT
static final int FORMAT_SDEDIT_SOCKET
static final int FORMAT_ROSE
static final int FORMAT_PLANTUML
static final int FORMAT_WEBSD
void setOutputFormat(int outputFormat)
outputFormat
- One of FORMAT_UML_GRAPH, FORMAT_SDEDIT, FORMAT_SDEDIT_SOCKET.void setSocketHost(java.lang.String socketHost)
socketHost
- A valid socket host (ex: localhost).void setSocketPort(int socketPort)
socketPort
- A valid socket port (ex: 60001).void setShowStates(boolean showStates)
showStates
- true or falsevoid setExcludeSystemMessages(boolean excludeSystemMessages)
excludeSystemMessages
- true or falsevoid setExcludeAdditionalSystemMessages(boolean excludeAdditionalSystemMessages)
excludeAdditionalSystemMessages
- true or falsevoid setMaxNameLen(int maxNameLen)
maxNameLen
- The maximum length of the name.void setMaxDataLen(int maxDataLen)
maxDataLen
- The maximum length of the data.void setProvidedRequiredInterface(IPortInterface providedRequiredInterface)
providedRequiredInterface
- A fully initialized instance of IPortInterface.int getOutputFormat()
java.lang.String getSocketHost()
int getSocketPort()
boolean getShowStates()
boolean getExcludeSystemMessages()
boolean getExcludeAdditionalSystemMessages()
int getMaxNameLen()
int getMaxDataLen()
IPortInterface getProvidedRequiredInterface()
void addMessage(IMessage msg)
msg
- The message.void addMessage(int signal, java.lang.Object data, IXholon sender, IXholon receiver, int index)
signal
- A signal that identifies the type of message.data
- Optional data carried by the message.sender
- The sender of the message.receiver
- The intended receiver of the message.index
- A port replication index.void addSyncMessage(IMessage msg)
msg
- The message.void addState(IStateMachineEntity state)
state
- A state within a state machine.void processReceivedMessage(IMessage msg)
processReceivedMessage
in interface IXholon
msg
- The message that was received.org.primordion.xholon.base.IXholon#processReceivedMessage(org.primordion.xholon.base.Message)
void createSequenceDiagram(java.lang.String modelName)
modelName
- The name of this model.