Skip to content

Commit 841423d

Browse files
committed
design-doc: add manchette documentation
1 parent f2072d7 commit 841423d

1 file changed

Lines changed: 83 additions & 0 deletions

File tree

  • content/docs/reference/design-docs/manchette
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: "Manchette"
3+
linkTitle: "Manchette"
4+
weight: 60
5+
description: "Description du design de la manchette"
6+
---
7+
8+
9+
## Prérequis
10+
11+
- Pouvoir créer une manchette à partir d'une liste de PR
12+
- Pouvoir créer une manchette à partir d'un train
13+
- Pouvoir utiliser une manchette sur des infrastructures différentes
14+
- Pouvoir configurer l'affichage de la manchette et que ce soit sauvegarder entre les utilisateurs
15+
16+
### Questions?
17+
18+
- Quelle manchette prendre au début ?
19+
- Proposition: Un train, cela implique d'avoir des manchettes éphémères.
20+
- Une manchette créer via un train: Qui porte l'information du chemin ?
21+
- Proposition: on copie les informations du train pour créer l'objet.
22+
23+
24+
## Workflow
25+
26+
```mermaid
27+
flowchart TD
28+
%%%% NODES
29+
30+
manchette[Configuration de la manchette]
31+
style manchette fill:#b697e6
32+
%% ↓
33+
path[Chemin]
34+
style path fill:#bada55,stroke:#a7c44c
35+
%% ↓
36+
path_properties[Propriété du chemin]
37+
style path_properties fill:#bada55,stroke:#a7c44c
38+
%% ↓
39+
train_projection[Projection des trains]
40+
style train_projection fill:#bada55,stroke:#a7c44c
41+
%% ↓
42+
manchette_component[Composant Manchette]
43+
%% ↓
44+
space_time_chart[GET]
45+
46+
%%%% EDGES
47+
48+
manchette -- Calcul --> path
49+
path -- Calcul des propriétés --> path_properties
50+
path -- Calcul --> train_projection
51+
path_properties -- Déclivités + PR --> manchette_component
52+
manchette -- Extraction des préférences de visualisation --> manchette_component
53+
train_projection -- Données --> space_time_chart
54+
manchette_component -- Configuration --> space_time_chart
55+
```
56+
57+
## Schéma
58+
59+
```yaml
60+
name: Ma manchette
61+
path:
62+
- { uic: 87210 } # Any operational point matching the given uic
63+
- { track: foo, offset: 1000 } # 10m on track foo
64+
- { trigram: ABC } # Any operational point matching the trigram ABC
65+
- { operational_point: 35f57ee0-4e67-4cf7-9946-0c6be757ef85 } # A specified operational point
66+
operational_point_settings:
67+
35f57ee0-4e67-4cf7-9946-0c6be757ef85: # ID of an operational point
68+
bold: true
69+
hidden: false
70+
zones:
71+
- start: 35f57ee0-4e67-4cf7-9946-0c6be757ef85
72+
end: 30e97a0a-ce2a-4727-8eba-038fba1a6671
73+
stretching:
74+
- start: 35f57ee0-4e67-4cf7-9946-0c6be757ef85
75+
end: 30e97a0a-ce2a-4727-8eba-038fba1a6671
76+
factor: 1.5
77+
```
78+
79+
## Endpoints
80+
81+
```
82+
// TODO
83+
```

0 commit comments

Comments
 (0)