Fix bug with relative / mm margins definition

Fix bug with title size and color Fix copyright position in page Add file prefix definition Give the possibility to run a request without parameters Give the possibility to plot an empty page

Fix bug with relative / mm margins definition
Fix bug with title size and color Fix copyright position in page Add file prefix definition Give the possibility to run a request without parameters Give the possibility to plot an empty page
Benjamin Renard
1 parent 78e89487
Showing 9 changed files with 82 additions and 36 deletions Show diff stats
config/DataBaseParameters/xsd/request/plot.xsd
config/DataBaseParameters/xsd/request/request.xsd
src/ParamOutputImpl/Plot/CommonNode.cc
src/ParamOutputImpl/Plot/Page.cc
src/ParamOutputImpl/Plot/Page.hh
src/ParamOutputImpl/Plot/PlotNode.cc
src/ParamOutputImpl/Plot/PlotNode.hh
src/ParamOutputImpl/Plot/PlotOutput.cc
src/ParamOutputImpl/Plot/PlotOutput.hh
@@ -386,7 +386,8 @@
                         </xs:restriction>
                     </xs:simpleType>
 				</xs:element>
-                <xs:element name="page" minOccurs="1" maxOccurs="1">
+				<xs:element name="filePrefix" type="xs:string" minOccurs="0" maxOccurs="1"/>
+                <xs:element name="page" minOccurs="0" maxOccurs="1">
                     <xs:complexType>
                     	<xs:sequence>
                     		<xs:element name="title" type="TitleType"
@@ -455,7 +456,7 @@
                     					type="xs:integer" />
                     			</xs:complexType>
                     		</xs:element>
-                    		<xs:element name="panel" minOccurs="1"
+                    		<xs:element name="panel" minOccurs="0"
                     			maxOccurs="unbounded">
                     			<xs:complexType>
                     				<xs:sequence>
@@ -635,6 +636,7 @@
                 </xs:element>
                 <xs:element ref="PostProcessingElement" minOccurs="0" maxOccurs="1"/>
             </xs:sequence>
+            <xs:attribute name="writeContextFile" type="xs:boolean"/>
         </xs:complexType>
     </xs:element>
@@ -11,7 +11,7 @@
 				<xs:element name="params">
 					<xs:complexType>
 						<xs:sequence>
-							<xs:element name="param" minOccurs="1" maxOccurs="unbounded">
+							<xs:element name="param" minOccurs="0" maxOccurs="unbounded">
 								<xs:complexType>
 									<xs:attribute name="id" type="xs:string" />
 								</xs:complexType>
@@ -21,14 +21,14 @@ void MarginNode::proceed(xmlNodePtr pNode,
 	// -- horizontal margin
 	value = xmlGetProp(pNode, (const xmlChar *) "x");
 	if (value) {
-		element->_xMargin = atof((const char*) value);
+		element->calculateRelativeXMargin(element->_orientation, element->_dimension, atof((const char*) value));
 		xmlFree(value);
 	}
 	// -- vertical margin
 	value = xmlGetProp(pNode, (const xmlChar *) "y");
 	if (value) {
-		element->_yMargin = atof((const char*) value);
+		element->calculateRelativeYMargin(element->_orientation, element->_dimension, atof((const char*) value));
 		xmlFree(value);
 	}
 }
@@ -262,13 +262,22 @@ void Page::draw(std::shared_ptr&lt;plstream&gt;&amp; pls, bool newFile, const char *plotFi
 	// write title with dedicated position and align settings
 	pls->col0(0);
+	Color lInitialColor = changeColor(pls, _title._color, _mode);
+
 	// use page font if title font is not set
 	pls->sfont(getPlFontFamily(_title._font.isSet() ? _title._font : _font),
-			getPlFontStyle(_title._style), getPlFontWeight(_title._style));
-	pls->schr(getPlFontDef(_font), getPlFontScaleFactor(_font));
+			   (_title._font.isSet() ? getPlFontStyle(_title._style) : _font._style),
+			   (_title._font.isSet() ? getPlFontWeight(_title._style) : _font._weight));
+	if (_title._font.isSet())
+		pls->schr(getPlFontDef(_title._font), getPlFontScaleFactor(_title._font));
+	else
+		pls->schr(getPlFontDef(_font), getPlFontScaleFactor(_font));
 	pls->mtex(getPlSide(_titlePosition).c_str(), -1., getPlPos(_titleAlign),
 			getPlJust(_titleAlign), _title._text.c_str());
+	// Restore initial color.
+	restoreColor(pls, lInitialColor, _mode);
+
 	// write Created by AMDA(c) on bottom write
 	// write it on bottom right
 	// if HIDE_AMDA_DATE is not defined (used for fitnesse automatic image comparison)
@@ -290,15 +299,26 @@ void Page::writeCopywrite(std::shared_ptr&lt;plstream&gt;&amp; pls) {
 	timeinfo = localtime(&rawtime);
 	strftime(buffer, 80, "%d/%m/%G %T", timeinfo);
+	//set viewport
+	pls->vpor(0, 1, 0, 1);
+
+	//use page font
+	std::vector<Label::Style> styles;
+	pls->sfont(getPlFontFamily(_font), getPlFontStyle(styles), getPlFontWeight(styles));
+	pls->schr(getPlFontDef(_font), getPlFontScaleFactor(_font));
+
+
 	// write text on right bottom of the page
 	pls->mtex("b", -1., 1, 1,
 			std::string(createdby + " v" + version + " " + std::string(buffer)).c_str());
 }
 void Page::initPageParameters(std::shared_ptr<plstream>& pls) {
-	// calculate default margin if not set
-	calculateXMargin(_orientation, _dimension);
-	calculateYMargin(_orientation, _dimension);
+	// get default margin if not set
+	if (_xMargin == -1)
+		_xMargin = DefaultPlotConfiguration::getInstance()._defaultPage._xMargin;
+	if (_yMargin == -1)
+		_yMargin = DefaultPlotConfiguration::getInstance()._defaultPage._yMargin;
 	// set page size according to page format A4 or letter
 	// offset not seams to work
@@ -322,12 +342,8 @@ void Page::initPageParameters(std::shared_ptr&lt;plstream&gt;&amp; pls) {
 	pls->setopt("dpi", dpi.str().c_str());
 }
-void Page::calculateXMargin(PlotCommon::Orientation& orientation,
-		PlotCommon::Dimension& dimension) {
-	if (_xMargin != -1) {
-		return;
-	}
-
+void Page::calculateRelativeXMargin(PlotCommon::Orientation& orientation,
+		PlotCommon::Dimension& dimension, float xMarginInMm) {
 	float xlengthInMm;
 	switch (dimension) {
 	case PlotCommon::Dimension::US_letter:
@@ -345,17 +361,11 @@ void Page::calculateXMargin(PlotCommon::Orientation&amp; orientation,
 			xlengthInMm = Page::A4_Y_LENGTH_IN_MM;
 		}
 	}
-	// default xmargin in mm, return margin as relative coordinate
-	_xMargin = DefaultPlotConfiguration::getInstance()._defaultPage._xMargin
-			/ xlengthInMm;
+	_xMargin = xMarginInMm / xlengthInMm;
 }
-void Page::calculateYMargin(PlotCommon::Orientation& orientation,
-		PlotCommon::Dimension& dimension) {
-	if (_yMargin != -1) {
-		return;
-	}
-
+void Page::calculateRelativeYMargin(PlotCommon::Orientation& orientation,
+		PlotCommon::Dimension& dimension, float yMarginInMm) {
 	float ylengthInMm;
 	switch (dimension) {
 	case PlotCommon::Dimension::US_letter:
@@ -373,9 +383,7 @@ void Page::calculateYMargin(PlotCommon::Orientation&amp; orientation,
 			ylengthInMm = Page::A4_X_LENGTH_IN_MM;
 		}
 	}
-	// default xmargin in mm, return margin as relative coordinate
-	_yMargin = DefaultPlotConfiguration::getInstance()._defaultPage._yMargin
-			/ ylengthInMm;
+	_yMargin = yMarginInMm / ylengthInMm;
 }
 std::ostream& operator <<(std::ostream& out, Page& page) {
@@ -166,17 +166,17 @@ public:
 	 */
 	bool _superposeMode;
+	void calculateRelativeXMargin(PlotCommon::Orientation& orientation,
+				PlotCommon::Dimension& dimension, float xMarginInMm);
+	void calculateRelativeYMargin(PlotCommon::Orientation& orientation,
+				PlotCommon::Dimension& dimension, float yMarginInMm);
+
 private:
 	void initPageParameters(std::shared_ptr<plstream>& pls);
 	void writeCopywrite(std::shared_ptr<plstream>& pls);
-	void calculateXMargin(PlotCommon::Orientation& orientation,
-			PlotCommon::Dimension& dimension);
-	void calculateYMargin(PlotCommon::Orientation& orientation,
-			PlotCommon::Dimension& dimension);
-
 };
 std::ostream& operator <<(std::ostream& out, Page& page);
@@ -19,6 +19,7 @@ namespace plot {
 PlotNode::PlotNode() :
 		NodeGrpCfg() {
 	getChildList()["outputStructure"] = AMDA::XMLConfigurator::NodeCfgSPtr(new OutputStructureNode());
+	getChildList()["filePrefix"] = AMDA::XMLConfigurator::NodeCfgSPtr(new FilePrefixNode());
 	getChildList()["page"] = AMDA::XMLConfigurator::NodeCfgSPtr(new PageNode());
 	getChildList()["postProcess"] = AMDA::XMLConfigurator::NodeCfgSPtr(
 			new postprocessing::PostProcessingNode<PlotOutput>());
@@ -55,4 +56,14 @@ void OutputStructureNode::proceed(xmlNodePtr pNode,
 				(const char*) pNode->children->content);
 	}
+void FilePrefixNode::proceed(xmlNodePtr pNode,
+			const AMDA::Parameters::CfgContext& pContext) {
+		LOG4CXX_DEBUG(gLogger, "FilePrefixNode::proceed")
+
+		PlotOutput* lPlotOutput =
+				pContext.get<PlotOutput*>();
+		lPlotOutput->setFilePrefix(
+				(const char*) pNode->children->content);
+}
+
 } /* namespace plot */
@@ -30,5 +30,16 @@ public:
 			const AMDA::Parameters::CfgContext& pContext);
 };
+/**
+ * @class FilePrefixNode
+ * @brief read the "filePrefix" node.
+ */
+class FilePrefixNode: public AMDA::XMLConfigurator::NodeCfg {
+public:
+	void proceed(xmlNodePtr pNode,
+			const AMDA::Parameters::CfgContext& pContext);
+};
+
+
 } /* namespace plot */
 #endif /* PLOTNODE_HH_ */
@@ -17,7 +17,7 @@ namespace plot {
 PlotOutput::PlotOutput(AMDA::Parameters::ParameterManager& pParameterManager) :
 		AMDA::Parameters::VisitorOfParamData(), ParamOutput(pParameterManager),
-		_currentParamId(""), _outputStructure(OutputStructure::ONE_FILE_PER_INTERVAL) {
+		_currentParamId(""), _outputStructure(OutputStructure::ONE_FILE_PER_INTERVAL), _filePrefix("plot") {
 }
@@ -151,9 +151,9 @@ void PlotOutput::initNewPage(int intervalIndex)
 	if ((_timeIntervalList->size() > 1) &&
 		(_outputStructure == OutputStructure::ONE_FILE_PER_INTERVAL) &&
 		!_page->_superposeMode)
-		plotFilePrefix << "plot_" << intervalIndex << "_";
+		plotFilePrefix << _filePrefix << "_" << intervalIndex << "_";
 	else
-		plotFilePrefix << "plot_";
+		plotFilePrefix << _filePrefix << "_";
 	//draw page
 	_page->draw(_pls, newFile, plotFilePrefix.str().c_str());
@@ -70,6 +70,15 @@ public:
 		}
 	}
+	/**
+	 * @brief sets the file prefix to use.
+	 */
+		void setFilePrefix(const std::string& filePrefix)
+		{
+			LOG4CXX_DEBUG(gLogger,"PlotOutput::setFilePrefix " << filePrefix);
+			_filePrefix = filePrefix;
+		}
+
 	AMDA::Parameters::ParameterManager& getParameterManager(){
 		return _parameterManager;
 	}
@@ -270,6 +279,11 @@ private:
 	 * Files to output, default is ONE_FILE_PER_INTERVAL
 	 */
 	OutputStructure _outputStructure;
+
+	/**
+	 * File prefix to use
+	 */
+	std::string _filePrefix;
 };
 } /* namespace plot */