README.md 4.98 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
20
21
### 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 :

`npm install <path to the JalHyd folder>/jalhyd-<version>.tar.gz`

and then :
Grand Francois's avatar
Grand Francois committed
22
23
24
25
26
27
28
29
30

`npm install`


### To compile the typescript code

`npm run build`


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

33
`npm start`
Grand Francois's avatar
Grand Francois committed
34
35


36
### To flag suspicious language usage
Grand Francois's avatar
Grand Francois committed
37

38
`npm run lint`
39
40


41
# Procédure d'ajout d'une calculette
42

43
## JaLHyd
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
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


* 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();
					this._L = new ParamDefinition(ComputeNodeType.LechaptCalmon, 'L', ParamDomainValue.POS, rL);
					this._W = new ParamDefinition(ComputeNodeType.LechaptCalmon, 'W', ParamDomainValue.POS, rW);
					this._A = new ParamDefinition(ComputeNodeType.LechaptCalmon, 'A', ParamDomainValue.POS, rA);

					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


132
* Ajouter une valeur à l'enum _CalculatorType_ pour identifier le type de calculette (par ex _MaCalculette_).
133
134


135
* Compléter la méthode _NubFactory.createNub()_.
136
137


138
## ngHyd
139

140
* Créer les fichiers de configuration de la calculette
141
142
143
144
145
	- dans _src/app/calculators_ : créer un répertoire (par ex _ma-calculette_)

	- dans _src/app/calculators/ma-calculette_ :
	
		Créer _ma-calculette.config.json_ sur le modèle des autres.
146
		Les ids utilisés doivent correspondre au symbole fourni à classe _BaseParam_ (1er paramètre du constructeur)
147
148

		Ne pas oublier de spécifier :
149
150
151
		- éventuellement le type de noeud par défaut de la calculette 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 de la calculette.

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

	- dans _src/app/calculators/ma-calculette_ :
	
		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.

157
158
159
* créer la classe du formulaire dans _src/app/formulaire/definition/concrete_

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

161
162
163
164
165
166
167
		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
168

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

171
172
173
174
* _src/locale/error_messages.&lt;langue&gt;.json_ :
	Ajouter un champ pour le titre de la calculette. Par exemple :
		 _"INFO_MACALC_TITRE": "Ma calculette"_

175
* Dans la méthode _FormulaireService.getConfigPathPrefix()_, compléter le _switch_ pour fournir le préfixe des fichiers de configuration/internationalisation.