MATHVisualSimulator
A BPMN2 simulator for MATH
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Properties
Simulator.BPNode Class Reference

The base class for all of the BP* classes, representing a generic BPMN node. More...

Inherited by Simulator.BPCallActivity, Simulator.BPEvent, Simulator.BPFlow, Simulator.BPGateway, Simulator.BPLane, Simulator.BPMetaNode, Simulator.BPParticipant, Simulator.BPResource, and Simulator.BPTask.

List of all members.

Public Member Functions

 BPNode (Simulator sim)
virtual bool validate ()
 Check this node to see whether it makes sense semantically.
virtual void reset ()
 Reset simulation counters for this node.
virtual void parseSimulationParameters (XmlNode x)
 Parse simulation parameters for this node.
BPNode getParent ()
 Retrieve the parent node for this node. Ordinarily this would be a BPProcess node; for BPProcess nodes the parent might be a BPMetaNode.
virtual void parse (XmlNode x)
 Parse the main BPMN XML parameters into this node.
virtual XmlElement getSemanticXml (XmlDocument doc)
 Create a BPMN semantic node from this BPNode.
virtual XmlElement getSimulationXml (XmlDocument doc)
 Create a simulation extension node from this BPNode.
virtual void add (BPNode c)
 Note that the given node is this node's child. Perform any necessary adjustments to acknowledge that fact.
virtual void finishParsing ()
 Finish up this node, after all the nodes have been created.
virtual long getDuration ()
virtual int getCost ()
virtual long getDelay ()
virtual void delay (Runner rr)
 Delay a token at this node.
virtual void enter (Runner rr)
 Enter a token into this node.
virtual void exit (Runner rr)
 Exit a token from this node.
virtual void addResourceWait (Runner rr, long duration)
 Note that a node has spent some time in resource wait at this node.
virtual string getBPNodeType ()
 Return the tag used to generate this node. Children will override to add their own parameters.

Public Attributes

Simulator sim = null
BpmnGeometry geometry = null
const long defaultDuration = 10
const long glueTimeMilliseconds = 10
int nEntries = 0
int nDelays = 0
long timeSpentWaiting = 0
double wq = 0

Static Public Attributes

static int maxNEntries = 0
static int maxNDelays = 0
static long maxTimeSpentWaiting = 0
static double maxWQ = 0

Protected Member Functions

string getChildInnerText (XmlNode x, string nodename)
void ReportValidationError (string s, bool error=true)

Protected Attributes

string idVal = null
string originalLocalName = null

Properties

string id [get]
string name [get]
string nameOrId [get]

Detailed Description

The base class for all of the BP* classes, representing a generic BPMN node.


Member Function Documentation

virtual void Simulator.BPNode.add ( BPNode  c) [virtual]

Note that the given node is this node's child. Perform any necessary adjustments to acknowledge that fact.

Parameters:
cThe new child node

Reimplemented in Simulator.BPMetaNode, and Simulator.BPProcess.

virtual void Simulator.BPNode.addResourceWait ( Runner  rr,
long  duration 
) [virtual]

Note that a node has spent some time in resource wait at this node.

Parameters:
rrThe token
durationThe time spent waiting
virtual void Simulator.BPNode.delay ( Runner  rr) [virtual]

Delay a token at this node.

Parameters:
rrThe token to be delayed

Reimplemented in Simulator.BPProcess.

virtual void Simulator.BPNode.enter ( Runner  rr) [virtual]
virtual void Simulator.BPNode.exit ( Runner  rr) [virtual]
virtual void Simulator.BPNode.finishParsing ( ) [virtual]

Finish up this node, after all the nodes have been created.

Reimplemented in Simulator.BPCallActivity, Simulator.BPEvent, Simulator.BPFlow, Simulator.BPProcess, Simulator.BPResourceRole, and Simulator.BPTask.

virtual string Simulator.BPNode.getBPNodeType ( ) [virtual]

Return the tag used to generate this node. Children will override to add their own parameters.

Returns:
The tag

Reimplemented in Simulator.BPEvent.

virtual int Simulator.BPNode.getCost ( ) [virtual]
Returns:
Get an instance of the cost of the activity.

Reimplemented in Simulator.BPTask.

virtual long Simulator.BPNode.getDelay ( ) [virtual]
Returns:
Get an instance of the delay before the activity can begin, in milliseconds.

Reimplemented in Simulator.BPTask.

virtual long Simulator.BPNode.getDuration ( ) [virtual]
Returns:
Get an instance of the duration of the activity, in milliseconds.

Reimplemented in Simulator.BPTask.

BPNode Simulator.BPNode.getParent ( )

Retrieve the parent node for this node. Ordinarily this would be a BPProcess node; for BPProcess nodes the parent might be a BPMetaNode.

Returns:
virtual XmlElement Simulator.BPNode.getSemanticXml ( XmlDocument  doc) [virtual]

Create a BPMN semantic node from this BPNode.

Parameters:
docAn XML Document object that will own the new BPMN node
Returns:
The created XML node

Reimplemented in Simulator.BPCallActivity, Simulator.BPEvent, Simulator.BPFlow, Simulator.BPGateway, Simulator.BPProcess, Simulator.BPResource, Simulator.BPResourceRole, and Simulator.BPTask.

virtual XmlElement Simulator.BPNode.getSimulationXml ( XmlDocument  doc) [virtual]

Create a simulation extension node from this BPNode.

Parameters:
docAn XML Document object that will own the new simulation node
Returns:
The created XML node

Reimplemented in Simulator.BPEvent, Simulator.BPFlow, Simulator.BPResource, and Simulator.BPTask.

virtual void Simulator.BPNode.parse ( XmlNode  x) [virtual]

Parse the main BPMN XML parameters into this node.

Parameters:
xThe BPMN XML node, from which parameters are to be taken.

Reimplemented in Simulator.BPCallActivity, Simulator.BPFlow, Simulator.BPMetaNode, Simulator.BPResource, Simulator.BPResourceRole, and Simulator.BPTask.

virtual void Simulator.BPNode.parseSimulationParameters ( XmlNode  x) [virtual]

Parse simulation parameters for this node.

Parameters:
xThe parameter to parse

Reimplemented in Simulator.BPEvent, Simulator.BPFlow, Simulator.BPGateway, Simulator.BPResource, and Simulator.BPTask.

virtual void Simulator.BPNode.reset ( ) [virtual]

Reset simulation counters for this node.

Reimplemented in Simulator.BPResource.

virtual bool Simulator.BPNode.validate ( ) [virtual]

Check this node to see whether it makes sense semantically.

Returns:

Reimplemented in Simulator.BPCallActivity, Simulator.BPEvent, Simulator.BPFlow, and Simulator.BPGateway.


The documentation for this class was generated from the following file: