CDPP / AMDA_Integration

Blame view

src/InputOutput/IHMImpl/Tools/IHMParamManagerClass.php 10.9 KB
Edit Raw Normal View History
22521f1c   Benjamin Renard   First commit 
1
2
3
4
5
6
7
8
9
10
11
 
<?php

/**
 * @class IHMParamManagerClass
 * @brief Parameter manager
 * @details
 */
class IHMParamManagerClass
{
	protected $userParameterLoader = null;
	protected $expressionParser = null;
bf27ba04   Benjamin Renard   Add templated par... 
12
 
	protected $templateParamsManager = null;
22521f1c   Benjamin Renard   First commit 
13
14
15
16
17
18
 
	
	/*
	 * @brief Constructor
	*/
	function __construct()
	{
bf27ba04   Benjamin Renard   Add templated par... 
19
 
		$this->templateParamsManager = new IHMParamTemplateClass();
22521f1c   Benjamin Renard   First commit 
20
21
22
23
24
 
	}

	/*
	 * @brief Add an existing parameter
	*/
bf27ba04   Benjamin Renard   Add templated par... 
25
 
	public function addExistingParam($param, $paramsData, $templateArgs = NULL)
22521f1c   Benjamin Renard   First commit 
26
27
28
29
30
31
 
	{
		if ($this->isDerivedParam($param))
			return $this->addDerivedParam($param,$paramsData);
		else if ($this->isUploadedParam($param))
			return $this->addUploadedParam($param,$paramsData);
		else
bf27ba04   Benjamin Renard   Add templated par... 
32
 
			return $this->addLocalParam($param,$paramsData, $templateArgs);
22521f1c   Benjamin Renard   First commit 
33
34
35
36
37
38
 
		return "";
	}

	/*
	 * @brief Add a process parameter
	*/
286f7924   Benjamin Renard   Derived parameter... 
39
 
	public function addProcessParam($paramId,$expression,$params,$sampling,$gap,$dateModif,$paramsData)
22521f1c   Benjamin Renard   First commit 
40
 
	{
286f7924   Benjamin Renard   Derived parameter... 
41
 
		$paramsData->addProcessParamToCreate($paramId, $expression, $params, $sampling, $gap,$dateModif);
22521f1c   Benjamin Renard   First commit 
42
e4545ed5   Benjamin Renard   Implement templat... 
43
44
45
46
47
48
 
		foreach ($params as $param) {
			$template_args = NULL;
			if (array_key_exists("template_args", $param))
				$template_args = $param["template_args"];
			$this->addExistingParam($param["paramid"],$paramsData,$template_args);
		}
22521f1c   Benjamin Renard   First commit 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 

		return true;
	}

	/*
	 * @brief Detect if it's a derived parameter
	*/
	private function isDerivedParam($param)
	{
		return preg_match("#^ws_#",$param);
	}

	/*
	 * @brief Detect if it's a uploaded parameter
	*/
	private function isUploadedParam($param)
	{
		return preg_match("#^wsd_#",$param);
	}

	/*
	 * @brief Add a local parameter
	*/
bf27ba04   Benjamin Renard   Add templated par... 
72
 
	private function addLocalParam($param, $paramsData, $templateArgs)
22521f1c   Benjamin Renard   First commit 
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
	{
		//local parameter
		$indexes     = array();
		$calib_infos = array();
		//check for components
		$pattern = "/(?P<param>.*)\((?P<components>.*)\)/";
		preg_match_all($pattern, $param, $matches);
		if ((count($matches["param"]) > 0) && (count($matches["components"]) > 0))
		{
			$paramId       = $matches["param"][0];
			$indexes = explode(",",$matches["components"][0]);
		}
		else
			$paramId = $param;
bf27ba04   Benjamin Renard   Add templated par... 
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
		
		//check templated parameter
		$real_param_id = $paramId;
		if ($this->templateParamsManager->isTemplatedParam($paramId)) {
			$paramPath = $this->templateParamsManager->generateTemplatedParamFile($paramId, $templateArgs);
			$real_param_id = $this->templateParamsManager->getTemplatedParamId($paramId, $templateArgs);
			if (empty($paramPath) || !file_exists($paramPath))
				throw new Exception('Cannot generate parameter template file '.$paramId);
		}
		else {
			$paramPath = IHMConfigClass::getLocalParamDBPath().$paramId.".xml";
			if (!file_exists($paramPath))
				throw new Exception('Cannot find parameter local file '.$paramId);
		}
22521f1c   Benjamin Renard   First commit 
101
bf27ba04   Benjamin Renard   Add templated par... 
102
 
		$paramsData->addParamToCopy($real_param_id,$paramPath);
22521f1c   Benjamin Renard   First commit 
103
bf27ba04   Benjamin Renard   Add templated par... 
104
 
		$this->addLinkedLocalParams($paramId, $paramsData, $templateArgs);
22521f1c   Benjamin Renard   First commit 
105
bf27ba04   Benjamin Renard   Add templated par... 
106
 
		return array("id" => $real_param_id, "indexes" => $indexes, "calib_infos" => $calib_infos);
22521f1c   Benjamin Renard   First commit 
107
108
109
110
111
 
	}

	/*
	 * @brief Add linked parameter
	*/
bf27ba04   Benjamin Renard   Add templated par... 
112
 
	private function addLinkedLocalParams($paramId,$paramsData,$templateArgs = NULL)
22521f1c   Benjamin Renard   First commit 
113
 
	{
952dd7c7   elena   catalog integration 
114
115
 
		$doc = new DOMDocument("1.0", "UTF-8");
		$doc->preserveWhiteSpace = false;
22521f1c   Benjamin Renard   First commit 
116
117
 
		$doc->formatOutput = true;
bf27ba04   Benjamin Renard   Add templated par... 
118
119
120
121
122
123
124
125
126
 
		$real_param_id = $real_param_id;
		if ($this->templateParamsManager->isTemplatedParam($paramId)) {
			$paramPath = $this->templateParamsManager->generateTemplatedParamFile($paramId, $templateArgs);
			$real_param_id = $this->templateParamsManager->getTemplatedParamId($paramId, $templateArgs);
		}
		else {
			$paramPath = IHMConfigClass::getLocalParamDBPath().$paramId.".xml";
		}
22521f1c   Benjamin Renard   First commit 
127
bf27ba04   Benjamin Renard   Add templated par... 
128
 
		if (empty($paramPath) || !$doc->load($paramPath))
22521f1c   Benjamin Renard   First commit 
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
			throw new Exception('Cannot find parameter local file '.$paramId);

		//<get>
		$getNodes = $doc->getElementsByTagName('get');

		if ($getNodes->length <= 0)
			throw new Exception('Parameter local file '.$paramId.' dont have a getter node');

		$getNode = $getNodes->item(0);

		//<amdaParam name="imf"/>
		$amdaParamNodes = $doc->getElementsByTagName('amdaParam');

		foreach($amdaParamNodes as $amdaParamNode)
		{
			$linkedParamId = $amdaParamNode->getAttribute('name');
			if ($linkedParamId == '')
				continue;
bf27ba04   Benjamin Renard   Add templated par... 
147
148
149
150
151
152
153
154
155
 
			$real_linked_param_id = $linkedParamId;
			if ($this->templateParamsManager->isTemplatedParam($linkedParamId)) {
				$linkedParamPath = $this->templateParamsManager->generateTemplatedParamFile($linkedParamId, $templateArgs);
				$real_linked_param_id = $this->templateParamsManager->getTemplatedParamId($linkedParamId, $templateArgs);
			}
			else
				$linkedParamPath = IHMConfigClass::getLocalParamDBPath().$linkedParamId.".xml";
			$paramsData->addParamToCopy($real_linked_param_id,$linkedParamPath);
			$this->addLinkedLocalParams($linkedParamId, $paramsData);
22521f1c   Benjamin Renard   First commit 
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
		}
	}

	/*
	 * @brief Add derived parameter
	*/
	private function addDerivedParam($param,$paramsData)
	{
		if (!isset($this->userParameterLoader))
			$this->userParameterLoader = new IHMUserParamLoaderClass();
		
		//get derived parameter info
		$res = $this->userParameterLoader->getDerivedParameterFromName($param);
		
		if (!$res["success"])
			throw new Exception('Error to load derived parameter file : '.$res["message"]);

		//parse expression
		if (!isset($this->expressionParser))
952dd7c7   elena   catalog integration 
175
 
			$this->expressionParser = new IHMExpressionParserClass();
22521f1c   Benjamin Renard   First commit 
176
177
 
		$expressionInfo = $this->expressionParser->parse($res["param"]["expression"]);
952dd7c7   elena   catalog integration 
178
179
180
181
182
 
		$paramId = $param;
		
		//create a process param for the derived parameter
		$this->addProcessParam($paramId, $expressionInfo["expression"],
				$expressionInfo['params'], $res["param"]["timestep"],
286f7924   Benjamin Renard   Derived parameter... 
183
 
				0,$res["param"]["dateModif"],$paramsData);
22521f1c   Benjamin Renard   First commit 
184
185
186
187
188
189
190
191
192
 
		
		return array("id" => $paramId, "indexes" => array(), "calib_infos" => array());
	}

	/*
	 * @brief Add uploaded parameter
	*/
	private function addUploadedParam($param,$paramsData)
	{
944199fe   Benjamin Renard   Use table definit... 
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
		if (!isset($this->userParameterLoader))
			$this->userParameterLoader = new IHMUserParamLoaderClass();
		
		//get uploaded parameter info
		$res = $this->userParameterLoader->getUploadedParameterFromName($param);
		
		if (!$res["success"])
			throw new Exception('Error to load uploaded parameter file : '.$res["message"]);
		
		$newParamNode = $paramsData->addLocalParamToCreate($res["param"]["id"], 
				$res["param"]["info"]["viId"], $res["param"]["info"]["realVar"],
				$res["param"]["info"]["minSampling"], $res["param"]["info"]["maxSampling"],
				$res["param"]["dateModif"]);
		
		$tableDef = $res["param"]["info"]["tableDef"];
		if (isset($tableDef) && array_key_exists('tableDefType', $tableDef) && ($tableDef['tableDefType'] != 'NONE'))
		{
			switch ($tableDef['channelsDefType'])
			{
				case 'MINMAX' :
					$minMaxTable = $newParamNode->getInfo()->addTable(InfoParamTableTypeEnum::MINMAX, $res["param"]["info"]["yTitle"]);
					$minMaxTable->setUnits($res["param"]["info"]["units"]);
					switch ($tableDef['tableDefType'])
					{
						case 'SELECT' :
							$minMaxTable->setMinName($tableDef['data']['min']);
							$minMaxTable->setMaxName($tableDef['data']['max']);
							$newParamNode->getParamGet()->getLocalParam($res["param"]["info"]["realVar"])->addCalibInfo($tableDef['data']['min']);
							$newParamNode->getParamGet()->getLocalParam($res["param"]["info"]["realVar"])->addCalibInfo($tableDef['data']['max']);
							break;
						case 'MANUAL' :
							$minMaxTable->setMinName('min');
							$minMaxTable->setMaxName('max');
							$clbMinNode = $newParamNode->addClbManual('min');
							$clbMinValues = explode(',', $tableDef['data']['min']);
							foreach ($clbMinValues as $value)
								$clbMinNode->addClbValue($value);
							$clbMaxNode = $newParamNode->addClbManual('max');
							$clbMaxValues = explode(',', $tableDef['data']['max']);
							foreach ($clbMaxValues as $value)
								$clbMaxNode->addClbValue($value);
						break;
					}
					break;
				case 'BOUND'  :
					$boundTable = $newParamNode->getInfo()->addTable(InfoParamTableTypeEnum::BOUNDS, $res["param"]["info"]["yTitle"]);
					$boundTable->setUnits($res["param"]["info"]["units"]);
					switch ($tableDef['tableDefType'])
					{
						case 'SELECT' :
							$boundTable->setBoundsName($tableDef['data']['bound']);
							$newParamNode->getParamGet()->getLocalParam($res["param"]["info"]["realVar"])->addCalibInfo($tableDef['data']['bound']);
							break;
						case 'MANUAL' :
							$boundTable->setBoundsName('bound');
							$clbBoundNode = $newParamNode->addClbManual('bound');
							$clbBoundValues = explode(',', $tableDef['data']['bound']);
							foreach ($clbBoundValues as $value)
								$clbBoundNode->addClbValue($value);
							break;
					}
					break;
				case 'CENTER' :
					$centerTable = $newParamNode->getInfo()->addTable(InfoParamTableTypeEnum::CENTER, $res["param"]["info"]["yTitle"]);
					$centerTable->setUnits($res["param"]["info"]["units"]);
					$centerTable->setSize($tableDef['data']['width']);
					switch ($tableDef['tableDefType'])
					{
						case 'SELECT' :
							$centerTable->setCenterName($tableDef['data']['center']);
							$newParamNode->getParamGet()->getLocalParam($res["param"]["info"]["realVar"])->addCalibInfo($tableDef['data']['center']);
							break;
						case 'MANUAL' :
							$centerTable->setCenterName('center');
							$clbCenterNode = $newParamNode->addClbManual('center');
							$clbCenterValues = explode(',', $tableDef['data']['center']);
							foreach ($clbCenterValues as $value)
								$clbCenterNode->addClbValue($value);
							break;
					}
					break;
				case 'CENTERWIDTH' :
					$centerWidthTable = $newParamNode->getInfo()->addTable(InfoParamTableTypeEnum::CENTERWIDTH, $res["param"]["info"]["yTitle"]);
					$centerWidthTable->setUnits($res["param"]["info"]["units"]);
					switch ($tableDef['tableDefType'])
					{
						case 'SELECT' :
							$centerWidthTable->setCenterName($tableDef['data']['center']);
							$centerWidthTable->setWidthName($tableDef['data']['width']);
							$newParamNode->getParamGet()->getLocalParam($res["param"]["info"]["realVar"])->addCalibInfo($tableDef['data']['center']);
							$newParamNode->getParamGet()->getLocalParam($res["param"]["info"]["realVar"])->addCalibInfo($tableDef['data']['width']);
							break;
						case 'MANUAL' :
							$centerWidthTable->setCenterName('center');
							$centerWidthTable->setWidthName('width');
							$clbCenterNode = $newParamNode->addClbManual('center');
							$clbWidthNode = $newParamNode->addClbManual('width');
							$clbCenterValues = explode(',', $tableDef['data']['center']);
							foreach ($clbCenterValues as $value)
								$clbCenterNode->addClbValue($value);
							$clbWidthValues = explode(',', $tableDef['data']['width']);
							foreach ($clbWidthValues as $value)
								$clbWidthNode->addClbValue($value);
							break;
					}
					break;
			}
		}
		
		return array("id" => $res["param"]["id"], "plotType" => $res["param"]["info"]["plotType"]);
22521f1c   Benjamin Renard   First commit 
303
304
 
	}
}