pm4py.objects.ocel.importer.xmlocel package

Subpackages

• pm4py.objects.ocel.importer.xmlocel.variants package
  • Submodules
  • pm4py.objects.ocel.importer.xmlocel.variants.classic module
  • Module contents

Submodules

pm4py.objects.ocel.importer.xmlocel.importer module

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

class pm4py.objects.ocel.importer.xmlocel.importer.Variants

Bases: enum.Enum

An enumeration.

CLASSIC = <module 'pm4py.objects.ocel.importer.xmlocel.variants.classic' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/objects/ocel/importer/xmlocel/variants/classic.py'>

pm4py.objects.ocel.importer.xmlocel.importer.apply(file_path: str, variant=<Variants.CLASSIC: <module 'pm4py.objects.ocel.importer.xmlocel.variants.classic' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/objects/ocel/importer/xmlocel/variants/classic.py'>>, parameters: Optional[Dict[Any, Any]] = None) → pm4py.objects.ocel.obj.OCEL

Imports an object-centric event log from a XML-OCEL file

Parameters:

• file_path – Path to the XML-OCEL file
• variant – Variant of the algorithm to use, possible values: - Variants.CLASSIC
• parameters – Variant-specific parameters

Returns:

Object-centric event log

Return type:

ocel

Module contents

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.