plotting.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_PLOTTING_HPP
#define ACADO_TOOLKIT_PLOTTING_HPP


#include <acado/utils/acado_utils.hpp>
#include <acado/user_interaction/plot_collection.hpp>
#include <acado/user_interaction/plot_window.hpp>



BEGIN_NAMESPACE_ACADO


static PlotWindow emptyPlotWindow;


class Plotting
{
        friend class AlgorithmicBase;
        
        //
        // PUBLIC MEMBER FUNCTIONS:
        //
        public:

                Plotting( );

                Plotting(       const Plotting& rhs
                                        );

                virtual ~Plotting( );

                Plotting& operator=(    const Plotting& rhs
                                                        );


                inline int operator<<(  PlotWindow& _window
                                                                );

                inline int addPlotWindow(       PlotWindow& _window
                                                                        );


                inline returnValue getPlotWindow(       uint idx,
                                                                                        PlotWindow& _window
                                                                                        ) const;

                inline returnValue getPlotWindow(       PlotWindow& _window
                                                                                        ) const;


                virtual returnValue plot(       PlotFrequency _frequency = PLOT_IN_ANY_CASE
                                                                        );

                virtual returnValue replot(     PlotFrequency _frequency = PLOT_IN_ANY_CASE
                                                                        );


                inline uint getNumPlotWindows( ) const;



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

                virtual returnValue getPlotDataFromMemberLoggings(      PlotWindow& _window
                                                                                                                        ) const;


    //
    // DATA MEMBERS:
    //
        protected:
                PlotCollection plotCollection;                          
};


CLOSE_NAMESPACE_ACADO


#include <acado/user_interaction/plotting.ipp>


#endif  // ACADO_TOOLKIT_PLOTTING_HPP


/*
 *      end of file
 */