org.primordion.xholon.xmiapps
Class Xh__XholonTemplate__

java.lang.Object
  org.primordion.xholon.base.Xholon
      org.primordion.xholon.base.XholonWithPorts
          org.primordion.xholon.xmiapps.Xh__XholonTemplate__

All Implemented Interfaces:

Ce__XholonTemplate__, IXholon

public class Xh__XholonTemplate__

extends XholonWithPorts

implements Ce__XholonTemplate__

__XholonTemplate__ application - Xholon Java

Author: KenWebb

Date: 23/05/2007

File: __XholonTemplate__.mdzip

Target: Xholon 0.5 http://www.primordion.com/Xholon

UML: MagicDraw UML 11.5

XMI: 2.1, Thu Feb 22 13:00:05 EST 2007

XSLT: 1, Apache Software Foundation, http://xml.apache.org/xalan-j

Field Summary

java.lang.String	roleName
static int	SamplePort
static int	SIG_SAMPLE

Fields inherited from class org.primordion.xholon.base.XholonWithPorts

port

Fields inherited from class org.primordion.xholon.base.Xholon

DEFAULT_LEVEL, interaction, interactionsEnabled

Fields inherited from interface org.primordion.xholon.xmiapps.Ce__XholonTemplate__

AnotherPartOfTheSystemCE, APartOfTheSystemCE, includeCE, TheSystemCE, XholonClassCE

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

Xh__XholonTemplate__()

Method Summary

void	act() Do some action during this time step.
void	decVal(double decAmount) Decrement an internal double value by a specified amount.
static java.lang.String	getAppSpecificParam1()
java.lang.String	getRoleName() Get name of the role played by this Xholon within a specific context.
double	getVal() Get the value of a "double" maintained by this xholon instance.
void	incVal(double incAmount) Increment an internal double value by a specified amount.
void	initialize() Initialize the tree node.
void	performActivity(int activityId, IMessage msg) Do the UML2 Activity identified by the activityId.
boolean	performGuard(int activityId, IMessage msg) Do the UML2 Activity identified by the activityId.
void	postAct() Do any required work after doing the main action during a time step.
void	postConfigure() Perform some action, typically once at start up; MAY be overridden.
void	preAct() Do any setup required before doing the main action during a time step.
void	processReceivedMessage(Message msg) Process a received ROOM/UML2 message taken from the message queue.
static void	setAppSpecificParam1(java.lang.String AppSpecificParam1Arg)
void	setRoleName(java.lang.String roleName) Set name of the role played by this Xholon within a specific context.
void	setVal(double val) Set the value of a "double" maintained by this xholon instance.
java.lang.String	toString()

Methods inherited from class org.primordion.xholon.base.XholonWithPorts

configure, getMaxPorts, getPort, isActiveObject, isBound, isContainer, isPassiveObject, setMaxPorts, setPorts, terminate

Methods inherited from class org.primordion.xholon.base.Xholon

appendChild, appendChild, appendChild, cleanup, configure, createStructure, decVal, depth, draw, getChildNodes, getFirstChild, getFirstSibling, getId, getLastChild, getLastSibling, getName, getNeighbors, getNextId, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumSiblings, getParentNode, getPreviousSibling, getRootNode, getSiblings, getSizeMessageQ, getUid, getVal_boolean, getVal_byte, getVal_char, getVal_double, getVal_float, getVal_int, getVal_long, getVal_Object, getVal_short, getVal_String, getXhc, getXhcId, getXhcName, getXhType, handleNodeSelection, hasAncestor, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, height, incVal, initStatics, inOrderPrint, insertAfter, insertBefore, insertFirstChild, isExternal, isInternal, isLeaf, isRootNode, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performVoidActivity, postOrderPrint, postReconfigure, preConfigure, preOrderPrint, preReconfigure, print, println, processMessageQ, reconfigure, remove, removeChild, resetNextId, sendMessage, sendMessage, sendMessage, setAttributeVal, setFactory, setFirstChild, setId, setNextSibling, setParentChildLinks, setParentNode, setParentSiblingLinks, setSizeMessageQ, setUid, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVariableValue, setXhc, swapNode, treeSize, writeXml

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SamplePort

public static final int SamplePort

See Also:

Constant Field Values

SIG_SAMPLE

public static final int SIG_SAMPLE

See Also:

Constant Field Values

roleName

public java.lang.String roleName

Constructor Detail

Xh__XholonTemplate__

public Xh__XholonTemplate__()

Method Detail

setRoleName

public void setRoleName(java.lang.String roleName)

Description copied from interface: IXholon

Set name of the role played by this Xholon within a specific context.

Specified by:

setRoleName in interface IXholon

Overrides:

setRoleName in class Xholon

getRoleName

public java.lang.String getRoleName()

Description copied from interface: IXholon

Get name of the role played by this Xholon within a specific context.

Specified by:

getRoleName in interface IXholon

Overrides:

getRoleName in class Xholon

setVal

public void setVal(double val)

Description copied from interface: IXholon

Set the value of a "double" maintained by this xholon instance.

Specified by:

setVal in interface IXholon

Overrides:

setVal in class Xholon

getVal

public double getVal()

Description copied from interface: IXholon

Get the value of a "double" maintained by this xholon instance. If a class that implements this interface does not maintain such a value, it should return 0.0 This method can be used in place of getVal_double()

Specified by:

getVal in interface IXholon

Overrides:

getVal in class Xholon

setAppSpecificParam1

public static void setAppSpecificParam1(java.lang.String AppSpecificParam1Arg)

getAppSpecificParam1

public static java.lang.String getAppSpecificParam1()

initialize

public void initialize()

Description copied from interface: IXholon

Initialize the tree node. Typically this is only used to re-initialize a node, such as when it is reused through the TreeNodeFactoryStatic.

Specified by:

initialize in interface IXholon

Overrides:

initialize in class XholonWithPorts

decVal

public void decVal(double decAmount)

Description copied from interface: IXholon

Decrement an internal double value by a specified amount. This is a convenience method.

Specified by:

decVal in interface IXholon

Overrides:

decVal in class Xholon

incVal

public void incVal(double incAmount)

Description copied from interface: IXholon

Increment an internal double value by a specified amount. This is a convenience method.

Specified by:

incVal in interface IXholon

Overrides:

incVal in class Xholon

postConfigure

public void postConfigure()

Description copied from interface: IXholon

Perform some action, typically once at start up; MAY be overridden. Recursive; application should call this only for root.

Specified by:

postConfigure in interface IXholon

Overrides:

postConfigure in class XholonWithPorts

preAct

public void preAct()

Description copied from interface: IXholon

Do any setup required before doing the main action during a time step.

Specified by:

preAct in interface IXholon

Overrides:

preAct in class Xholon

act

public void act()

Description copied from interface: IXholon

Do some action during this time step. Typically all nodes in the tree will do their pre-actions (optional), then all will do their actions, and then all will do their post-actions (optional).

Specified by:

act in interface IXholon

Overrides:

act in class Xholon

postAct

public void postAct()

Description copied from interface: IXholon

Do any required work after doing the main action during a time step.

Specified by:

postAct in interface IXholon

Overrides:

postAct in class Xholon

processReceivedMessage

public void processReceivedMessage(Message msg)

Description copied from interface: IXholon

Process a received ROOM/UML2 message taken from the message queue. All sent messages are placed in queues before they are processed.

Specified by:

processReceivedMessage in interface IXholon

Overrides:

processReceivedMessage in class Xholon

performActivity

public void performActivity(int activityId,
                            IMessage msg)

Description copied from interface: IXholon

Do the UML2 Activity identified by the activityId. This is code called during a state Transition, or while entering, exiting, or within a State.

Specified by:

performActivity in interface IXholon

Overrides:

performActivity in class Xholon

performGuard

public boolean performGuard(int activityId,
                            IMessage msg)

Description copied from interface: IXholon

Do the UML2 Activity identified by the activityId. This is code called before a Transition from a State or Choice, to check the Guard conditions.

Specified by:

performGuard in interface IXholon

Overrides:

performGuard in class Xholon

toString

public java.lang.String toString()

Overrides:

toString in class Xholon