Flask package

Main documentation

The main documentation regarding the api calls is documented with swagger-UI. To access swagger-UI start Flask and open http://localhost:5000/api/docs

The following modules are used to document the python code

Main modules

• FlaskMain
• FlaskApp
  • FlaskAppWrapper
    • FlaskAppWrapper.addCors()
    • FlaskAppWrapper.addSwaggerUI()
    • FlaskAppWrapper.add_endpoint_get()
    • FlaskAppWrapper.add_endpoint_post()
    • FlaskAppWrapper.run()
  • action()
• APIAction
  • APIAction
    • APIAction.__call__()
    • APIAction.addCors()
    • APIAction.response200OK()
    • APIAction.response400BadRequest()
    • APIAction.response500InternalServerError()

Actions module

path	Action
/nextEvent	EventAction
/getIds	GetIdsAction
/component	ComponentAction
/component/id	ComponentIdAction
/start	StartAction
/startUntilTime	StartUntilTimeAction
/process	ProcessAction
/production	ProductionAction
/load_files	FileLoadAction
/simulation/download/owl	OwlDownloadAction
/runSimulation	RunSimulationAction
/test	TestAction
/kpi	KPIAction
/kpiList	KPIListAction
/reset_be	ResetBEAction
/database/connect	ConnectDataBaseAction
/database/simulationrun	GetSimulationRunAction

CheckProduction

• ProductionAction
  • ProductionAction
    • ProductionAction.__call__()

CheckProductType

• ProcessAction
  • ProcessAction
    • ProcessAction.__call__()
    • ProcessAction.checkInputProcessList()

Simulation

• EventAction
  • EventAction
    • EventAction.__call__()
• KPIAction
  • KPIAction
    • KPIAction.__call__()
• KPIListAction
  • KPIListAction
    • KPIListAction.__call__()
• OwlDownloadAction
  • OwlDownloadAction
    • OwlDownloadAction.__call__()
• RunSimulationAction
  • RunSimulationAction
    • RunSimulationAction.__call__()
• SimulationLoadAction
  • FileLoadAction
    • FileLoadAction.__call__()
  • SimulationLoadAction
• StartAction
  • StartAction
    • StartAction.__call__()
    • StartAction.loadSimulationFromFiles()
• StartUntilTimeAction
  • StartUntilTimeAction
    • StartUntilTimeAction.__call__()

DataBase

• ConnectDataBaseAction
  • ConnectDataBaseAction
    • ConnectDataBaseAction.__call__()
• GetSimulationRunAction
  • GetSimulationRunAction
    • GetSimulationRunAction.__call__()

Other

• APIAction
  • APIAction
    • APIAction.__call__()
    • APIAction.addCors()
    • APIAction.response200OK()
    • APIAction.response400BadRequest()
    • APIAction.response500InternalServerError()
• ComponentIdAction
  • ComponentIdAction
    • ComponentIdAction.__call__()
• ComponentAction
  • ComponentAction
    • ComponentAction.__call__()
• GetIdsAction
  • GetIdsAction
    • GetIdsAction.__call__()
• TestAction
  • TestAction
    • TestAction.__call__()
• ResetBEAction
  • ResetBEAction

Util module

• ProductionDict
  • ProductionDict
    • ProductionDict.getProductionDict()
• StateStorage
  • StateStorage
    • StateStorage.changeState()

Assets module

DefaultFiles

Here is a default configuration that can be displayed in the frontend and is used to facilitate the operation of the backend. Important only one simulation may be stored there.

DefaultSaveFolder

For some api calls the owl must be saved, this happens in this folder. This is e.g. the case when outputting the ontlogysim as string

static module

Here is the swaggerUI Documentation located