JKQtPlotter/lib/jkqtplotter/graphs/jkqtpimpulses.h

/*
    Copyright (c) 2008-2024 Jan W. Krieger (<jan@jkrieger.de>)

    

    This software is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License (LGPL) as published by
    the Free Software Foundation, either version 2.1 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License (LGPL) for more details.

    You should have received a copy of the GNU Lesser General Public License (LGPL)
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef jkqtpgraphsimpulses_H
#define jkqtpgraphsimpulses_H

#include "jkqtplotter/jkqtplotter_imexport.h"
#include "jkqtplotter/jkqtpgraphsbase.h"
#include "jkqtplotter/jkqtpgraphsbaseerrors.h"
#include "jkqtplotter/jkqtpgraphsbasestylingmixins.h"



/** \brief This is a base class for all impulse graphs
 *  \ingroup jkqtplotter_sticks
 *
 *  \image html JKQTPImpulsesVerticalGraph.png "default style for impulse graphs"
 *
 *  \image html JKQTPImpulsesVerticalGraph_Symbols.png  "setDrawSymbols(true);"
 *
 *  \image html JKQTPImpulsesVerticalGraphBaseline.png "setDrawBaseline(true);"
 *
 *  \see JKQTPImpulsesHorizontalGraph, JKQTPImpulsesVerticalGraph
 */
class JKQTPLOTTER_LIB_EXPORT JKQTPImpulsesGraphBase: public JKQTPXYBaselineGraph, public JKQTPGraphLineStyleMixin, public JKQTPGraphSymbolStyleMixin{
    Q_OBJECT
public:
    /** \brief class constructor */
    JKQTPImpulsesGraphBase(JKQTBasePlotter* parent=nullptr);


    /** \brief returns the color to be used for the key label */
    virtual QColor getKeyLabelColor() const override;
    /** \copydoc drawSymbols */
    bool getDrawSymbols() const;
    /** \copydoc m_drawBaseline */
    bool getDrawBaseline() const;
    /** \copydoc m_baselineStyle */
    JKQTPGraphLineStyleMixin &baselineStyle();
    /** \copydoc m_baselineStyle */
    const JKQTPGraphLineStyleMixin& baselineStyle() const;


public Q_SLOTS:
    /** \brief color of symbols and impulses in one call  */
    virtual void setColor(QColor c);

    /** \copydoc drawSymbols */
    void setDrawSymbols(bool __value);
    /** \copydoc m_drawBaseline */
    void setDrawBaseline(bool __value);

protected:

    /** \brief indicates whether to draw symbols at the top of the impulse
     *
     * \image html JKQTPImpulsesVerticalGraph_Symbols.png "setDrawSymbols(true)"
     */
    bool drawSymbols;
    /** \brief if m_drawBaseline \c ==true then this style is used to draw the baseline
     *
     *  \see baselineStyle() , setDrawBaseline() , m_drawBaseline
     */
    JKQTPGraphLineStyleMixin m_baselineStyle;
    /** \brief indicates whether to draw a line with style m_baselineStyle at the baseline-value
     *
     * \image html JKQTPImpulsesVerticalGraphBaseline.png "setDrawBaseline(true);"
     * \image html JKQTPImpulsesVerticalGraphNoBaseline.png "setDrawBaseline(false);"
     *
     *  \see baselineStyle() , setDrawBaseline() , m_baselineStyle
     */
    bool m_drawBaseline;

    /** \brief get the maximum and minimum value in the impulse-elongation (i.e. value) direction of the graph
     *
     * The result is given in the two parameters which are call-by-reference parameters!
     */
    bool getValuesMinMax(double& mmin, double& mmax, double& smallestGreaterZero) ;
    /** \brief get the maximum and minimum value of the impulse positions of the graph
     *
     * The result is given in the two parameters which are call-by-reference parameters!
     */
    bool getPositionsMinMax(double& mmin, double& mmax, double& smallestGreaterZero) ;

};


/** \brief This implements an impulse plot with horizontal impulses in direction of the X axis (i.e. from x=0 to x=f(y) )
 *  \ingroup jkqtplotter_sticks
 *
 *  \image html JKQTPImpulsesHorizontalGraph.png
 *
 *  \see JKQTPImpulsesVerticalGraph, \ref JKQTPlotterImpulsePlots
 */
class JKQTPLOTTER_LIB_EXPORT JKQTPImpulsesHorizontalGraph: public JKQTPImpulsesGraphBase {
    Q_OBJECT
public:
    /** \brief class constructor */
    JKQTPImpulsesHorizontalGraph(JKQTBasePlotter* parent=nullptr);
    /** \brief class constructor */
    JKQTPImpulsesHorizontalGraph(JKQTPlotter* parent);

    /** \brief plots the graph to the plotter object specified as parent */
    virtual void draw(JKQTPEnhancedPainter& painter) override;
    /** \brief plots a key marker inside the specified rectangle \a rect */
    virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override;
    /** \brief returns the column used as "key" for the current graph (typically this call getXColumn(), but for horizontal graphs like filled curves or barcharts it may call getYColumn() ) */
    virtual int getKeyColumn() const override;
    /** \brief returns the column used as "value" for the current graph (typically this call getXColumn(), but for horizontal graphs like filled curves or barcharts it may call getYColumn() ) */
    virtual int getValueColumn() const override;


    /** \copydoc JKQTPPlotElement::getXMinMax() */
    virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
    /** \copydoc JKQTPPlotElement::getYMinMax() */
    virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;

public Q_SLOTS:
    /** \brief sets the column used as "key" for the current graph (typically this call setXColumn(), but for horizontal graphs like filled curves or barcharts it may call setYColumn() ) */
    virtual void setKeyColumn(int __value) override;
    /** \brief sets the column used as "value" for the current graph (typically this call setXColumn(), but for horizontal graphs like filled curves or barcharts it may call setYColumn() ) */
    virtual void setValueColumn(int __value) override;

protected:
};



/** \brief This implements an impulse plot with horizontal impulses in direction of the X axis (i.e. from x=0 to x=f(y) )
 *  \ingroup jkqtplotter_sticks
 *
 *  \image html JKQTPImpulsesHorizontalErrorGraph.png
 *
 *  \see jkqtpstatAddXErrorImpulsesGraph(), JKQTPImpulsesHorizontalGraph, \ref JKQTPlotterImpulsePlots
 */
class JKQTPLOTTER_LIB_EXPORT JKQTPImpulsesHorizontalErrorGraph: public JKQTPImpulsesHorizontalGraph, public JKQTPXGraphErrors {
        Q_OBJECT
    public:
        /** \brief class constructor */
        JKQTPImpulsesHorizontalErrorGraph(JKQTBasePlotter* parent=nullptr);
        JKQTPImpulsesHorizontalErrorGraph(JKQTPlotter* parent);
        /** \copydoc JKQTPGraph::usesColumn() */
        virtual bool usesColumn(int c) const override;

        /** \copydoc JKQTPPlotElement::getXMinMax() */
        virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;

        /** \brief returns the column that contains the bar height errors */
        int getErrorColumn() const;
        /** \brief returns the column that contains the lower bar height errors */
        int getErrorColumnLower() const;
        /** \brief returns the error style of the bar */
        JKQTPErrorPlotstyle getErrorStyle() const;
        /** \brief returns whether the errors of the bars are symmetric */
        bool getErrorSymmetric() const;

    public Q_SLOTS:
        /** \brief sets whether the errors of the bars are symmetric */
        void setErrorSymmetric(bool __value);
        /** \brief sets the error style of the bar */
        void setErrorStyle(JKQTPErrorPlotstyle  __value);
        /** \brief sets the column that contains the bar height errors */
        void setErrorColumn(int column) ;

        /** \brief sets the column that contains the bar height errors */
        void setErrorColumn(size_t column) ;
        /** \brief sets the column that contains the bar height errors */
        void setErrorColumnLower(int column) ;

        /** \brief sets the column that contains the bar height errors */
        void setErrorColumnLower(size_t column) ;
    protected:
        /** \brief this function is used to plot error inidcators before plotting the graphs. */
        virtual void drawErrorsAfter(JKQTPEnhancedPainter& painter) override ;

};




/*! \brief This implements an impulse plot with impulses in direction of the Y axis (i.e. from y=0 to y=f(x) )
    \ingroup jkqtplotter_sticks

    \image html JKQTPImpulsesVerticalGraph.png
    \image html JKQTPImpulsesVerticalGraph_Symbols.png "generated by setting setDrawSymbols(true)"

    \see JKQTPImpulsesGraphBase, JKQTPImpulsesVerticalErrorGraph, \ref JKQTPlotterImpulsePlots
 */
class JKQTPLOTTER_LIB_EXPORT JKQTPImpulsesVerticalGraph: public JKQTPImpulsesGraphBase {
        Q_OBJECT
    public:
        /** \brief class constructor */
        JKQTPImpulsesVerticalGraph(JKQTBasePlotter* parent=nullptr);
        /** \brief class constructor */
        JKQTPImpulsesVerticalGraph(JKQTPlotter* parent);

        /** \brief plots the graph to the plotter object specified as parent */
        virtual void draw(JKQTPEnhancedPainter& painter) override;
        /** \brief plots a key marker inside the specified rectangle \a rect */
        virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override;
        /** \copydoc JKQTPPlotElement::getXMinMax() */
        virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
        /** \copydoc JKQTPPlotElement::getYMinMax() */
        virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
};



/*! \brief This implements an impulse plot with impulses in direction of the X axis (i.e. from x=0 to x=f(y) )
    \ingroup jkqtplotter_sticks

    \image html JKQTPImpulsesVerticalErrorGraph.png

    \see JKQTPImpulsesVerticalGraph, jkqtpstatAddYErrorImpulsesGraph(), \ref JKQTPlotterImpulsePlots
 */
class JKQTPLOTTER_LIB_EXPORT JKQTPImpulsesVerticalErrorGraph: public JKQTPImpulsesVerticalGraph, public JKQTPYGraphErrors {
        Q_OBJECT
    public:
        /** \brief class constructor */
        JKQTPImpulsesVerticalErrorGraph(JKQTBasePlotter* parent=nullptr);
        /** \brief class constructor */
        JKQTPImpulsesVerticalErrorGraph(JKQTPlotter* parent);
        /** \copydoc JKQTPGraph::usesColumn() */
        virtual bool usesColumn(int c) const override;
        /** \copydoc JKQTPXYGraph::getYMinMax() */
        virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;

        /** \brief returns the column that contains the bar height errors */
        int getErrorColumn() const;
        /** \brief returns the column that contains the lower bar height errors */
        int getErrorColumnLower() const;
        /** \brief returns the error style of the bar */
        JKQTPErrorPlotstyle getErrorStyle() const;
        /** \brief returns whether the errors of the bars are symmetric */
        bool getErrorSymmetric() const;

    public Q_SLOTS:
        /** \brief sets whether the errors of the bars are symmetric */
        void setErrorSymmetric(bool __value);
        /** \brief sets the error style of the bar */
        void setErrorStyle(JKQTPErrorPlotstyle  __value);
        /** \brief sets the column that contains the bar height errors */
        void setErrorColumn(int column) ;

        /** \brief sets the column that contains the bar height errors */
        void setErrorColumn(size_t column) ;
        /** \brief sets the column that contains the bar height errors */
        void setErrorColumnLower(int column) ;

        /** \brief sets the column that contains the bar height errors */
        void setErrorColumnLower(size_t column);
    protected:
        /** \brief this function is used to plot error inidcators before plotting the graphs. */
        virtual void drawErrorsAfter(JKQTPEnhancedPainter& painter) override ;

};




#endif // jkqtpgraphsimpulses_H