pm4py.objects.log.exporter.xes package

Subpackages

• pm4py.objects.log.exporter.xes.util package
  • Submodules
  • pm4py.objects.log.exporter.xes.util.compression module
  • Module contents
• pm4py.objects.log.exporter.xes.variants package
  • Submodules
  • pm4py.objects.log.exporter.xes.variants.etree_xes_exp module
  • pm4py.objects.log.exporter.xes.variants.line_by_line module
  • Module contents

Submodules

pm4py.objects.log.exporter.xes.exporter 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.log.exporter.xes.exporter.Variants

Bases: enum.Enum

An enumeration.

ETREE = <module 'pm4py.objects.log.exporter.xes.variants.etree_xes_exp' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/latest/pm4py/objects/log/exporter/xes/variants/etree_xes_exp.py'>

LINE_BY_LINE = <module 'pm4py.objects.log.exporter.xes.variants.line_by_line' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/latest/pm4py/objects/log/exporter/xes/variants/line_by_line.py'>

pm4py.objects.log.exporter.xes.exporter.apply(log, output_file_path, variant=<Variants.LINE_BY_LINE: <module 'pm4py.objects.log.exporter.xes.variants.line_by_line' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/latest/pm4py/objects/log/exporter/xes/variants/line_by_line.py'>>, parameters=None)

Method to export a XES from a log

Parameters:

• log – Trace log

• output_file_path – Output file path

• variant – Selected variant of the algorithm

• parameters –

  Parameters of the algorithm:

  Parameters.COMPRESS -> Indicates that the XES file must be compressed

pm4py.objects.log.exporter.xes.exporter.serialize(log, variant=<Variants.LINE_BY_LINE: <module 'pm4py.objects.log.exporter.xes.variants.line_by_line' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/latest/pm4py/objects/log/exporter/xes/variants/line_by_line.py'>>, parameters=None)

Serialize a log into a binary string containing the XES of the log

Parameters:

• log – Trace log
• variant – Selected variant of the algorithm
• parameters – Parameters of the algorithm

Returns:

String describing the XES

Return type:

string

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/>.