CDPP / AMDA_Kernel

Blame view

src/ParamOutputImpl/Plot/TickPlot/TickMarkDecorator.hh 3.71 KB
Edit Raw Normal View History
fbe3c2bb   Benjamin Renard   First commit 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
/*
 * TickMarkDecorator.hh
 *
 *  Created on: Dec 18, 2013
 *      Author: amdadev
 */

#ifndef TICKMARKDECORATOR_HH_
#define TICKMARKDECORATOR_HH_

#include <boost/smart_ptr/shared_ptr.hpp>
#include <iosfwd>

#include "plplot/plplot.h"
#include <map>

#include "plplot/plstream.h"


#include "TimeAxisDecorator.hh"

using std::map;

namespace plot {
fbe3c2bb   Benjamin Renard   First commit 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
struct SeriesInfo{
	/**
	 * @brief name of that series (i.e. name of parameter and index if not a scalar parameter).
	 */
	std::string _name;
	/**
	 * @brief maximum len for name.
	 */
	unsigned int _maxLen;
	/**
	 * @brief format string used to format series values.
	 */
	std::string _valuesFormat;
	/**
	 * @brief maximum len for value. May be useful to justify formatted output.
	 */
	unsigned int _maxValueLen;
225ac17f   Benjamin Renard   Fix tickmarks plot 
43
fbe3c2bb   Benjamin Renard   First commit 
44
 
	/**
225ac17f   Benjamin Renard   Fix tickmarks plot 
45
 
	 * @brief to know if it's the first label to draw
fbe3c2bb   Benjamin Renard   First commit 
46
 
	 */
225ac17f   Benjamin Renard   Fix tickmarks plot 
47
48
 
	bool _isFirstLabel;
fbe3c2bb   Benjamin Renard   First commit 
49
 
	/**
225ac17f   Benjamin Renard   Fix tickmarks plot 
50
 
	 * @brief link to the parameter data
fbe3c2bb   Benjamin Renard   First commit 
51
 
	 */
225ac17f   Benjamin Renard   Fix tickmarks plot 
52
53
54
55
56
57
 
	ParameterData* _parameterData;

	/**
	 * @brief serie components
	 */
	AMDA::Common::ParameterIndexComponent _indexComponents;
fbe3c2bb   Benjamin Renard   First commit 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
};

typedef std::vector<boost::shared_ptr<SeriesInfo>> SeriesList;

struct TimeInfo{

	/**
	 * @brief time format in label
	 */
	std::string _timeFormat;

	/**
	 * @brief time axis title.
	 */
	std::string _timeTitle;
	/**
	 * @brief maximum length for name.
	 */
	unsigned int _maxLen;
	/**
225ac17f   Benjamin Renard   Fix tickmarks plot 
78
 
	 * @brief to know if it's the first label to draw
fbe3c2bb   Benjamin Renard   First commit 
79
 
	 */
225ac17f   Benjamin Renard   Fix tickmarks plot 
80
 
	bool _isFirstLabel;
fbe3c2bb   Benjamin Renard   First commit 
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
};
typedef boost::shared_ptr<TimeInfo> TimeInfoPtr;

/**
 * @brief decorator used when tickmarks label are needed for a time graph.
 */
class TickMarkDecorator: public TimeAxisDecorator {
public:
	TickMarkDecorator(bool isStandalone, PanelPlotOutput* decoratorPlot);

	TickMarkDecorator(const TickMarkDecorator& ref_ );

	TickMarkDecorator& operator=(const TickMarkDecorator& ref_);

	virtual ~TickMarkDecorator();

	void setValuesFormat( const std::string &format_){
		_valuesFormat = format_;
	}
	const std::string& getValuesFormat() const{
		return _valuesFormat;
	}

	/**
	 * Overrides XAxisDecorator::updatePlotArea
	 */
	void updatePlotArea(PanelPlotOutput* pplot_, Axis* axis_, Bounds& bounds_);

	/**
	 * Overrides XAxisDecorator::configure
	 */
	void configure(PanelPlotOutput* pplot_, Axis* axis_, double start_, double stop_,
			std::map<std::string, ParameterData> *pParameterValues);

	/**
	 * Overrides XAxisDecorator::draw
	 * @brief Draws tickmark on given time axis
	 */
	void draw(PanelPlotOutput* pplot_, Axis* axis_, std::shared_ptr<plstream> pls_);

protected:
	/**
	 * Overrides TimeAxisDecorator::installLabelGenerator.
	 */
	void installLabelGenerator(PanelPlotOutput* pplot_, TimeAxis* axis_);

private:

	/**
fbe3c2bb   Benjamin Renard   First commit 
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
 
	 * @brief Calculates plot area for date display
	 */
	double computeStartDateWidth(PanelPlotOutput* pplot_, TimeAxis* pAxis_);

	/**
	 * @brief A logger for tick plot decorator
	 */
	static log4cxx::LoggerPtr _logger;
	
	/**
	 * @brief Some time properties that are used by time label generator
	 */
	TimeInfoPtr _pTimeInfo;
	
	/**
	 * @brief Series info that are used by Y label generators
	 */
	SeriesList _seriesInfoList;
	
	/**
	 * @brief A format for value display (see sprintf format)
	 */
	std::string _valuesFormat;
	
	/**
	 * @brief maximum length for formatted value.
	 */
	unsigned int _maxValueLen;

	/**
	 * @brief Single or multi plot
	 */
	bool _isStandalone;

	/**
	 * @brief Plot that owns parameter values.
	 */
	PanelPlotOutput* _decoratorPlot;

};

/**
 * @brief Custom generator for time label, just not display min time.
 */
void generateOrbitTimeLabel(PLINT axis, PLFLT value, char *label, PLINT length,
		PLPointer data);
/**
 * @brief Custom generator for a tick serie (one per serie).
 */
void generateYLabel(PLINT axis, PLFLT value, char *label, PLINT length,
		PLPointer data);
} /* namespace plot */

#endif /* TICKMARKDECORATOR_HH_ */