Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Being able to switch between the OSRD interface and the NGE interface #7537

Closed
15 tasks done
Tracked by #7534 ...
louisgreiner opened this issue May 28, 2024 · 0 comments · Fixed by #8006
Closed
15 tasks done
Tracked by #7534 ...

Being able to switch between the OSRD interface and the NGE interface #7537

louisgreiner opened this issue May 28, 2024 · 0 comments · Fixed by #8006
Assignees
Labels
area:front Work on Standard OSRD Interface modules kind:feature-task Work related to a feature epic module:operational-studies Multi-train simulation with structured studies management

Comments

@louisgreiner
Copy link
Contributor

louisgreiner commented May 28, 2024

2nd step of meta #7535

Acceptance criteria

  • osrd-nge runs in operational studies panel
  • Microscopic / Macroscopic switch works
  • NGE is displayed in operational studies panel when Macroscopic switch is ticked
  • Microscopic switch switches back to simulation view

Implementation plan

  • Integrate the osrd-nge iframe in operationnal studies panel and add the Microscopic / Macroscopic switch
  • OSRD (front) implements (taking inspiration of the previous work:
    • enable load of data from OSRD to NGE (template to be found in description) (OSRD->NGE)
    • event listeners for NGE actions (with empty payloads, to be filled with converter) (OSRD<-NGE)

Description

Use resulting POC from #7536.

OSRD-NGE Concept diagram

osrd-nge iframe display

It should look like a new "tab" in OSRD (not a browser tab) that enable to switch view from either simulation view of a scenario or the iframe that embed osrd-nge. The selected tab is slightly highlighted.

The iframe points to the running osrd-nge project.

The Microscopic / Macroscopic switch should look like this, switching views from simulation to NGE:
image
image

Docs:

-> See below example

---
title: OSRD - NGE Sequence diagram
---
sequenceDiagram
  autonumber
  OSRD (osrd_window)-->>OSRD (osrd_window): init web page
  OSRD (osrd_window)->>NGE (nge_iframe): set `netzgrafikDto` DOM property
  loop while synchronization is ON
    alt any modification in OSRD (osrd_window)
      OSRD (osrd_window)-->>OSRD (osrd_window): any modification
      OSRD (osrd_window)->>NGE (nge_iframe): set `netzgrafikDto` DOM property
    else any modification in NGE (nge_iframe)
      NGE (nge_iframe)-->>NGE (nge_iframe): any modification <br>(hooks)
      NGE (nge_iframe)->>OSRD (osrd_window): send `operationX` event (@Output)
      OSRD (osrd_window)-->>OSRD (osrd_window): convert NGE operation into <br/>timetable update
      OSRD (osrd_window)->>NGE (nge_iframe): set `netzgrafikDto` DOM property
    end
  end
Loading

Definition of ready

  • UX

    • A wireframe is ready
    • A mock-up is ready
  • PO

    • Acceptance criteria are clear and understandable
  • Technical

    • If required documentation is available on osrd.fr
    • Implementation plan is detailed and validated by maintainers
  • General

    • WSJF values are filled
    • Validated by the PM
@louisgreiner louisgreiner self-assigned this May 28, 2024
@maelysLeratRosso maelysLeratRosso added area:front Work on Standard OSRD Interface modules kind:feature-task Work related to a feature epic module:operational-studies Multi-train simulation with structured studies management labels May 30, 2024
@maelysLeratRosso maelysLeratRosso changed the title Communication between osrd-front and osrd-nge iframe Being able to switch between the OSRD interface and the NGE interface Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:front Work on Standard OSRD Interface modules kind:feature-task Work related to a feature epic module:operational-studies Multi-train simulation with structured studies management
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants