Add tick plot and status plot integration

Benjamin Renard
1 parent 4ede4320
Showing 10 changed files with 271 additions and 33 deletions Show diff stats
install/testParams/newKernelDDBase/qual1_sta.xml
src/InputOutput/IHMImpl/Params/PlotImpl/IHMInputOutputParamsPlotClass.php
src/Request/ParamsRequestImpl/Nodes/Requests/RequestOutputPlotAxesNodeClass.php
src/Request/ParamsRequestImpl/Nodes/Requests/RequestOutputPlotElementNodeClass.php
src/Request/ParamsRequestImpl/Nodes/Requests/RequestOutputPlotElementStatusNodeClass.php
src/Request/ParamsRequestImpl/Nodes/Requests/RequestOutputPlotElementTickNodeClass.php
src/Request/ParamsRequestImpl/Nodes/Requests/RequestOutputPlotElementTimeNodeClass.php
src/Request/ParamsRequestImpl/Nodes/Requests/RequestOutputPlotElementXYNodeClass.php
src/Request/ParamsRequestImpl/Nodes/Requests/RequestOutputPlotPanelNodeClass.php
src/Request/ParamsRequestImpl/Nodes/Requests/RequestOutputPlotParamsNodeClass.php
 <?xml version="1.0" encoding="UTF-8"?>
 <param xml:id="qual1_sta">
+  <info>
+   <name>StA, Quality_MAG</name>
+   <short_name>StA, Quality_MAG</short_name>
+   <components></components>
+   <units></units>
+   <coordinates_system></coordinates_system>
+   <tensor_order>0</tensor_order>
+   <si_conversion></si_conversion>
+   <fill_value>-1.0e+31</fill_value>
+   <ucd></ucd>
+   <status_def>
+    <status minVal="0" maxVal="0" name="Outside"/>
+    <status minVal="1" maxVal="1" name="Inside"/>
+   </status_def>
+   <dataset_id></dataset_id>		
+  </info>
   <get>
  
-  <vi name="sta:swea:mom"><baseParam name="Quality1">
+  <vi name="sta:swea:mom"><baseParam name="Quality1" useNearestValue="true">
  
 	 </baseParam></vi></get>
   <process/>
   <output/>
 </param>
+
@@ -30,12 +30,6 @@ class IHMInputOutputParamsPlotClass extends IHMInputOutputParamsAbstractClass
 			$paramsNode  = $requestNode->getParamsNode();
  
 			//unmarshall time definition
-			
-			//BRE - For debug - TO ERASE
-			$input->{'startDate'} = '2005-01-30T00:00:18';
-			$input->{'stopDate'} = '2005-02-01T00:00:15';
-				
-			
 			$this->unmarshallTimeDefinition($input, $requestIndex);
  
 			$plotOutputNode = $outputsNode->addNewOutput(RequestOutputTypeEnum::PLOT);
@@ -207,12 +201,44 @@ class IHMInputOutputParamsPlotClass extends IHMInputOutputParamsAbstractClass
 		//Plot type
 		$plotNode = $this->unmarshallPlotType($panelData, $panelNode);
  
+		//Tick plot
+		$tickPlotNode = NULL;
+		if ($plotNode->getName() == REQUESTOUTPUTPLOTELEMENTTIME_NAME)
+		{
+			if ($this->hasTickBar($panelData->{'params'}))
+			{
+				$tickPlotNode = $panelNode->addPlotElement(RequestOutputPlotElementTypeEnum::TICKPLOT,true);
+				if ($panelData->{'panel-tick-format'} != '')
+					$tickPlotNode->setFormat($panelData->{'panel-tick-format'});
+			}
+		}
+		
+		//Status plot
+		$statusPlotNode = NULL;
+		if ($plotNode->getName() == REQUESTOUTPUTPLOTELEMENTTIME_NAME)
+		{
+			if ($this->hasStatusBar($panelData->{'params'}))
+			{
+				$statusPlotNode = $panelNode->addPlotElement(RequestOutputPlotElementTypeEnum::STATUSPLOT,true);
+				switch ($panelData->{'panel-status-position'})
+				{
+					case 'top' :
+						$statusPlotNode->setPosition(RequestOutputPlotElementStatusPosition::TOP);
+						break;
+					case 'bottom' :
+						$statusPlotNode->setPosition(RequestOutputPlotElementStatusPosition::BOTTOM);
+						break;
+				}
+				$statusPlotNode->setColorMap($panelData->{'panel-status-colormap'});
+			}
+		}
+		
 		//Axes
 		foreach ($panelData->{'axes'} as $axisData)
 			$this->unmarshallAxis($axisData, $plotNode);
  
 		//Params
-		$this->unmarshallParams($panelData->{'params'}, $paramsNode, $plotNode);
+		$this->unmarshallParams($panelData->{'params'}, $paramsNode, $plotNode, $panelNode, $statusPlotNode, $tickPlotNode);
  
 		return $panelNode;
 	}
@@ -227,6 +253,24 @@ class IHMInputOutputParamsPlotClass extends IHMInputOutputParamsAbstractClass
 			case 'xyPlot' :
 				$plotNode = $panelNode->addPlotElement(RequestOutputPlotElementTypeEnum::XYPLOT);
 				break;
+			case 'statusPlot' :
+				$plotNode = $panelNode->addPlotElement(RequestOutputPlotElementTypeEnum::STATUSPLOT);
+				switch ($panelData->{'panel-status-position'})
+				{
+					case 'top' :
+						$plotNode->setPosition(RequestOutputPlotElementStatusPosition::TOP);
+						break;
+					case 'bottom' :
+						$plotNode->setPosition(RequestOutputPlotElementStatusPosition::BOTTOM);
+						break;
+				}
+				$plotNode->setColorMap($panelData->{'panel-status-colormap'});
+				break;
+			case 'tickPlot' :
+				$plotNode = $panelNode->addPlotElement(RequestOutputPlotElementTypeEnum::TICKPLOT);
+				if ($panelData->{'panel-tick-format'} != '')
+					$plotNode->setFormat($panelData->{'panel-tick-format'});
+				break;
 			default:
 				throw new Exception('Plot type not implemented.');
 		}
@@ -314,7 +358,7 @@ class IHMInputOutputParamsPlotClass extends IHMInputOutputParamsAbstractClass
 		$this->unmarshallLabel($axisData, "axis-legend", $axisNode->getLegend());
 	}
  
-	protected function unmarshallParams($paramsData, $requestParamsNode, $plotNode)
+	protected function unmarshallParams($paramsData, $requestParamsNode, $plotNode, $panelNode, $statusPlotNode, $tickPlotNode)
 	{
 		//X parameters
 		$isScatter = ($plotNode->getName() == REQUESTOUTPUTPLOTELEMENTXY_NAME);
@@ -354,7 +398,7 @@ class IHMInputOutputParamsPlotClass extends IHMInputOutputParamsAbstractClass
 			//Param
 			$paramInfo = $this->paramManager->addExistingParam($paramData->{'param-id'},$this->paramsData);
 			$requestParamsNode->addParam($paramInfo['id']);
-			$paramNode = $plotNode->getParams()->getParamById($paramInfo['id']);
+			
  
 			$colorSerieId = -1;
 			if ($paramData->{'param-drawing-object'}->{'serie-colored-param'} != '')
@@ -363,11 +407,29 @@ class IHMInputOutputParamsPlotClass extends IHMInputOutputParamsAbstractClass
 			switch ($paramData->{'param-drawing-type'})
 			{
 				case 'serie' :
+					$paramNode = $plotNode->getParams()->getParamById($paramInfo['id']);
 					$this->unmarshallYSerie($paramData->{'param-drawing-object'}, $plotNode, $paramNode, $paramInfo['indexes'], $isScatter && ($paramData->{'param-drawing-object'}->{'serie-xaxis-param'} != ''), $colorSerieId);
 					break;
 				case 'spectro' :
+					$paramNode = $plotNode->getParams()->getParamById($paramInfo['id']);
 					$this->unmarshallSpectro($paramData->{'param-drawing-object'}, $plotNode, $paramNode, $paramInfo['indexes']);
 					break;
+				case 'status-bar' :
+					if (($plotNode->getName() == REQUESTOUTPUTPLOTELEMENTSTATUS_NAME) && !isset($statusPlotNode))
+						$paramNode = $plotNode->getParams()->getParamById($paramInfo['id']);
+					else
+						$paramNode = $statusPlotNode->getParams()->getParamById($paramInfo['id']);
+					
+					$this->unmarshallStatusBar($paramData->{'param-drawing-object'}, $paramNode, $paramInfo['indexes']);
+					break;
+				case 'tick-bar' :
+					if (($plotNode->getName() == REQUESTOUTPUTPLOTELEMENTTICK_NAME) && !isset($tickPlotNode))
+						$paramNode = $plotNode->getParams()->getParamById($paramInfo['id']);
+					else
+						$paramNode = $tickPlotNode->getParams()->getParamById($paramInfo['id']);
+					
+					$this->unmarshallTickBar($paramData->{'param-drawing-object'}, $paramNode, $paramInfo['indexes']);
+					break;
 				default :
 					throw new Exception('Drawing type not implemented.');
 			}
@@ -433,6 +495,38 @@ class IHMInputOutputParamsPlotClass extends IHMInputOutputParamsAbstractClass
 		$spectroNode = $paramNode->addSpectro($paramDrawingData->{'spectro-yaxis'});
 	}
  
+	protected function unmarshallStatusBar($paramDrawingData, $paramNode, $indexes)
+	{
+		if (count($indexes) == 0)
+			$paramNode->addStatusBar(-1);
+		foreach ($indexes as $index)
+			$paramNode->addStatusBar($index);
+	}
+	
+	protected function unmarshallTickBar($paramDrawingData, $paramNode, $indexes)
+	{
+		if (count($indexes) == 0)
+			$paramNode->addTickBar(-1);
+		foreach ($indexes as $index)
+			$paramNode->addTickBar($index);
+	}
+	
+	protected function hasStatusBar($paramsData)
+	{
+		foreach ($paramsData as $paramData)
+			if ($paramData->{'param-drawing-type'} == 'status-bar')
+				return true;
+		return false;
+	}
+	
+	protected function hasTickBar($paramsData)
+	{
+		foreach ($paramsData as $paramData)
+			if ($paramData->{'param-drawing-type'} == 'tick-bar')
+				return true;
+		return false;
+	}
+	
 	protected function unmarshallTitle($inputData, $keyPrefix, $titleNode)
 	{
 		if ($inputData->{$keyPrefix.'-text'} != '')
@@ -23,13 +23,16 @@ abstract class RequestOutputPlotAxisTypeEnum
  */
 class RequestOutputPlotAxesNodeClass extends NodeClass
 {
-	public function __construct()
+	public function __construct($noXAxis, $noYAxis, $noZAxis)
 	{
 		parent::__construct(REQUESTOUTPUTPLOTAXES_NAME);
 		//create skeleton
-		$node = $this->getChildInstanceByName(REQUESTOUTPUTPLOTAXES_XAXIS, true);
-		$node = $this->getChildInstanceByName(REQUESTOUTPUTPLOTAXES_YAXIS, true);
-		$node = $this->getChildInstanceByName(REQUESTOUTPUTPLOTAXES_ZAXIS, true);
+		if (!$noXAxis)
+			$node = $this->getChildInstanceByName(REQUESTOUTPUTPLOTAXES_XAXIS, true);
+		if (!$noYAxis)
+			$node = $this->getChildInstanceByName(REQUESTOUTPUTPLOTAXES_YAXIS, true);
+		if (!$noZAxis)
+			$node = $this->getChildInstanceByName(REQUESTOUTPUTPLOTAXES_ZAXIS, true);
 	}
  
 	public function addDigitalAxis($axisType,$id)
@@ -13,7 +13,7 @@ require_once(&quot;RequestOutputPlotAxesNodeClass.php&quot;);
 */
 class RequestOutputPlotElementNodeClass extends NodeClass
 {
-	public function __construct($plotElementName, $defineLegends, $defineAdditionalObjects, $defineFills)
+	public function __construct($plotElementName, $defineLegends, $defineAdditionalObjects, $defineFills, $noXAxis, $noYAxis, $noZAxis)
 	{
 		parent::__construct($plotElementName);
 		//create plot element skeleton
@@ -30,9 +30,12 @@ class RequestOutputPlotElementNodeClass extends NodeClass
 		$this->addChild($node);
  
 		//axes
-		$node = new RequestOutputPlotAxesNodeClass();
-		$this->addChild($node);
-
+		if (!$noXAxis || !$noYAxis || !$noZAxis)
+		{
+			$node = new RequestOutputPlotAxesNodeClass($noXAxis, $noYAxis, $noZAxis);
+			$this->addChild($node);
+		}
+			
 		//ToDo additional objects
 		/*if ($defineAdditionalObjects)
 		 {
@@ -0,0 +1,58 @@
+<?php
+
+require_once("RequestOutputPlotElementNodeClass.php");
+
+define ("REQUESTOUTPUTPLOTELEMENTSTATUS_NAME", "statusPlot");
+define ("REQUESTOUTPUTPLOTELEMENTSTATUS_POSITION", "position");
+define ("REQUESTOUTPUTPLOTELEMENTSTATUS_COLORMAP", "colorMapIndex");
+
+abstract class RequestOutputPlotElementStatusPosition
+{
+	const TOP    = "top";
+	const BOTTOM = "bottom";
+}
+
+/**
+ * @class RequestOutputPlotElementStatusNodeClass
+ * @brief Definition of a status plot element for a panel of a plot request
+ * @details
+*/
+class RequestOutputPlotElementStatusNodeClass extends RequestOutputPlotElementNodeClass
+{
+	public function __construct($noAxis)
+	{
+		parent::__construct(REQUESTOUTPUTPLOTELEMENTSTATUS_NAME,false,false,false,$noAxis,true,true);
+		if (!$noAxis)
+			//force time axis creation
+			$this->getAxes()->getTimeAxis();
+	}
+
+	public function getTimeAxis()
+	{
+		if ($this->getAxes() == NULL)
+			return NULL;
+		return $this->getAxes()->getTimeAxis();
+	}
+	
+	public function setPosition($position)
+	{
+		$this->setAttribute(REQUESTOUTPUTPLOTELEMENTSTATUS_POSITION, $position);
+	}
+	
+	public function getPosition()
+	{
+		return $this->getAttribute(REQUESTOUTPUTPLOTELEMENTSTATUS_POSITION);
+	}
+	
+	public function setColorMap($colorMapIndex)
+	{
+		$this->setAttribute(REQUESTOUTPUTPLOTELEMENTSTATUS_COLORMAP, $colorMapIndex);
+	}
+	
+	public function getColorMap()
+	{
+		return $this->getAttribute(REQUESTOUTPUTPLOTELEMENTSTATUS_COLORMAP);
+	}
+}
+
+?>
 \ No newline at end of file
@@ -0,0 +1,41 @@
+<?php
+
+require_once("RequestOutputPlotElementNodeClass.php");
+
+define ("REQUESTOUTPUTPLOTELEMENTTICK_NAME", "tickPlot");
+define ("REQUESTOUTPUTPLOTELEMENTTICK_FORMAT", "format");
+
+/**
+ * @class RequestOutputPlotElementTickNodeClass
+ * @brief Definition of a tick plot element for a panel of a plot request
+ * @details
+*/
+class RequestOutputPlotElementTickNodeClass extends RequestOutputPlotElementNodeClass
+{
+	public function __construct($noAxis)
+	{
+		parent::__construct(REQUESTOUTPUTPLOTELEMENTTICK_NAME,false,false,false,$noAxis,true,true);
+		if (!$noAxis)
+			//force time axis creation
+			$this->getAxes()->getTimeAxis();
+	}
+
+	public function getTimeAxis()
+	{
+		if ($this->getAxes() == NULL)
+			return NULL;
+		return $this->getAxes()->getTimeAxis();
+	}
+	
+	public function setFormat($format)
+	{
+		$this->setAttribute(REQUESTOUTPUTPLOTELEMENTTICK_FORMAT, $format);
+	}
+	
+	public function getFormat()
+	{
+		return $this->getAttribute(REQUESTOUTPUTPLOTELEMENTTICK_FORMAT);
+	}
+}
+
+?>
 \ No newline at end of file
@@ -13,7 +13,7 @@ class RequestOutputPlotElementTimeNodeClass extends RequestOutputPlotElementNode
 {
 	public function __construct()
 	{
-		parent::__construct(REQUESTOUTPUTPLOTELEMENTTIME_NAME,true,true,true);
+		parent::__construct(REQUESTOUTPUTPLOTELEMENTTIME_NAME,true,true,true,false,false,false);
 		//force time axis creation
 		$this->getAxes()->getTimeAxis();
 		//force color axis creation
@@ -15,7 +15,7 @@ class RequestOutputPlotElementXYNodeClass extends RequestOutputPlotElementNodeCl
 {
 	public function __construct()
 	{
-		parent::__construct(REQUESTOUTPUTPLOTELEMENTXY_NAME,true,true,false);
+		parent::__construct(REQUESTOUTPUTPLOTELEMENTXY_NAME,true,true,false,false,false,false);
 		//create x axis
 		$this->getAxes()->addDigitalAxis(RequestOutputPlotAxisTypeEnum::XAXIS,REQUESTOUTPUTPLOTELEMENTXY_XAXISID);
 		//force color axis creation
@@ -2,6 +2,8 @@
  
 require_once("RequestOutputPlotElementTimeNodeClass.php");
 require_once("RequestOutputPlotElementXYNodeClass.php");
+require_once("RequestOutputPlotElementStatusNodeClass.php");
+require_once("RequestOutputPlotElementTickNodeClass.php");
  
 define ("REQUESTOUTPUTPLOTPANEL_NAME", "panel");
 define ("REQUESTOUTPUTPLOTPANEL_TITLE", "title");
@@ -11,6 +13,8 @@ abstract class RequestOutputPlotElementTypeEnum
 {
 	const TIMEPLOT = "TimePlot";
 	const XYPLOT   = "XYPlot";
+	const STATUSPLOT = "StatusPlot";
+	const TICKPLOT = "TickPlot";
 }
  
 /**
@@ -63,11 +67,8 @@ class RequestOutputPlotPanelNodeClass extends NodeClass
 		return $node;
 	}
  
-	public function addPlotElement($type)
+	public function addPlotElement($type,$noAxes = false)
 	{
-		if ($this->getPlotElement() != NULL)
-			return $this->getPlotElement();
-			
 		switch ($type)
 		{
 			case RequestOutputPlotElementTypeEnum::TIMEPLOT :
@@ -76,6 +77,12 @@ class RequestOutputPlotPanelNodeClass extends NodeClass
 			case RequestOutputPlotElementTypeEnum::XYPLOT :
 				$node = new RequestOutputPlotElementXYNodeClass();
 				break;
+			case RequestOutputPlotElementTypeEnum::STATUSPLOT :
+				$node = new RequestOutputPlotElementStatusNodeClass($noAxes);
+				break;
+			case RequestOutputPlotElementTypeEnum::TICKPLOT :
+				$node = new RequestOutputPlotElementTickNodeClass($noAxes);
+				break;
 			default :
 				return NULL;
 		}
@@ -83,16 +90,7 @@ class RequestOutputPlotPanelNodeClass extends NodeClass
 		return $node;
 	}
  
-	public function getPlotElement()
-	{
-		return $this->getFirstChildByName(REQUESTOUTPUTPLOTPANEL_NAME);
-	}
-
-	/* ToDo tickPlot */
-
-	/* ToDo backgroundColor */
  
-	/* ToDo colorMapIndex */
  
 	/* ToDo prefered size */
  
@@ -18,6 +18,12 @@ define (&quot;REQUESTOUTPUTPLOTCOLORSERIE_INDEX&quot;, &quot;index&quot;);
 define ("REQUESTOUTPUTPLOTSPECTRO_NAME", "spectro");
 define ("REQUESTOUTPUTPLOTSPECTRO_YAXIS", "yAxis");
  
+define ("REQUESTOUTPUTPLOTSTATUSBAR_NAME", "serie");
+define ("REQUESTOUTPUTPLOTSTATUSBAR_INDEX", "index");
+
+define ("REQUESTOUTPUTPLOTTICKBAR_NAME", "serie");
+define ("REQUESTOUTPUTPLOTTICKBAR_INDEX", "index");
+
 /**
  * @class RequestOutputPlotParamNodeClass
  * @brief Definition of a param for a plot of a plot request
@@ -81,6 +87,24 @@ class RequestOutputPlotParamNodeClass extends NodeClass
 		$this->addChild($colorSerieNode);
 		return $colorSerieNode;
 	}
+	
+	public function addStatusBar($index)
+	{
+		$statusBarNode = new NodeClass(REQUESTOUTPUTPLOTSTATUSBAR_NAME);
+		if ($index >= 0)
+			$statusBarNode->setAttribute(REQUESTOUTPUTPLOTSTATUSBAR_INDEX, $index);
+		$this->addChild($statusBarNode);
+		return $statusBarNode;
+	}
+	
+	public function addTickBar($index)
+	{
+		$tickBarNode = new NodeClass(REQUESTOUTPUTPLOTTICKBAR_NAME);
+		if ($index >= 0)
+			$tickBarNode->setAttribute(REQUESTOUTPUTPLOTTICKBAR_INDEX, $index);
+		$this->addChild($tickBarNode);
+		return $tickBarNode;
+	}
 }
  
 /**