README.md 5.73 KB
Newer Older
Grand Francois's avatar
Grand Francois committed
1
2
3
4
# ngHyd : Angular Component Library For Hydraulics using JaLHyd library

## All the things to know for developping the library

5
6
7
The library needs nodeJS installed and the following node packages installed globally: _typescript, karma, tslint_.

This can be done from the command line:
Grand Francois's avatar
Grand Francois committed
8
9
10

`npm install -g typescript karma tslint`

11
12
13
14
15
16
17
18
19
The documentation of Cassiopee needs to install MkDocs and some extensions:

```sh
sudo apt install python3-pip
python3 -m pip install mkdocs
python3 -m pip install python-markdown-math
python3 -m pip install mkdocs-material
```

20
21
22
23
24
25
26
27
### Install the necessary packages of the library:

Clone or update the JalHyd project and in the JalHyd folder, run :

`npm package`

Then, back to the ngHyd project folder, run :

28
`npm run jalhyd`
29
30

and then :
Grand Francois's avatar
Grand Francois committed
31
32
33
34
35
36
37
38
39

`npm install`


### To compile the typescript code

`npm run build`


40
### To run compilation in watch mode as well as application execution in a navigator window
Grand Francois's avatar
Grand Francois committed
41

42
`npm start`
Grand Francois's avatar
Grand Francois committed
43
44


45
### To flag suspicious language usage
Grand Francois's avatar
Grand Francois committed
46

47
`npm run lint`
48

49
50
51
52
53
54
# Caveats

## Deployment

Custom Material SVG Icons will only show up when the application is deployed on the domain root (no subfolders), see [this feature request](https://github.com/angular/material2/issues/4263)

55

56
# Procédure d'ajout d'un module de calcul
57

58
## JaLHyd
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78


* Créer la classe de paramétrage

	* exemple :

			export class TotoParams extends ParamsEquation {
				[key: string]: any; // pour pouvoir faire this['methode]();

				/** Longueur L */
				private _L: ParamDefinition;

				/** Largeur W */
				private _W: ParamDefinition;

				/** Tugudu A */
				private _A: ParamDefinition;

				constructor(rL: number, rW: number, rA:number=undefined) {
					super();
79
80
81
					this._L = new ParamDefinition(this, ComputeNodeType.LechaptCalmon, 'L', ParamDomainValue.POS, rL);
					this._W = new ParamDefinition(this, ComputeNodeType.LechaptCalmon, 'W', ParamDomainValue.POS, rW);
					this._A = new ParamDefinition(this, ComputeNodeType.LechaptCalmon, 'A', ParamDomainValue.POS, rA);
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

					this.addParamDefinition(this._L);
					this.addParamDefinition(this._W);
					this.addParamDefinition(this._A);
				}

				get L() {
					return this._L;
				}

				get W() {
					return this._W;
				}

				get A() {
					return this._A;
				}
			}


* Créer la classe de calcul

	* exemple :

			export class Toto extends Nub {
				constructor(prms: TotoParams, dbg: boolean = false) {
					super(prms, dbg);
				}

				/**
				* paramètres castés au bon type
				*/
				get prms(): TotoParams {
					return <TotoParams>this._prms;
				}

				/**
				* paramétrage de la calculabilité des paramètres
				*/
				protected setParametersCalculability() {
					this.prms.L.calculability = ParamCalculability.DICHO;
					this.prms.W.calculability = ParamCalculability.DICHO;
					this.prms.A.calculability = ParamCalculability.EQUATION;
				}

				Equation(sVarCalc: string): Result {
					let v: number;

					switch (sVarCalc) {
						case "A":
							v = this.prms.L.v / this.prms.W.v;
							break;

						default:
							throw "Toto.Equation() : invalid variable name " + sVarCalc;
					}

					return new Result(v);
				}
			}


* Créer les tests unitaires correspondants


147
* Ajouter une valeur à l'enum _CalculatorType_ pour identifier le type de module de calcul (par ex _MaCalculette_).
148
149


150
* Compléter la méthode _Session.createNub()_.
151
152


153
## ngHyd
154

Mathias Chouet's avatar
Mathias Chouet committed
155
1. Créer les fichiers de configuration du module de calcul
156
157
158
	- dans _src/app/calculators_ : créer un répertoire (par ex _ma-calculette_)

	- dans _src/app/calculators/ma-calculette_ :
159

160
		Créer _ma-calculette.config.json_ sur le modèle des autres.
161
		Les ids utilisés doivent correspondre au symbole fourni à classe _ParamDefinition_ (1er paramètre du constructeur)
162
163

		Ne pas oublier de spécifier :
164
		- éventuellement le type de noeud par défaut du module de calcul dans les options avec le champ "_defaultNodeType_". Si ce champ est absent, sa valeur est "_ComputeNodeType.None_". Ce champ sert par ex pour les sections paramétrées à déterminer le type de section à afficher lors de la création du module de calcul.
165
166

		- éventuellement le type de noeud de paramètres particuliers (objets comportant _"type":"input"_) avec le champ _"nodeType": "MaCalculetteBleue"_ (par défaut, "_ComputeNodeType.None_")
167
168

	- dans _src/app/calculators/ma-calculette_ :
169

170
171
		Créer les fichiers d'internationalisation (_ma-calculette.&lt;langue&gt;.json_). Il doivent reprendre tous les ids utilisés dans le fichier de configuration et fournir leur traduction.

Mathias Chouet's avatar
Mathias Chouet committed
172
2. **Si nécessaire** créer la classe du formulaire dans _src/app/formulaire/definition/concrete_ . Une classe de base gérant la majorité des cas est déjà disponible, en général cette étape n'est pas nécessaire 
173
174

	- Par ex : _FormulaireMaCalculette_ dans _src/app/formulaire/definition/concrete/form-ma-calculette.ts_
175

176
177
178
179
180
181
182
		Ces classes concrètes sont construites par composition des classes dans _src/app/formulaire/definition_ :
		- _form-def-*_ : définition/description du formulaire.
			- _FormDefSection_ : avec paramètre à varier
			- _FormDefParamToCalculate_ : avec paramètre à calculer
			- etc...
		- _form-compute-*_ : aspects calculatoires
		- _form-result-*_ : affichage des résultats
183

184
185
		On peut soit composer la classe concrète directement avec ces classes, soient dériver ces dernières et composer avec.

Mathias Chouet's avatar
Mathias Chouet committed
186
3. _src/locale/messages.&lt;langue&gt;.json_ :
187
	Ajouter un champ pour le titre du module de calcul. Par exemple :
188
189
		 _"INFO_MACALC_TITRE": "Ma calculette"_

Mathias Chouet's avatar
Mathias Chouet committed
190
4. Dans le constructeur de _FormulaireService_, ajouter une entrée dans `this.calculatorPaths` pour fournir le préfixe des fichiers de configuration/internationalisation.
Mathias Chouet's avatar
Mathias Chouet committed
191

Mathias Chouet's avatar
Mathias Chouet committed
192
5. **Si une nouvelle classe a été créée à l'étape 2**, dans la méthode _FormulaireService.newFormulaire()_, compléter le _switch_ pour fournir la classe à instancier.