BPSimulator (QBP Simulator Engine 1.0.0 API)

java.lang.Object
- com.qbpsimulator.engine.BPSimulator

All Implemented Interfaces:

ISimulationLimits
```
public class BPSimulator
extends Object
implements ISimulationLimits
```
Class for the main entry point to the simulation process. Use: BPSimulator sim = new BPSimulator("myProcessModel.bpmn"); sim.run();

Author:

Madis Abel

Constructor Summary

Constructors
Constructor and Description

BPSimulator()

BPSimulator(List<String> processFiles)
Constructor with process model to simulate

Constructors
Constructor and Description
`BPSimulator()`
`BPSimulator(List<String> processFiles)` Constructor with process model to simulate

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`checkInterrupted()`
`Activity`	`getActivity(int index)` Returns activity by numeric index
`int`	`getActivityCount()`
`Activity`	`getCatchActivity(int parentProcessIndex, int subProcessIndex, String eventCode)` Returns intermediate or error event catch activity
`Clock`	`getClock()` Returns clock (time manager) for the simulation
`long`	`getEndTime()`
`IEventProcessor`	`getEventProcessor()` Returns the EventProcessor being used
`int`	`getFirstProcessInstanceForStats()` First process instance to start calculating statistics from (included).
`GatewayPathSelector`	`getGatewayPathSelector()` Returns the gateway path selector for this simulation
`int`	`getIdForNewProcessInstance()` Returns unique, auto increment, id for new process and sub-process instances
`int`	`getLastProcessInstanceForStats()` Last process instance to calculate statistics from (excluded).
`ComplexLogger`	`getLogger()` Returns default logger container to where optional loggers can be adde.
`Activity[]`	`getMainProcessStartEvents()` Returns array of Activity instances representing a start events of the main process
`int`	`getMaxAllowedArrivalPeriodLengthInSeconds()` Returns the maximum arrival period length in seconds.If 0 then unlimited
`int`	`getMaxAllowedCompletedElements()` Returns the maximum allowed elements to be processed in the simulation
`int`	`getMaxAllowedProcesses()`
`int`	`getMaxAllowedResourceInstances()`
`int`	`getMaxAllowedResources()`
`int`	`getMaxAllowedResourceTaskQueueSize()` Get the maximum allowed task queue size for resource
`int`	`getMaxSimulationCycleTimeInSeconds()` Gets the maximum allowed cycle time in simulation
`long`	`getNextSeq()` Returns the sequence number for a ProcessActivity
`RandomGenerator`	`getRandomGenerator()`
`ResourceManager`	`getResourceManager()` Returns the used resource manager component
`Date`	`getSimulationStartTime()` Gets the simulation start time
`long`	`getStartTime()`
`SimulationStatus`	`getStatus()` Returns status of the simulation
`Activity[]`	`getSubProcessStartEvents(Integer subProcessIndex)` Returns array of Activity instances representing a start events of a sub-process
`TokenFlow`	`getTokenFlow(int index)` Returns TokenFlow associated with numeric flow index.
`int`	`getTotalProcessedEvents()`
`int`	`getTotalProcessInstances()` Returns total number of process instances that the simulator created
`void`	`interrupt()`
`void`	`run()` Starts simulation
`void`	`setInputStreams(List<InputStream> inputStreams)` Sets the input streams of BPMN definitions to parse and simulate
`void`	`setMaxAllowedArrivalPeriodLengthInSeconds(int maxAllowedArrivalPeriodLengthInSeconds)` Sets the maximum period length for arrival period.
`void`	`setMaxAllowedArrivalPeriodLengthInSeoonds(int maxAllowedArrivalPeriodLengthInSeconds)` Deprecated. use setMaxAllowedArrivalPeriodLengthInSeconds()
`void`	`setMaxAllowedCompletedElements(int maxAllowedCompletedElements)` Sets the maximum allowed elements to be processed in the simulation, 0 to disable
`void`	`setMaxAllowedProcesses(int maxAllowedProcesses)`
`void`	`setMaxAllowedResourceInstances(int maxAllowedResourceInstances)`
`void`	`setMaxAllowedResources(int maxAllowedResources)`
`void`	`setMaxAllowedResourceTaskQueueSize(int maxAllowedResourceTaskQueueSize)` Set the maximum allowed task queue size for resource
`void`	`setMaxSimulationCycleTimeInSeconds(int maxSimulationCycleTimeInSeconds)` Set the maximum allowed simulation cycle time

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BPSimulator
```
public BPSimulator()
```
  - BPSimulator
```
public BPSimulator(List<String> processFiles)
```
    Constructor with process model to simulate
    
    Parameters:
    
    processFiles - Array of bpmn file names to process
- Method Detail
  - setInputStreams
```
public void setInputStreams(List<InputStream> inputStreams)
```
    Sets the input streams of BPMN definitions to parse and simulate
    
    Parameters:
    
    inputStreams - input streams of BPMN definitions to simulate
  - run
```
public void run()
         throws ModelParseException,
                BPSimulatorException,
                InterruptedException
```
    Starts simulation
    
    Throws:
    
    ModelParseException
    
    BPSimulatorException
    
    InterruptedException
  - getLogger
```
public ComplexLogger getLogger()
```
    Returns default logger container to where optional loggers can be adde.
    
    Returns:
    
    associated logger in the simulation
  - getTokenFlow
```
public TokenFlow getTokenFlow(int index)
```
    Returns TokenFlow associated with numeric flow index.
    
    Parameters:
    
    index - index of the flow
    
    Returns:
    
    TokenFlow corresponding to the index
  - getActivity
```
public Activity getActivity(int index)
```
    Returns activity by numeric index
    
    Parameters:
    
    index - index of activity
    
    Returns:
    
    Activity corresponding to the index
  - getSubProcessStartEvents
```
public Activity[] getSubProcessStartEvents(Integer subProcessIndex)
```
    Returns array of Activity instances representing a start events of a sub-process
    
    Parameters:
    
    subProcessIndex - index of the sub-process
    
    Returns:
    
    Start Event Activity instances
  - getMainProcessStartEvents
```
public Activity[] getMainProcessStartEvents()
                                     throws BPSimulatorException
```
    Returns array of Activity instances representing a start events of the main process
    
    Returns:
    
    Start Event Activity instances
    
    Throws:
    
    BPSimulatorException
  - getCatchActivity
```
public Activity getCatchActivity(int parentProcessIndex,
                                 int subProcessIndex,
                                 String eventCode)
```
    Returns intermediate or error event catch activity
    
    Parameters:
    
    parentProcessIndex - -1 for main process, index of process from where to search the event handler
    
    subProcessIndex - Sub-process index that threw an event
    
    eventCode - Event code to handle
    
    Returns:
    
    Activity representing a boundary catch event.
  - getClock
```
public Clock getClock()
```
    Returns clock (time manager) for the simulation
    
    Returns:
    
    the clock
  - getStatus
```
public SimulationStatus getStatus()
```
    Returns status of the simulation
    
    Returns:
    
    the status
  - getTotalProcessInstances
```
public int getTotalProcessInstances()
```
    Returns total number of process instances that the simulator created
    
    Returns:
    
    total number of process instances
  - getResourceManager
```
public ResourceManager getResourceManager()
```
    Returns the used resource manager component
    
    Returns:
    
    resource manager
  - getEventProcessor
```
public IEventProcessor getEventProcessor()
```
    Returns the EventProcessor being used
    
    Returns:
    
    resource manager
  - getGatewayPathSelector
```
public GatewayPathSelector getGatewayPathSelector()
```
    Returns the gateway path selector for this simulation
    
    Returns:
    
    the gatewayPathSelector
  - getNextSeq
```
public long getNextSeq()
```
    Returns the sequence number for a ProcessActivity
    
    Returns:
  - getIdForNewProcessInstance
```
public int getIdForNewProcessInstance()
```
    Returns unique, auto increment, id for new process and sub-process instances
    
    Returns:
    
    id for new process
  - getStartTime
```
public long getStartTime()
```
  - getEndTime
```
public long getEndTime()
```
  - getTotalProcessedEvents
```
public int getTotalProcessedEvents()
```
  - checkInterrupted
```
public void checkInterrupted()
                      throws InterruptedException
```
    Throws:
    
    InterruptedException
  - interrupt
```
public void interrupt()
```
  - getRandomGenerator
```
public RandomGenerator getRandomGenerator()
```
    Returns:
    
    the randomGenerator
  - getMaxAllowedCompletedElements
```
public int getMaxAllowedCompletedElements()
```
    Returns the maximum allowed elements to be processed in the simulation
    
    Specified by:
    
    getMaxAllowedCompletedElements in interface ISimulationLimits
    
    Returns:
    
    the maxAllowedCompletedElements
  - setMaxAllowedCompletedElements
```
public void setMaxAllowedCompletedElements(int maxAllowedCompletedElements)
```
    Sets the maximum allowed elements to be processed in the simulation, 0 to disable
    
    Specified by:
    
    setMaxAllowedCompletedElements in interface ISimulationLimits
    
    Parameters:
    
    maxAllowedCompletedElements - maximum allowed elements to be processed in the simulation to set
  - getMaxAllowedArrivalPeriodLengthInSeconds
```
public int getMaxAllowedArrivalPeriodLengthInSeconds()
```
    Returns the maximum arrival period length in seconds.If 0 then unlimited
    
    Specified by:
    
    getMaxAllowedArrivalPeriodLengthInSeconds in interface ISimulationLimits
    
    Returns:
    
    the maxAllowedArrivalPeriodLengthInSeconds
  - setMaxAllowedArrivalPeriodLengthInSeconds
```
public void setMaxAllowedArrivalPeriodLengthInSeconds(int maxAllowedArrivalPeriodLengthInSeconds)
```
    Sets the maximum period length for arrival period. In seconds. If 0 then unlimited
    
    Specified by:
    
    setMaxAllowedArrivalPeriodLengthInSeconds in interface ISimulationLimits
    
    Parameters:
    
    maxAllowedArrivalPeriodLengthInSeconds - the maxAllowedArrivalPeriodLengthInSeconds to set
  - setMaxAllowedArrivalPeriodLengthInSeoonds
```
public void setMaxAllowedArrivalPeriodLengthInSeoonds(int maxAllowedArrivalPeriodLengthInSeconds)
```
    Deprecated. use setMaxAllowedArrivalPeriodLengthInSeconds()
  - getMaxAllowedResources
```
public int getMaxAllowedResources()
```
    Specified by:
    
    getMaxAllowedResources in interface ISimulationLimits
    
    Returns:
    
    the maxAllowedResources
  - setMaxAllowedResources
```
public void setMaxAllowedResources(int maxAllowedResources)
```
    Specified by:
    
    setMaxAllowedResources in interface ISimulationLimits
    
    Parameters:
    
    maxAllowedResources - total number of different resource types allowed in simulation
  - getMaxAllowedResourceInstances
```
public int getMaxAllowedResourceInstances()
```
    Specified by:
    
    getMaxAllowedResourceInstances in interface ISimulationLimits
    
    Returns:
    
    the maximum amount of allowed resource instances per resource type
  - setMaxAllowedResourceInstances
```
public void setMaxAllowedResourceInstances(int maxAllowedResourceInstances)
```
    Specified by:
    
    setMaxAllowedResourceInstances in interface ISimulationLimits
    
    Parameters:
    
    maxAllowedResourceInstances - the number of resource instances that are allowed
  - getMaxAllowedProcesses
```
public int getMaxAllowedProcesses()
```
    Specified by:
    
    getMaxAllowedProcesses in interface ISimulationLimits
    
    Returns:
    
    the maximum number of process instances
  - setMaxAllowedProcesses
```
public void setMaxAllowedProcesses(int maxAllowedProcesses)
```
    Specified by:
    
    setMaxAllowedProcesses in interface ISimulationLimits
    
    Parameters:
    
    maxAllowedProcesses - maximum number of process instances
  - getActivityCount
```
public int getActivityCount()
```
  - getMaxSimulationCycleTimeInSeconds
```
public int getMaxSimulationCycleTimeInSeconds()
```
    Gets the maximum allowed cycle time in simulation
    
    Specified by:
    
    getMaxSimulationCycleTimeInSeconds in interface ISimulationLimits
    
    Returns:
    
    the maxSimulationCycleTimeInSeconds
  - setMaxSimulationCycleTimeInSeconds
```
public void setMaxSimulationCycleTimeInSeconds(int maxSimulationCycleTimeInSeconds)
```
    Set the maximum allowed simulation cycle time
    
    Specified by:
    
    setMaxSimulationCycleTimeInSeconds in interface ISimulationLimits
    
    Parameters:
    
    maxSimulationCycleTimeInSeconds - maximum allowed cycle time in seconds
  - getMaxAllowedResourceTaskQueueSize
```
public int getMaxAllowedResourceTaskQueueSize()
```
    Get the maximum allowed task queue size for resource
    
    Specified by:
    
    getMaxAllowedResourceTaskQueueSize in interface ISimulationLimits
    
    Returns:
    
    the maxAllowedResourceQueueSize
  - setMaxAllowedResourceTaskQueueSize
```
public void setMaxAllowedResourceTaskQueueSize(int maxAllowedResourceTaskQueueSize)
```
    Set the maximum allowed task queue size for resource
    
    Specified by:
    
    setMaxAllowedResourceTaskQueueSize in interface ISimulationLimits
    
    Parameters:
    
    maxAllowedResourceTaskQueueSize -
  - getSimulationStartTime
```
public Date getSimulationStartTime()
```
    Gets the simulation start time
    
    Returns:
    
    the simulationStartTime
  - getFirstProcessInstanceForStats
```
public int getFirstProcessInstanceForStats()
```
    First process instance to start calculating statistics from (included).
    
    Returns:
    
    process instance number
  - getLastProcessInstanceForStats
```
public int getLastProcessInstanceForStats()
```
    Last process instance to calculate statistics from (excluded).
    
    Returns:
    
    process instance number

Class BPSimulator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BPSimulator

BPSimulator

Method Detail

setInputStreams

run

getLogger

getTokenFlow

getActivity

getSubProcessStartEvents

getMainProcessStartEvents

getCatchActivity

getClock

getStatus

getTotalProcessInstances

getResourceManager

getEventProcessor

getGatewayPathSelector

getNextSeq

getIdForNewProcessInstance

getStartTime

getEndTime

getTotalProcessedEvents

checkInterrupted

interrupt

getRandomGenerator

getMaxAllowedCompletedElements

setMaxAllowedCompletedElements

getMaxAllowedArrivalPeriodLengthInSeconds

setMaxAllowedArrivalPeriodLengthInSeconds

setMaxAllowedArrivalPeriodLengthInSeoonds

getMaxAllowedResources

setMaxAllowedResources

getMaxAllowedResourceInstances

setMaxAllowedResourceInstances

getMaxAllowedProcesses

setMaxAllowedProcesses

getActivityCount

getMaxSimulationCycleTimeInSeconds

setMaxSimulationCycleTimeInSeconds

getMaxAllowedResourceTaskQueueSize

setMaxAllowedResourceTaskQueueSize

getSimulationStartTime

getFirstProcessInstanceForStats

getLastProcessInstanceForStats