CDPP / AMDA_Kernel

Blame view

src/ParamOutputImpl/Plot/PlotOutput.hh 8.12 KB
Edit Raw Normal View History
fbe3c2bb   Benjamin Renard   First commit 
1
2
3
4
5
6
7
8
9
10
11
12
13
 
/*
 * PlotOutput.hh
 *
 *  Created on: 28 oct. 2013
 *      Author: CS
 */

#ifndef PLOTOUTPUT_HH_
#define PLOTOUTPUT_HH_

#include "ParamOutput.hh"
#include "Page.hh"
#include "PanelPlotOutput.hh"
8499fbdd   Benjamin Renard   Context file gene... 
14
 
#include "ContextFileWriter.hh"
fbe3c2bb   Benjamin Renard   First commit 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 

#include <vector>
#include <memory>

namespace plot {

enum OutputStructure {
	ONE_FILE, ONE_FILE_PER_INTERVAL
};

class PlotOutput: public AMDA::Parameters::VisitorOfParamData,
	public AMDA::Parameters::ParamOutput {
public:
	PlotOutput(AMDA::Parameters::ParameterManager& pParameterManager);
	virtual ~PlotOutput();

	/**
	 * @overload DataClient::establishConnection()
	 */
	virtual void establishConnection();

	/**
	 * @overload ParamOutput::apply()
	 */
	virtual void apply();

	/**
	 * @brief Adds a plot to the plot list.
	 */
	void addPlot(boost::shared_ptr<PanelPlotOutput> plot) {
		_plots.push_back(plot);
	}

	/**
8499fbdd   Benjamin Renard   Context file gene... 
49
50
51
52
53
54
55
 
	 * @brief Set option to write the context file
	 */
	void setWriteContextFile(bool writeContextFile) {
		_writeContextFile = writeContextFile;
	}

	/**
ba13030d   Menouard AZIB   Add attribute 'wr... 
56
57
58
59
60
61
62
63
 
	 * @brief Set option to write the data file
	 */
	void setWriteDataFile(bool writeDataFile_)
	{
		writeDataFile = writeDataFile_;
	}

	/**
fbe3c2bb   Benjamin Renard   First commit 
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
 
	 * @brief Gets a list of plots on the same panel
	 */
	std::vector<boost::shared_ptr<PanelPlotOutput>> getPlots(Panel* panel_);

	/**
	 * @brief Sets the page configuration
	 */
	void setPage(boost::shared_ptr<Page> page) {
		_page = page;
	}


	/**
	 * @brief sets the output structure (one file, one file per interval).
	 */
	void setOutputStructure(const std::string& pstructure)
	{
		LOG4CXX_DEBUG(gLogger,"PlotOutput::setOutputStructure " << pstructure);
		if (pstructure == "one-file") {
			_outputStructure = OutputStructure::ONE_FILE;
		} else if (pstructure == "one-file-per-interval") {
			_outputStructure = OutputStructure::ONE_FILE_PER_INTERVAL;
		}
	}
8d19d171   Benjamin Renard   Fix bug with rela... 
89
90
91
92
93
94
95
96
97
 
	/**
	 * @brief sets the file prefix to use.
	 */
		void setFilePrefix(const std::string& filePrefix)
		{
			LOG4CXX_DEBUG(gLogger,"PlotOutput::setFilePrefix " << filePrefix);
			_filePrefix = filePrefix;
		}
87088471   Benjamin Renard   Use file prefix f... 
98
99
100
101
102
103
104
 
		/**
		 * @brief sets the file prefix to use.
		*/
		std::string& getFilePrefix()
		{
			return _filePrefix;
		}
fbe3c2bb   Benjamin Renard   First commit 
105
106
107
108
 
	AMDA::Parameters::ParameterManager& getParameterManager(){
		return _parameterManager;
	}
7578a549   Benjamin Renard   Add boolean suppo... 
109
110
111
112
113
114
115
116
117
 
	template<typename Type>
	void scalarVisit(AMDA::Parameters::ParamDataSpec<Type> * pParamData);

	template<typename Type>
	void vectorVisit(AMDA::Parameters::ParamDataSpec<std::vector<Type>> * pParamData);

	template<typename Type>
	void tab2DVisit(AMDA::Parameters::ParamDataSpec<AMDA::Parameters::Tab2DData<Type> > * pParamData);
fbe3c2bb   Benjamin Renard   First commit 
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
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
 
	/**
	 * @overload VisitorOfParamData::visit(AMDA::Parameters::ParamDataScalaireShort *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataScalaireShort *);

	/**
	 * @overload VisitorOfParamData::visit(AMDA::Parameters::ParamDataScalaireFloat *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataScalaireFloat *);

	/**
	 * @overload VisitorOfParamData::visit(AMDA::Parameters::ParamDataScalaireDouble *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataScalaireDouble *);

	/**
	 * @overload VisitorOfParamData::visit(AMDA::Parameters::ParamDataScalaireLongDouble *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataScalaireLongDouble *);

	/**
	 * @overload VisitorOfParamData::visit(AMDA::Parameters::ParamDataScalaireInt *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataScalaireInt *);

	/**
	 * @overload VisitorOfParamData::visit(AMDA::Parameters::ParamDataLogicalData *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataLogicalData *);

	/**
	 * @overload VisitorOfParamData::visit(AMDA::Parameters::ParamDataTab1DShort *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataTab1DShort *);

	/**
	 * @overload VisitorOfParamData::visit(AMDA::Parameters::ParamDataTab1DFloat *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataTab1DFloat *);

	/**
	 * @overload VisitorOfParamData::visit(AMDA::Parameters::ParamDataTab1DDouble *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataTab1DDouble *);

	/**
	 * @overload VisitorOfParamData::visit(AMDA::Parameters::ParamDataTab1DLongDouble *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataTab1DLongDouble *);

	/**
	 * @overload VisitorOfParamData::visit(AMDA::Parameters::ParamDataTab1DInt *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataTab1DInt *);

	/**
	 * @overload VisitorOfParamData::visit(AMDA::Parameters::ParamDataTab1DLogicalData *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataTab1DLogicalData *);

	/**
	 * @overload VisitorOfParamData::visit(ParamDataTab2DShort *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataTab2DShort *);

	/**
	 * @overload VisitorOfParamData::visit(ParamDataTab2DFloat *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataTab2DFloat *);

	/**
	 * @overload VisitorOfParamData::visit(ParamDataTab2DDouble *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataTab2DDouble *);

	/**
	 * @overload VisitorOfParamData::visit(ParamDataTab2DLongDouble *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataTab2DLongDouble *);

	/**
	 * @overload VisitorOfParamData::visit(ParamDataTab2DInt *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataTab2DInt *);

	/**
	 * @overload VisitorOfParamData::visit(ParamDataTab2DLogicalData *)
	 */
	virtual void visit(AMDA::Parameters::ParamDataTab2DLogicalData *);

protected:
	/**
	 * @overload ParamOutput::init()
	 */
	virtual void init();

	/**
	 * Gets parameter value from server and stores them into dedicated
	 * structure.
	 */
	virtual void getDataFromServer();


	/**
	 * @brief Compute panel position depending on the page layout
	 */
	virtual void computePanelBounds (void);

	/**
	 * @brief Compute panel plot area position depending on the panel constraints
	 */
	virtual void computePanelPlotAreaBounds (void);

	/**
abded81c   Benjamin Renard   Plot area alignme... 
232
233
234
235
236
 
	 * @brief Compute panel plot area position for manual layout
	 */
	virtual void computePanelPlotAreaBoundsForManualLayout(void);

	/**
12353568   Benjamin Renard   Add layout proper... 
237
238
239
240
241
 
 	 * @brief Fix time axes visibility in relation with the request
 	 */
	virtual void fixPanelTimeAxesVisibility(void);

	/**
fbe3c2bb   Benjamin Renard   First commit 
242
243
244
245
246
247
248
249
 
	 * @brief Compute legend position depending on the panel constraints
	 */
	virtual void computePanelLegendPosition (void);

private:
	/**
	 * @brief Init new page - Create also the new file if necessary
	 */
87088471   Benjamin Renard   Use file prefix f... 
250
 
	bool initNewPage(int intervalIndex, std::string& ttName);
fbe3c2bb   Benjamin Renard   First commit 
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
 

	/*
	 * @brief Sequence to draw one interval by page
	 */
	void drawOneIntervalByPage();

	/*
	 * @brief Sequence to draw all intervals in one page
	 */
	void drawAllIntervalsInOnePage();

	/**
	 * @brief Get the list of indexes used for a vector parameter
	 */
	template<typename Type>
	std::vector<AMDA::Common::ParameterIndexComponent> getParamUsedIndexes(std::string paramId, AMDA::Parameters::ParamDataSpec<std::vector<Type>>* pParamData);

	/**
	 * @brief Get the list of indexes used for a Tab2D parameter
	 */
	template<typename Type>
	std::vector<AMDA::Common::ParameterIndexComponent> getParamUsedIndexes(std::string paramId, AMDA::Parameters::ParamDataSpec<AMDA::Parameters::Tab2DData<Type>>* pParamData);

	/**
	 * @brief Get parameter gap size
	 */
	template<class ParamData>
	double getParamGapSize(std::string paramId, ParamData* pParamData);

	/**
8499fbdd   Benjamin Renard   Context file gene... 
281
282
283
284
285
 
	 * @brief Option to know if the context file must be write
	 */
	bool _writeContextFile;

	/**
ba13030d   Menouard AZIB   Add attribute 'wr... 
286
287
288
 
	 * @brief Flag to store the 'writeDataFile' value
	 *
	 */
b77e7fc1   Menouard AZIB   add a virtual wri... 
289
 
	bool writeDataFile;
ba13030d   Menouard AZIB   Add attribute 'wr... 
290
291
 

	/**
8499fbdd   Benjamin Renard   Context file gene... 
292
293
294
295
296
 
	 * @brief Context file writer
	 */
	ContextFileWriter _contextWriter;

	/**
fbe3c2bb   Benjamin Renard   First commit 
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
	 * @brief Main container
	 */
	boost::shared_ptr<Page> _page;

	/**
	 * @brief List of plots
	 */
	std::vector<boost::shared_ptr<PanelPlotOutput>> _plots;

	/**
	 * @brief List of all the plot outputs
	 */
	std::vector<std::string> _outputs;

	/**
	 * @brief PLplot stream
	 */
	std::shared_ptr<plstream> _pls;

	/**
	 * Parameter instance (hold values) for each sampling value
	 */
	std::list<std::string> _usedParametersId;

	/**
	 * @brief Parameter values by component indexed on paramId
	 */
	std::map<std::string, ParameterData> _parameterValues;

	/**
	 * @brief Currently managed paramId in apply method (for visitor)
	 */
	std::string _currentParamId;

	/**
	 * Files to output, default is ONE_FILE_PER_INTERVAL
	 */
	OutputStructure _outputStructure;
8d19d171   Benjamin Renard   Fix bug with rela... 
335
336
337
338
339
 

	/**
	 * File prefix to use
	 */
	std::string _filePrefix;
fbe3c2bb   Benjamin Renard   First commit 
340
341
342
343
 
};

} /* namespace plot */
#endif /* PLOTOUTPUT_HH_ */