'''
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/>.
'''
from pm4py.simulation.tree_generator.variants import basic, ptandloggenerator
from enum import Enum
from pm4py.util import exec_utils
import deprecation
from pm4py.meta import VERSION
import warnings
[docs]class Variants(Enum):
BASIC = basic
PTANDLOGGENERATOR = ptandloggenerator
BASIC = Variants.BASIC
PTANDLOGGENERATOR = Variants.PTANDLOGGENERATOR
DEFAULT_VARIANT = Variants.PTANDLOGGENERATOR
VERSIONS = {Variants.BASIC, Variants.PTANDLOGGENERATOR}
[docs]@deprecation.deprecated(deprecated_in="2.2.5", removed_in="3.0",
current_version=VERSION,
details="Use the pm4py.algo.simulation.tree_generator package")
def apply(variant=DEFAULT_VARIANT, parameters=None):
"""
Generate a process tree
Parameters
------------
variant
Variant of the algorithm. Admitted values:
- Variants.BASIC
- Variants.PTANDLOGGENERATOR
parameters
Specific parameters of the algorithm
Returns
------------
tree
Process tree
"""
warnings.warn("Use the pm4py.algo.simulation.tree_generator package")
return exec_utils.get_variant(variant).apply(parameters=parameters)