Add layout property to draw time axes only for the lower time plot (#5493)

Benjamin Renard
1 parent 3234c60f
Showing 8 changed files with 76 additions and 10 deletions Show diff stats
config/xsd/request/plot.xsd
src/ParamOutputImpl/Plot/Layout.hh
src/ParamOutputImpl/Plot/LayoutAuto.hh
src/ParamOutputImpl/Plot/LayoutNode.cc
src/ParamOutputImpl/Plot/LayoutProperties.hh
src/ParamOutputImpl/Plot/LayoutVertical.hh
src/ParamOutputImpl/Plot/PlotOutput.cc
src/ParamOutputImpl/Plot/PlotOutput.hh
@@ -429,6 +429,10 @@
                     				<xs:attribute name="expand"
                     					type="xs:boolean">
                     				</xs:attribute>
+						<xs:attribute name="onlyLowerTimeAxesLegend"
+							type="xs:boolean">
+
+						</xs:attribute>
                     			</xs:complexType>
                     		</xs:element>
                     		<xs:element name="panelDefaults"
@@ -38,12 +38,13 @@ enum class PanelConstraint {
  */
 class Layout {
 public:
-	Layout(double panelHeight, double panelSpacing, double firstPanelHeightFactor = 1.0, bool autoExpand = true, double xyRatio = 1.0) :
+	Layout(double panelHeight, double panelSpacing, double firstPanelHeightFactor = 1.0, bool autoExpand = true, double xyRatio = 1.0,  bool onlyLowerTimeAxesLegend = false) :
 		_requestPanelHeight (panelHeight),
 		_requestPanelSpacing(panelSpacing),
 		_firstPanelHeightFactor(firstPanelHeightFactor),
 		_autoExpand (autoExpand),
-		_xyRatio (xyRatio)
+		_xyRatio (xyRatio),
+		_onlyLowerTimeAxesLegend(onlyLowerTimeAxesLegend)
 	{
 	}
  
@@ -58,6 +59,7 @@ protected:
 	double 		_firstPanelHeightFactor;
 	bool		_autoExpand;
 	double		_xyRatio;
+	bool            _onlyLowerTimeAxesLegend;
 };
  
 } /* namespace plot */
@@ -21,8 +21,8 @@ namespace plot {
  */
 class LayoutAuto : public Layout {
 public:
-	LayoutAuto(double panelHeight, double panelSpacing, double firstPanelHeightFactor = 1.0, bool autoExpand = true, double xyRatio = 1.0) :
-		Layout (panelHeight, panelSpacing, firstPanelHeightFactor, autoExpand, xyRatio),
+	LayoutAuto(double panelHeight, double panelSpacing, double firstPanelHeightFactor = 1.0, bool autoExpand = true, double xyRatio = 1.0, bool onlyLowerTimeAxesLegend = false) :
+		Layout (panelHeight, panelSpacing, firstPanelHeightFactor, autoExpand, xyRatio, onlyLowerTimeAxesLegend),
 		_nbMaxWidthPanel(0),
 		_nbSquarePanel(0),
 		_curMaxWidthPanel(0),
@@ -72,6 +72,13 @@ void LayoutNode::proceed(xmlNodePtr pNode_,const AMDA::Parameters::CfgContext&amp; p
 		page->_layoutProperties.setExpand( strcasecmp ((const char*)value, "true") == 0);
 		xmlFree(value);
 	}
+
+	// onlyLowerTimeAxesLegend
+	value = xmlGetProp(pNode_, (const xmlChar *)"onlyLowerTimeAxesLegend");
+	if( value ){
+		page->_layoutProperties.setOnlyLowerTimeAxesLegend( strcasecmp ((const char*)value, "true") == 0);
+		xmlFree(value);
+	}
 }
  
 } /* namespace plot */
@@ -44,7 +44,7 @@ public:
  
  
 	LayoutProperties() :
-		_type(LayoutType::MANUAL), _panelHeight(0.5), _panelSpacing(0.05), _firstPanelHeightFactor(1.0), _expand(false)
+		_type(LayoutType::MANUAL), _panelHeight(0.5), _panelSpacing(0.05), _firstPanelHeightFactor(1.0), _expand(false), _onlyLowerTimeAxesLegend(false)
 	{
 	}
  
@@ -53,7 +53,8 @@ public:
 		_panelHeight(pLayoutProperties_._panelHeight),
 		_panelSpacing(pLayoutProperties_._panelSpacing),
 		_firstPanelHeightFactor(pLayoutProperties_._firstPanelHeightFactor),
-		_expand(pLayoutProperties_._expand)
+		_expand(pLayoutProperties_._expand),
+		_onlyLowerTimeAxesLegend(pLayoutProperties_._onlyLowerTimeAxesLegend)
 	{
 	}
  
@@ -63,6 +64,7 @@ public:
 		_panelSpacing 			= pLayoutProperties_._panelSpacing;
 		_firstPanelHeightFactor	= pLayoutProperties_._firstPanelHeightFactor;
 		_expand 				= pLayoutProperties_._expand;
+		_onlyLowerTimeAxesLegend = pLayoutProperties_._onlyLowerTimeAxesLegend;
 		return *this;
 	}
  
@@ -109,6 +111,14 @@ public:
 		_expand = expand;
 	}
  
+	bool isOnlyLowerTimeAxesLegend() const {
+		return _onlyLowerTimeAxesLegend;
+	}
+
+	void setOnlyLowerTimeAxesLegend(bool onlyLowerTimeAxesLegend) {
+		_onlyLowerTimeAxesLegend = onlyLowerTimeAxesLegend;
+	}
+
 private:
  
 	LayoutType 	_type;
@@ -116,6 +126,7 @@ private:
 	double 		_panelSpacing;
 	double 		_firstPanelHeightFactor;
 	bool		_expand;
+	bool		_onlyLowerTimeAxesLegend;
 };
  
  
@@ -39,8 +39,8 @@ public:
  */
 class LayoutVertical : public Layout {
 public:
-	LayoutVertical(double panelHeight, double panelSpacing, double firstPanelHeightFactor = 1.0, bool autoExpand = true, double xyRatio = 1.0) :
-		Layout (panelHeight, panelSpacing, firstPanelHeightFactor, autoExpand, xyRatio),
+	LayoutVertical(double panelHeight, double panelSpacing, double firstPanelHeightFactor = 1.0, bool autoExpand = true, double xyRatio = 1.0, bool onlyLowerTimeAxesLegend = false) :
+		Layout (panelHeight, panelSpacing, firstPanelHeightFactor, autoExpand, xyRatio, onlyLowerTimeAxesLegend),
 		_curPanel(0),
 		_curYPosition(0),
 		_maxWidthConstraintFound(false),
@@ -12,6 +12,9 @@
 #include "LayoutAuto.hh"
 #include "LayoutVertical.hh"
 #include "TimePlotNode.hh"
+#include "Time/TimePlot.hh"
+
+#include <boost/range/adaptor/reversed.hpp>
  
 namespace plot {
  
@@ -195,6 +198,9 @@ void PlotOutput::drawOneIntervalByPage()
 		// Compute panel position depending on the page layout
 		computePanelBounds();
  
+		// Fix time axes legend visibility in relation with the request
+		fixPanelTimeAxesVisibility();
+
 		// Initialize panel plot
 		for (auto plot : _plots) {
 			// set current plplot stream for plot,
@@ -290,6 +296,9 @@ void PlotOutput::drawAllIntervalsInOnePage()
 	//Compute panel position depending on the page layout
 	computePanelBounds();
  
+	// Fix time axes legend visibility in relation with the request
+	fixPanelTimeAxesVisibility();
+
 	//Initialize panel plot
 	for (auto plot : _plots)
 	{
@@ -412,14 +421,16 @@ void PlotOutput::computePanelBounds(void) {
 					_page->_layoutProperties.getPanelSpacing(),
 					_page->_layoutProperties.getFirstPanelHeightFactor(),
 					_page->_layoutProperties.isExpand(),
-					xyRatio);
+					xyRatio,
+					_page->_layoutProperties.isOnlyLowerTimeAxesLegend());
 	} else {
 		pLayout = new LayoutVertical (
 					_page->_layoutProperties.getPanelHeight(),
 					_page->_layoutProperties.getPanelSpacing(),
 					_page->_layoutProperties.getFirstPanelHeightFactor(),
 					_page->_layoutProperties.isExpand(),
-					xyRatio);
+					xyRatio,
+					_page->_layoutProperties.isOnlyLowerTimeAxesLegend());
 	}
  
 	// Compute panel bounds depending on the constraints
@@ -507,6 +518,32 @@ void PlotOutput::computePanelPlotAreaBoundsForManualLayout(void) {
 	}
 }
  
+void PlotOutput::fixPanelTimeAxesVisibility(void) {
+	if ((_plots.empty() == true) ||
+		(_page->_layoutProperties.getType() == LayoutType::MANUAL) ||
+		!_page->_layoutProperties.isOnlyLowerTimeAxesLegend())     {
+		return;
+	}
+
+	LOG4CXX_DEBUG(gLogger,"PlotOutput::fixPanelTimeAxesVisibility...");
+
+	bool isFirstTimePlot = true;
+	for (auto plot : boost::adaptors::reverse(_plots)) {
+		if (plot->typeName() != TIMEPLOT_NODENAME) {
+			continue;
+		}
+		if (isFirstTimePlot) {
+			isFirstTimePlot = false;
+			continue;
+		}
+		
+		TimePlot* timePlot = reinterpret_cast<TimePlot*>(plot.get());
+		TimeAxis* timeAxis = timePlot->getTimeAxis();
+		timeAxis->setShowLegend(false);
+		timeAxis->setShowTickMark(false);
+	}
+}
+
 void PlotOutput::computePanelLegendPosition(void) {
 	// Nothing to plot -> nothing to compute !
 	if ((_plots.empty() == true))	{
@@ -217,6 +217,11 @@ protected:
 	virtual void computePanelPlotAreaBoundsForManualLayout(void);
  
 	/**
+ 	 * @brief Fix time axes visibility in relation with the request
+ 	 */
+	virtual void fixPanelTimeAxesVisibility(void);
+
+	/**
 	 * @brief Compute legend position depending on the panel constraints
 	 */
 	virtual void computePanelLegendPosition (void);