pm4py.objects.bpmn package

PM4Py – A Process Mining Library for Python

Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see this software project’s root or visit <https://www.gnu.org/licenses/>.

Website: https://processintelligence.solutions Contact: info@processintelligence.solutions

Subpackages

• pm4py.objects.bpmn.exporter package
  • Subpackages
    • pm4py.objects.bpmn.exporter.variants package
      • Submodules
      • pm4py.objects.bpmn.exporter.variants.etree module
  • Submodules
  • pm4py.objects.bpmn.exporter.exporter module
    • Variants
      • Variants.ETREE
    • apply()
    • serialize()
• pm4py.objects.bpmn.importer package
  • Subpackages
    • pm4py.objects.bpmn.importer.variants package
      • Submodules
      • pm4py.objects.bpmn.importer.variants.lxml module
  • Submodules
  • pm4py.objects.bpmn.importer.importer module
    • Variants
      • Variants.LXML
    • apply()
    • deserialize()
• pm4py.objects.bpmn.layout package
  • Subpackages
    • pm4py.objects.bpmn.layout.variants package
      • Submodules
      • pm4py.objects.bpmn.layout.variants.graphviz module
      • pm4py.objects.bpmn.layout.variants.graphviz_new module
  • Submodules
  • pm4py.objects.bpmn.layout.layouter module
    • Variants
      • Variants.GRAPHVIZ
      • Variants.GRAPHVIZ_NEW
    • apply()
• pm4py.objects.bpmn.util package
  • Submodules
  • pm4py.objects.bpmn.util.bpmn_utils module
    • get_node_by_id()
    • get_global_start_events()
    • get_initial_marking()
    • get_boundary_events_of_activity()
    • get_external_boundary_events_of_activity()
    • get_all_nodes_inside_process()
    • get_all_direct_child_subprocesses()
    • get_all_child_subprocesses()
    • get_processes_deep()
    • get_subprocesses_sorted_by_depth()
    • get_termination_events_of_subprocess()
    • get_termination_events_of_subprocess_for_pnet()
    • get_start_events_of_subprocess()
    • get_end_events_of_subprocess()
    • bpmn_graph_end_events_as_throw_events()
  • pm4py.objects.bpmn.util.reduction module
    • reduce_xor_gateways()
    • apply()
  • pm4py.objects.bpmn.util.sorting module
    • bfs_bpmn()
    • get_sorted_nodes_edges()

Submodules

pm4py.objects.bpmn.obj module

PM4Py – A Process Mining Library for Python

Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see this software project’s root or visit <https://www.gnu.org/licenses/>.

Website: https://processintelligence.solutions Contact: info@processintelligence.solutions

class pm4py.objects.bpmn.obj.Marking(iterable=None, /, **kwds)

Bases: Counter

class pm4py.objects.bpmn.obj.BPMNNodeLayout

Bases: object

set_x(x)

set_y(y)

get_x()

get_y()

get_width()

set_width(width)

get_height()

set_height(height)

class pm4py.objects.bpmn.obj.BPMNEdgeLayout

Bases: object

add_waypoint(waypoint)

del_waypoints()

get_waypoints()

class pm4py.objects.bpmn.obj.BPMNLayout

Bases: object

get(n)

class pm4py.objects.bpmn.obj.BPMN(process_id=None, name='', nodes=None, flows=None)

Bases: object

class BPMNNode(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: object

get_id()

get_name()

get_in_arcs()

get_out_arcs()

add_in_arc(in_arc)

add_out_arc(out_arc)

remove_in_arc(in_arc)

remove_out_arc(out_arc)

get_process()

set_process(process)

set_x(x)

set_y(y)

get_x()

get_y()

get_width()

set_width(width)

get_height()

set_height(height)

get_layout()

set_layout(layout)

property name

property id

property in_arcs

property out_arcs

property process

class Collaboration(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: BPMNNode

class Participant(id='', name='', in_arcs=None, out_arcs=None, process=None, process_ref=None)

Bases: BPMNNode

class TextAnnotation(id='', name='', in_arcs=None, out_arcs=None, process=None, text=None)

Bases: BPMNNode

class Event(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: BPMNNode

class StartEvent(id='', isInterrupting=False, name='', parallelMultiple=False, in_arcs=None, out_arcs=None, process=None)

Bases: Event

get_isInterrupting()

get_parallelMultiple()

class NormalStartEvent(id='', isInterrupting=False, name='', parallelMultiple=False, in_arcs=None, out_arcs=None, process=None)

Bases: StartEvent

class MessageStartEvent(id='', isInterrupting=False, name='', parallelMultiple=False, in_arcs=None, out_arcs=None, process=None)

Bases: StartEvent

class IntermediateCatchEvent(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: Event

class MessageIntermediateCatchEvent(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: IntermediateCatchEvent

class ErrorIntermediateCatchEvent(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: IntermediateCatchEvent

class CancelIntermediateCatchEvent(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: IntermediateCatchEvent

class BoundaryEvent(id='', name='', in_arcs=None, out_arcs=None, process=None, activity=None)

Bases: Event

get_activity()

class MessageBoundaryEvent(id='', name='', in_arcs=None, out_arcs=None, process=None, activity=None)

Bases: BoundaryEvent

class ErrorBoundaryEvent(id='', name='', in_arcs=None, out_arcs=None, process=None, activity=None)

Bases: BoundaryEvent

class CancelBoundaryEvent(id='', name='', in_arcs=None, out_arcs=None, process=None, activity=None)

Bases: BoundaryEvent

class IntermediateThrowEvent(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: Event

class MessageIntermediateThrowEvent(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: IntermediateThrowEvent

class NormalIntermediateThrowEvent(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: IntermediateThrowEvent

class EndEvent(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: Event

class NormalEndEvent(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: EndEvent

class MessageEndEvent(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: EndEvent

class TerminateEndEvent(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: EndEvent

class ErrorEndEvent(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: EndEvent

class CancelEndEvent(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: EndEvent

class Activity(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: BPMNNode

class Task(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: Activity

class UserTask(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: Task

class SendTask(id='', name='', in_arcs=None, out_arcs=None, process=None)

Bases: Task

class SubProcess(id='', name='', in_arcs=None, out_arcs=None, process=None, depth=None)

Bases: Activity

get_depth()

class Gateway(id='', name='', gateway_direction=Direction.UNSPECIFIED, in_arcs=None, out_arcs=None, process=None)

Bases: BPMNNode

class Direction(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

UNSPECIFIED = 'Unspecified'

DIVERGING = 'Diverging'

CONVERGING = 'Converging'

get_gateway_direction()

set_gateway_direction(direction)

class ParallelGateway(id='', name='', gateway_direction=None, in_arcs=None, out_arcs=None, process=None)

Bases: Gateway

class ExclusiveGateway(id='', name='', gateway_direction=None, in_arcs=None, out_arcs=None, process=None)

Bases: Gateway

class InclusiveGateway(id='', name='', gateway_direction=None, in_arcs=None, out_arcs=None, process=None)

Bases: Gateway

class EventBasedGateway(id='', name='', gateway_direction=None, in_arcs=None, out_arcs=None, process=None)

Bases: Gateway

class Flow(source, target, id='', name='', process=None)

Bases: object

get_id()

get_name()

get_source()

get_target()

get_process()

set_process(process)

add_waypoint(waypoint)

del_waypoints()

get_waypoints()

get_layout()

set_layout(layout)

property source

property target

class SequenceFlow(source, target, id='', name='', process=None)

Bases: Flow

class MessageFlow(source, target, id='', name='', process=None)

Bases: Flow

class Association(source, target, id='', name='', process=None)

Bases: Flow

get_process_id()

set_process_id(process_id)

get_nodes()

get_flows()

get_graph()

get_name()

set_name(name: str)

add_node(node)

remove_node(node)

remove_flow(flow)

add_flow(flow)

get_layout()

set_layout(layout)

pm4py.objects.bpmn.semantics module

PM4Py – A Process Mining Library for Python

Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see this software project’s root or visit <https://www.gnu.org/licenses/>.

Website: https://processintelligence.solutions Contact: info@processintelligence.solutions

pm4py.objects.bpmn.semantics.is_enabled(node, bpmn, m)

pm4py.objects.bpmn.semantics.execute(node, bpmn, m)

pm4py.objects.bpmn.semantics.try_to_execute(node, bpmn, m)

pm4py.objects.bpmn.semantics.add_vector(a, b)

pm4py.objects.bpmn.semantics.sub_vector(a, b)

pm4py.objects.bpmn.semantics.power_set(iterable, min=1)

pm4py.objects.bpmn.semantics.weak_execute(node, m, bpmn_graph)

Execute a transition even if it is not fully enabled Returns multiple possible markings if the node is a gate

pm4py.objects.bpmn.semantics.execute_token_flow(target, marking, bpmn_graph)

pm4py.objects.bpmn.semantics.enabled_nodes(bpmn, m)

Returns a set of enabled transitions in a Petri net and given marking

Parameters

param pn:

Petri net

param m:

marking of the pn

Returns

return:

set of enabled transitions