epyt_flow.rest_api

• epyt_flow.rest_api.scada_data
  • epyt_flow.rest_api.scada_data.handlers
    • ScadaDataBaseHandler
    • ScadaDataConvertUnitsHandler
      • ScadaDataConvertUnitsHandler.on_post()
    • ScadaDataManager
    • ScadaDataRemoveHandler
      • ScadaDataRemoveHandler.on_delete()
    • ScadaDataSensorConfigHandler
      • ScadaDataSensorConfigHandler.on_get()
      • ScadaDataSensorConfigHandler.on_post()
    • ScadaDataSensorFaultsHandler
      • ScadaDataSensorFaultsHandler.on_get()
      • ScadaDataSensorFaultsHandler.on_post()
  • epyt_flow.rest_api.scada_data.data_handlers
    • ScadaDataDemandsHandler
      • ScadaDataDemandsHandler.on_get()
    • ScadaDataFlowsHandler
      • ScadaDataFlowsHandler.on_get()
    • ScadaDataLinkBulkSpeciesHandler
      • ScadaDataLinkBulkSpeciesHandler.on_get()
    • ScadaDataLinksQualityHandler
      • ScadaDataLinksQualityHandler.on_get()
    • ScadaDataNodeBulkSpeciesHandler
      • ScadaDataNodeBulkSpeciesHandler.on_get()
    • ScadaDataNodesQualityHandler
      • ScadaDataNodesQualityHandler.on_get()
    • ScadaDataPressuresHandler
      • ScadaDataPressuresHandler.on_get()
    • ScadaDataPumpStatesHandler
      • ScadaDataPumpStatesHandler.on_get()
    • ScadaDataSurfaceSpeciesHandler
      • ScadaDataSurfaceSpeciesHandler.on_get()
    • ScadaDataTankVolumesHandler
      • ScadaDataTankVolumesHandler.on_get()
    • ScadaDataValveStatesHandler
      • ScadaDataValveStatesHandler.on_get()
  • epyt_flow.rest_api.scada_data.export_handlers
    • ScadaDataBaseExportHandler
      • ScadaDataBaseExportHandler.create_temp_file_path()
      • ScadaDataBaseExportHandler.export()
      • ScadaDataBaseExportHandler.on_get()
      • ScadaDataBaseExportHandler.send_temp_file()
    • ScadaDataExportHandler
      • ScadaDataExportHandler.export()
    • ScadaDataMatlabExportHandler
      • ScadaDataMatlabExportHandler.export()
    • ScadaDataNumpyExportHandler
      • ScadaDataNumpyExportHandler.export()
    • ScadaDataXlsxExportHandler
      • ScadaDataXlsxExportHandler.export()
• epyt_flow.rest_api.scenario
  • epyt_flow.rest_api.scenario.handlers
    • ScenarioBaseHandler
    • ScenarioConfigHandler
      • ScenarioConfigHandler.on_get()
    • ScenarioExportHandler
      • ScenarioExportHandler.on_get()
    • ScenarioGeneralParamsHandler
      • ScenarioGeneralParamsHandler.on_get()
      • ScenarioGeneralParamsHandler.on_post()
    • ScenarioManager
      • ScenarioManager.close_item()
      • ScenarioManager.create()
    • ScenarioNewHandler
      • ScenarioNewHandler.on_post()
    • ScenarioNodeDemandPatternHandler
      • ScenarioNodeDemandPatternHandler.on_post()
    • ScenarioQualityParamsHandler
      • ScenarioQualityParamsHandler.on_post()
    • ScenarioRemoveHandler
      • ScenarioRemoveHandler.on_delete()
    • ScenarioSensorConfigHandler
      • ScenarioSensorConfigHandler.on_get()
      • ScenarioSensorConfigHandler.on_post()
    • ScenarioTopologyHandler
      • ScenarioTopologyHandler.on_get()
  • epyt_flow.rest_api.scenario.simulation_handlers
    • ScenarioAdvancedQualitySimulationHandler
      • ScenarioAdvancedQualitySimulationHandler.on_post()
    • ScenarioBasicQualitySimulationHandler
      • ScenarioBasicQualitySimulationHandler.on_post()
    • ScenarioSimulationHandler
      • ScenarioSimulationHandler.on_get()
      • ScenarioSimulationHandler.on_post()
  • epyt_flow.rest_api.scenario.control_handlers
    • ScenarioComplexControlHandler
      • ScenarioComplexControlHandler.on_get()
      • ScenarioComplexControlHandler.on_post()
    • ScenarioSimpleControlHandler
      • ScenarioSimpleControlHandler.on_get()
      • ScenarioSimpleControlHandler.on_post()
  • epyt_flow.rest_api.scenario.event_handlers
    • ScenarioLeakageHandler
      • ScenarioLeakageHandler.on_get()
      • ScenarioLeakageHandler.on_post()
    • ScenarioQualityEventHandler
      • ScenarioQualityEventHandler.on_get()
      • ScenarioQualityEventHandler.on_post()
    • ScenarioSensorFaultHandler
      • ScenarioSensorFaultHandler.on_get()
      • ScenarioSensorFaultHandler.on_post()
    • ScenarioSensorReadingAttackHandler
      • ScenarioSensorReadingAttackHandler.on_get()
      • ScenarioSensorReadingAttackHandler.on_post()
  • epyt_flow.rest_api.scenario.uncertainty_handlers
    • ScenarioModelUncertaintyHandler
      • ScenarioModelUncertaintyHandler.on_get()
      • ScenarioModelUncertaintyHandler.on_post()
    • ScenarioSensorUncertaintyHandler
      • ScenarioSensorUncertaintyHandler.on_get()
      • ScenarioSensorUncertaintyHandler.on_post()

epyt_flow.rest_api.server

This module provides the EPyT-Flow REST API server.

class epyt_flow.rest_api.server.RestApiService(port: int = 8080)

Bases: object

Class implementing the REST API server.

Parameters:

port (int, optional) –

Port of the server.

The default is 8080

make_server() → WSGIServer

Returns a new web server.

property port: int

Gets the port of the web server.

Returns:

Port.

Return type:

int

run() → None

Runs the REST service.

epyt_flow.rest_api.res_manager

This module contains a class for managing recourses such as scenarios or SCADA data.

class epyt_flow.rest_api.res_manager.ResourceManager

Bases: object

Class implementing a simple resource manager where resources are associated with UUIDs.

close_item(item: Any)

Closes a given resource item – i.e. all clean-up logic for an item should be called here.

Parameters:

item (Any) – Resource item.

create_new_item(item: Any) → str

Adds a new item to the resource manager.

Parameters:

item (Any) – Item to be added.

Returns:

UUID of the new item.

Return type:

str

get(item_uuid: str) → Any

Gets the item associated with a given UUID.

Parameters:

item_uuid (str) – UUID of the item.

Returns:

Resource item.

Return type:

Any

remove(item_uuid: str) → None

Removes the scenario associated with a given UUID

Parameters:

item_uuid (str) – UUID of the item.

validate_uuid(item_uuid: str) → bool

Validates a given UUID – i.e. checks if there is a resource associated with the given UUID.

Parameters:

item_uuid (str) – UUID of the item.

Returns:

True if the given UUID is valid, False otherwise.

Return type:

bool

epyt_flow.rest_api.base_handler

This module provides a base handler with some useful methods for all REST API handlers.

class epyt_flow.rest_api.base_handler.BaseHandler

Bases: object

Base class for all REST API handlers.

load_json_data_from_request(req: falcon.Request) → Any

Loads/Parses an object from given JSON data.

Parameters:

req (falcon.Request) – Request instance.

Returns:

Loaded object.

Return type:

Any

send_error(resp: falcon.Response, error_msg: str) → None

Sends an error message back.

Parameters:

• resp (falcon.Response) – Response instance.

• error_msg (str) – Error message.

send_invalid_resource_id_error(resp: falcon.Response) → None

Sends an error that th given resource ID (e.g. scenario ID, or SCADA data ID) is invalid.

Parameters:

resp (falcon.Response) – Response instance.

send_json_parsing_error(resp: falcon.Response) → None

Sends an error that the JSON parsing failed.

Parameters:

resp – Response instance.

send_json_response(resp: falcon.Response, data: Any) → None

Sends a JSON response.

Parameters:

• resp – Response instance.

• data (Any) – Data to be sent.