ikr.simlib.entities.branches

Class Branch

java.lang.Object

ikr.simlib.entities.Entity

ikr.simlib.entities.branches.Expander<java.lang.Double>

ikr.simlib.entities.branches.Branch

public class Branch
extends Expander<java.lang.Double>

A branch element routes an incoming message randomly to one of its output ports. A probability can be assigned to each output port.

Branch has a fixed initial number of ports that can be defined on construction. The port probability can be defined by SetProbability. The ports are called "output 1", "output 2", ... . Moreover, it is possible to add and remove ports dynamically.

See Also:

Expander, BinaryBranch

Nested Class Summary

Nested classes/interfaces inherited from class ikr.simlib.entities.Entity

Entity.PortAlias

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isNormalized
protected RandomNumberGenerator	rng

Fields inherited from class ikr.simlib.entities.branches.Expander

inputPort, outputPorts, portParameters

Fields inherited from class ikr.simlib.entities.Entity

portAliases, ports, simNode

Constructor Summary

Constructors

Constructor and Description
Branch(int nrOfPorts, java.lang.String name, SimNode parentNode)
Branch(java.lang.String name, SimNode parentNode)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPort(java.lang.Double prob)
void	addPort(java.lang.String portName, java.lang.Double prob)
void	equalize()
double	getProbabilitySum()
protected SynchronousOutputPort	getRandomPort()
void	handleMessageIndication(Message msg)
void	normalize()
void	removePort(java.lang.String portName)
void	setProbability(int portNr, double prob)

Methods inherited from class ikr.simlib.entities.branches.Expander

portName2Index, setPortParameter

Methods inherited from class ikr.simlib.entities.Entity

addPort, aliasPort, aliasPort, connect, disconnect, getName, getNode, getPortByName, getPorts, isPortKnown, unaliasPort

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

isNormalized

protected boolean isNormalized

rng

protected RandomNumberGenerator rng

Constructor Detail

Branch

public Branch(int nrOfPorts,
      java.lang.String name,
      SimNode parentNode)

Branch

public Branch(java.lang.String name,
      SimNode parentNode)

Method Detail

getRandomPort

protected SynchronousOutputPort getRandomPort()

handleMessageIndication

public void handleMessageIndication(Message msg)

Specified by:

handleMessageIndication in class Expander<java.lang.Double>

addPort

public void addPort(java.lang.Double prob)

Overrides:

addPort in class Expander<java.lang.Double>

addPort

public void addPort(java.lang.String portName,
           java.lang.Double prob)

Overrides:

addPort in class Expander<java.lang.Double>

removePort

public void removePort(java.lang.String portName)

Overrides:

removePort in class Expander<java.lang.Double>

setProbability

public void setProbability(int portNr,
                  double prob)

getProbabilitySum

public double getProbabilitySum()

normalize

public void normalize()

equalize

public void equalize()