plot_window_subplot.hpp

Go to the documentation of this file.

/*
 *    This file is part of ACADO Toolkit.
 *
 *    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
 *    Copyright (C) 2008-2014 by Boris Houska, Hans Joachim Ferreau,
 *    Milan Vukov, Rien Quirynen, KU Leuven.
 *    Developed within the Optimization in Engineering Center (OPTEC)
 *    under supervision of Moritz Diehl. All rights reserved.
 *
 *    ACADO Toolkit is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 3 of the License, or (at your option) any later version.
 *
 *    ACADO Toolkit 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with ACADO Toolkit; if not, write to the Free Software
 *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */



#ifndef ACADO_TOOLKIT_PLOT_WINDOW_SUBPLOT_HPP
#define ACADO_TOOLKIT_PLOT_WINDOW_SUBPLOT_HPP


#include <acado/utils/acado_utils.hpp>
#include <acado/matrix_vector/matrix_vector.hpp>
#include <acado/symbolic_expression/symbolic_expression.hpp>

BEGIN_NAMESPACE_ACADO

class Curve;

class PlotWindowSubplot
{
        friend class GnuplotWindow;

        //
        // PUBLIC MEMBER FUNCTIONS:
        //
        public:
                PlotWindowSubplot( );

                PlotWindowSubplot(      const Expression& _expression,
                                                        const char* const _title = "",
                                                        const char* const _xLabel = "",
                                                        const char* const _yLabel = "",
                                                        PlotMode _plotMode = PM_UNKNOWN,
                                                        double _xRangeLowerLimit = INFTY,
                                                        double _xRangeUpperLimit = INFTY,
                                                        double _yRangeLowerLimit = INFTY,
                                                        double _yRangeUpperLimit = INFTY
                                                        );

                PlotWindowSubplot(      const Expression& _expressionX,
                                                        const Expression& _expressionY,
                                                        const char* const _title = "",
                                                        const char* const _xLabel = "",
                                                        const char* const _yLabel = "",
                                                        PlotMode _plotMode = PM_UNKNOWN,
                                                        double _xRangeLowerLimit = INFTY,
                                                        double _xRangeUpperLimit = INFTY,
                                                        double _yRangeLowerLimit = INFTY,
                                                        double _yRangeUpperLimit = INFTY
                                                        );

                PlotWindowSubplot(      PlotName _name,
                                                        const char* const _title = "",
                                                        const char* const _xLabel = "",
                                                        const char* const _yLabel = "",
                                                        PlotMode _plotMode = PM_UNKNOWN,
                                                        double _xRangeLowerLimit = INFTY,
                                                        double _xRangeUpperLimit = INFTY,
                                                        double _yRangeLowerLimit = INFTY,
                                                        double _yRangeUpperLimit = INFTY
                                                        );

        PlotWindowSubplot( const VariablesGrid& _plotVariable,
                           const char* const _title = "",
                           const char* const _xLabel = "",
                           const char* const _yLabel = "",
                           PlotMode _plotMode = PM_UNKNOWN,
                           double _xRangeLowerLimit = INFTY,
                           double _xRangeUpperLimit = INFTY,
                           double _yRangeLowerLimit = INFTY,
                           double _yRangeUpperLimit = INFTY,
                           BooleanType  _plot3D = BT_FALSE
                                                   );

        PlotWindowSubplot( const Curve& _curve,
                           double _xRangeLowerLimit = 0.0,
                           double _xRangeUpperLimit = 1.0,
                           const char* const _title = "",
                           const char* const _xLabel = "",
                           const char* const _yLabel = "",
                           PlotMode _plotMode = PM_UNKNOWN,
                           double _yRangeLowerLimit = INFTY,
                           double _yRangeUpperLimit = INFTY
                                                   );

                PlotWindowSubplot(      const PlotWindowSubplot& rhs
                                                        );

                ~PlotWindowSubplot( );

                PlotWindowSubplot& operator=(   const PlotWindowSubplot& rhs
                                                                                );


                inline returnValue setTitle(    const std::string& _title
                                                                                );

                inline returnValue setXLabel(   const std::string& _xLabel
                                                                                );

                inline returnValue setYLabel(   const std::string& _yLabel
                                                                                );

                inline returnValue setPlotMode( PlotMode _plotMode
                                                                                );

                inline returnValue setPlotFormat(       PlotFormat _plotFormat
                                                                                        );

                inline returnValue setRanges(   double _xRangeLowerLimit,
                                                                                double _xRangeUpperLimit,
                                                                                double _yRangeLowerLimit,
                                                                                double _yRangeUpperLimit
                                                                                );

                returnValue addLine(    double _lineValue
                                                                );

                returnValue addData(    const VariablesGrid& _newData
                                                                );


                inline returnValue getTitle(    std::string& _title
                                                                                );

                inline returnValue getXLabel(   std::string& _xLabel
                                                                                );

                inline returnValue getYLabel(   std::string& _yLabel
                                                                                );

                inline PlotMode getPlotMode( ) const;

                inline PlotFormat getPlotFormat( ) const;

                inline returnValue getRanges(   double& _xRangeLowerLimit,
                                                                                double& _xRangeUpperLimit,
                                                                                double& _yRangeLowerLimit,
                                                                                double& _yRangeUpperLimit
                                                                                ) const;

                inline uint getNumLines( ) const;

                inline uint getNumData( ) const;


                inline SubPlotType getSubPlotType( ) const;

                inline VariableType getXVariableType( ) const;

                inline VariableType getYVariableType( ) const;

                inline Expression* getXPlotExpression( ) const;

                inline Expression* getYPlotExpression( ) const;

                inline PlotName getPlotEnum( ) const;


                inline returnValue setNext(     PlotWindowSubplot* const _next
                                                                        );

                inline PlotWindowSubplot* getNext( ) const;


        //
        // PROTECTED MEMBER FUNCTIONS:
        //
        protected:


        //
        // DATA MEMBERS:
        //
        protected:

                Expression*    plotVariableX;                           
                Expression*    plotVariableY;                           
                VariablesGrid* plotVariablesGrid;                       
                Expression*    plotExpressionX;                         
                Expression*    plotExpressionY;                         
                PlotName       plotEnum;                                        
                std::string title;                                                      
                std::string xLabel;                                                     
                std::string yLabel;                                                     
                PlotMode plotMode;                                                      
                PlotFormat plotFormat;                                          
                double xRangeLowerLimit;                                        
                double xRangeUpperLimit;                                        
                double yRangeLowerLimit;                                        
                double yRangeUpperLimit;                                        
        BooleanType plot3D;                                                     
                uint nLines;                                                            
                double* lineValues;                                                     
                uint nData;                                                                     
                VariablesGrid** data;                                           
                PlotWindowSubplot* next;                                        
};


CLOSE_NAMESPACE_ACADO



#include <acado/user_interaction/plot_window_subplot.ipp>


#endif  // ACADO_TOOLKIT_PLOT_WINDOW_SUBPLOT_HPP


/*
 *      end of file
 */