public interface IPort extends IXholon
Modifier and Type | Field and Description |
---|---|
static int |
PORTINDEX_NULL
There is no port index, which normally means that the port is a scalar.
|
static int |
XPATH_EXPR_NO_INDEX
XPath expression, no index
|
static char |
XPATH_EXPR_WILDCARD
XPath expression template wildcard.
|
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 |
---|---|
boolean |
getIsConjugated()
Get whether or not this is a conjugated port.
|
IXholon |
getLink()
Get the link from a local port replication to a remote port or xholon.
|
IXholon |
getLink(int index)
Get the link from a local port replication to a remote port or xholon.
|
IPortInterface |
getProvidedInterface()
Get the provided interface of this port.
|
IPortInterface |
getRequiredInterface()
Get the required interface of this port.
|
void |
sendMessage(int signal,
java.lang.Object data,
IXholon sender,
int index)
Send a ROOM/UML2 message through a local instance of a replicated port
to a remote replicated port instance or directly to a remote xholon,
or from a remote port replication to its owning xholon.
|
void |
setIsConjugated(boolean isConjugated)
Set whether or not this is a conjugated port.
|
boolean |
setLink(int index,
IXholon context,
java.lang.String xpathExpression)
Set the link from a local port replication to a remote port or xholon.
|
boolean |
setLink(int index,
IXholon context,
java.lang.String xpathExprTemplate,
int xholonIx,
int portIx,
int replicationIx)
Set the link from a local port replication to a remote port or xholon.
|
void |
setProvidedInterface(IPortInterface providedInterface)
Set the provided interface of this port.
|
void |
setReplications(int multiplicity)
Set the replication factor of a remote port, and create the remote port.
|
void |
setRequiredInterface(IPortInterface requiredInterface)
Set the required interface of this port.
|
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, processReceivedMessage, processReceivedSyncMessage, processSystemMessageQ, reconfigure, registerMessageForwardee, remove, removeAttributeNodeXh, removeAttributeXh, removeChild, replaceNode, searchForReferencingNodes, 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 char XPATH_EXPR_WILDCARD
static final int XPATH_EXPR_NO_INDEX
static final int PORTINDEX_NULL
void setProvidedInterface(IPortInterface providedInterface)
providedInterface
- An array of zero or more signal IDs.IPortInterface getProvidedInterface()
void setRequiredInterface(IPortInterface requiredInterface)
requiredInterface
- An array of zero or more signal IDs.IPortInterface getRequiredInterface()
void setIsConjugated(boolean isConjugated)
isConjugated
- true (conjugated) or false (non-conjugated). default: falseboolean getIsConjugated()
void setReplications(int multiplicity)
multiplicity
- The maximum number of instances of the remote port.boolean setLink(int index, IXholon context, java.lang.String xpathExprTemplate, int xholonIx, int portIx, int replicationIx)
index
- Index of the local replicated port on which the link is to be set.context
- The xholon that owns the port and port replication.xpathExprTemplate
- XPath expression template.xholonIx
- Remote xholon index, used to fill in a value in the template.
If there is no index, then the value must be XPATH_EXPR_NO_INDEX.portIx
- Remote port index, used to fill in a value in the template.
If there is no index, then the value must be XPATH_EXPR_NO_INDEX.replicationIx
- Remote replication index, used to fill in a value in the template.
If there is no index, then the value must be XPATH_EXPR_NO_INDEX.boolean setLink(int index, IXholon context, java.lang.String xpathExpression)
index
- Index of the local replicated port on which the link is to be set.context
- The xholon that owns the port and port replication.xpathExpression
- Complete XPath expression.IXholon getLink(int index)
index
- Index of the local replicated port.IXholon getLink()
void sendMessage(int signal, java.lang.Object data, IXholon sender, int index)
sendMessage
in interface IXholon
signal
- A distinguishing identifier for this message.data
- Any data that needs to be sent (optional).sender
- The sender of the message.index
- Index of a replicated port (0 indexed).