comparison trunk/src/Modules/Output/Graphics/GraphAxisSpec.h @ 398:3ee03a6b95a0

- All \t to two spaces (style guide compliance)
author tomwalters
date Fri, 15 Oct 2010 05:46:53 +0000
parents 7a573750b186
children 7bfed53caacf
comparison
equal deleted inserted replaced
397:7a573750b186 398:3ee03a6b95a0
24 /*! \class GraphAxisSpec "Output/GraphAxisSpec.h" 24 /*! \class GraphAxisSpec "Output/GraphAxisSpec.h"
25 * \brief Axis specification for a GraphicsView 25 * \brief Axis specification for a GraphicsView
26 */ 26 */
27 class GraphAxisSpec { 27 class GraphAxisSpec {
28 public: 28 public:
29 /*! \brief Create a new GraphAxisSpec 29 /*! \brief Create a new GraphAxisSpec
30 * \param fMin Minimum value on the axis to show 30 * \param fMin Minimum value on the axis to show
31 * \param fMax Maximum value on the axis to show 31 * \param fMax Maximum value on the axis to show
32 * \param iScale Scale to use 32 * \param iScale Scale to use
33 * 33 *
34 * Please see SetScale() and SetRange() for more details. 34 * Please see SetScale() and SetRange() for more details.
35 */ 35 */
36 GraphAxisSpec(float fMin, float fMax, Scale::ScaleType iScale); 36 GraphAxisSpec(float fMin, float fMax, Scale::ScaleType iScale);
37 //! \brief Create a new GraphAxisSpec from defaults 37 //! \brief Create a new GraphAxisSpec from defaults
38 GraphAxisSpec(); 38 GraphAxisSpec();
39 39
40 ~GraphAxisSpec(); 40 ~GraphAxisSpec();
41 41
42 /*! \brief Set the scale to use 42 /*! \brief Set the scale to use
43 * \param iScale Scale to use 43 * \param iScale Scale to use
44 */ 44 */
45 void SetDisplayScale(Scale::ScaleType iScale); 45 void SetDisplayScale(Scale::ScaleType iScale);
46 /*! \brief Set the minumum and maximum values to show on the axis 46 /*! \brief Set the minumum and maximum values to show on the axis
47 * \param fMin Minimum value on the axis to show 47 * \param fMin Minimum value on the axis to show
48 * \param fMax Maximum value on the axis to show 48 * \param fMax Maximum value on the axis to show
49 * 49 *
50 * Either fMin _must_ be smaller than fMax, or fMin==fMax but then 50 * Either fMin _must_ be smaller than fMax, or fMin==fMax but then
51 * this function must be called later to fulfil the former condition 51 * this function must be called later to fulfil the former condition
52 * before it is used to scale data. 52 * before it is used to scale data.
53 */ 53 */
54 void SetDisplayRange(float fMin, float fMax); 54 void SetDisplayRange(float fMin, float fMax);
55 /*! \brief Set the label of this axis 55 /*! \brief Set the label of this axis
56 * \param sLabel New label, or NULL to remove label 56 * \param sLabel New label, or NULL to remove label
57 */ 57 */
58 void SetLabel(const char *sLabel); 58 void SetLabel(const char *sLabel);
59 59
60 /*! \brief Read axis specification from parameter store 60 /*! \brief Read axis specification from parameter store
61 * \param pParam Parameter store to read from 61 * \param pParam Parameter store to read from
62 * \param sPrefix Prefix to use, e.g. "view.x" 62 * \param sPrefix Prefix to use, e.g. "view.x"
63 * \param fMin Default minumum value for 'auto' 63 * \param fMin Default minumum value for 'auto'
64 * \param fMax Default maximum value for 'auto' 64 * \param fMax Default maximum value for 'auto'
65 * \param iScale Default scale for 'auto' 65 * \param iScale Default scale for 'auto'
66 * \return true if no error occured in reading 66 * \return true if no error occured in reading
67 */ 67 */
68 bool Initialize(Parameters *pParam, 68 bool Initialize(Parameters *pParam,
69 const char *sPrefix, 69 const char *sPrefix,
70 float fMin, 70 float fMin,
71 float fMax, 71 float fMax,
72 Scale::ScaleType iScale); 72 Scale::ScaleType iScale);
73 73
74 protected: 74 protected:
75 //! \brief Minimum value on the axis to display 75 //! \brief Minimum value on the axis to display
76 float m_fMin; 76 float m_fMin;
77 //! \brief Maximum value on the axis to display 77 //! \brief Maximum value on the axis to display
78 float m_fMax; 78 float m_fMax;
79 //! \brief Scale to use 79 //! \brief Scale to use
80 Scale *m_pScale; 80 Scale *m_pScale;
81 //! \brief Axis label, NULL for no label 81 //! \brief Axis label, NULL for no label
82 const char *m_sLabel; 82 const char *m_sLabel;
83 83
84 friend class GraphicsView; 84 friend class GraphicsView;
85 friend class GraphicsViewTime; 85 friend class GraphicsViewTime;
86 }; 86 };
87 87
88 #endif /* __GRAPH_AXIS_SPEC_H__ */ 88 #endif /* __GRAPH_AXIS_SPEC_H__ */