The base Module class#

class mkShapesRDF.processor.framework.module.Module(name)[source][source]#

Bases: object

Basic module class. All modules should inherit from this class.

Methods

run(df, values)

No module should overwrite this method.

runModule(df, values)

The main method of the module.

__init__(name)[source][source]#

Use this constructor to set the name of the module. It should store all the needed information for runModule method.

Parameters:
namestr

Name of the module

runModule(df, values)[source][source]#

The main method of the module. It should contain all the logic of the module.

Parameters:
dfmRDF

The mRDF dataframe

valueslist

List of values that are passed between modules (should contain efficiency of cuts and other values)

Returns:
mRDF

The modified mRDF dataframe

run(df, values)[source][source]#

No module should overwrite this method. It is used to store the efficiency of the module.

Parameters:
dfmRDF

The mRDF dataframe

valueslist

List of values that are passed between modules (should contain efficiency of cuts and other values)

Returns:
mRDF

The modified mRDF dataframe