plotting.hpp
Go to the documentation of this file.
00001 /*
00002  *    This file is part of ACADO Toolkit.
00003  *
00004  *    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
00005  *    Copyright (C) 2008-2014 by Boris Houska, Hans Joachim Ferreau,
00006  *    Milan Vukov, Rien Quirynen, KU Leuven.
00007  *    Developed within the Optimization in Engineering Center (OPTEC)
00008  *    under supervision of Moritz Diehl. All rights reserved.
00009  *
00010  *    ACADO Toolkit is free software; you can redistribute it and/or
00011  *    modify it under the terms of the GNU Lesser General Public
00012  *    License as published by the Free Software Foundation; either
00013  *    version 3 of the License, or (at your option) any later version.
00014  *
00015  *    ACADO Toolkit is distributed in the hope that it will be useful,
00016  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
00017  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018  *    Lesser General Public License for more details.
00019  *
00020  *    You should have received a copy of the GNU Lesser General Public
00021  *    License along with ACADO Toolkit; if not, write to the Free Software
00022  *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
00023  *
00024  */
00025 
00026 
00033 #ifndef ACADO_TOOLKIT_PLOTTING_HPP
00034 #define ACADO_TOOLKIT_PLOTTING_HPP
00035 
00036 
00037 #include <acado/utils/acado_utils.hpp>
00038 #include <acado/user_interaction/plot_collection.hpp>
00039 #include <acado/user_interaction/plot_window.hpp>
00040 
00041 
00042 
00043 BEGIN_NAMESPACE_ACADO
00044 
00045 
00046 static PlotWindow emptyPlotWindow;
00047 
00048 
00061 class Plotting
00062 {
00063         friend class AlgorithmicBase;
00064         
00065         //
00066         // PUBLIC MEMBER FUNCTIONS:
00067         //
00068         public:
00069 
00072                 Plotting( );
00073 
00078                 Plotting(       const Plotting& rhs
00079                                         );
00080 
00083                 virtual ~Plotting( );
00084 
00089                 Plotting& operator=(    const Plotting& rhs
00090                                                         );
00091 
00092 
00103                 inline int operator<<(  PlotWindow& _window
00104                                                                 );
00105 
00113                 inline int addPlotWindow(       PlotWindow& _window
00114                                                                         );
00115 
00116 
00125                 inline returnValue getPlotWindow(       uint idx,
00126                                                                                         PlotWindow& _window
00127                                                                                         ) const;
00128 
00139                 inline returnValue getPlotWindow(       PlotWindow& _window
00140                                                                                         ) const;
00141 
00142 
00149                 virtual returnValue plot(       PlotFrequency _frequency = PLOT_IN_ANY_CASE
00150                                                                         );
00151 
00159                 virtual returnValue replot(     PlotFrequency _frequency = PLOT_IN_ANY_CASE
00160                                                                         );
00161 
00162 
00167                 inline uint getNumPlotWindows( ) const;
00168 
00169 
00170 
00171     //
00172     // PROTECTED MEMBER FUNCTIONS:
00173     //
00174     protected:
00175 
00186                 virtual returnValue getPlotDataFromMemberLoggings(      PlotWindow& _window
00187                                                                                                                         ) const;
00188 
00189 
00190     //
00191     // DATA MEMBERS:
00192     //
00193         protected:
00194                 PlotCollection plotCollection;                          
00195 };
00196 
00197 
00198 CLOSE_NAMESPACE_ACADO
00199 
00200 
00201 #include <acado/user_interaction/plotting.ipp>
00202 
00203 
00204 #endif  // ACADO_TOOLKIT_PLOTTING_HPP
00205 
00206 
00207 /*
00208  *      end of file
00209  */


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:38:42