plot_collection.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_COLLECTION_HPP
#define ACADO_TOOLKIT_PLOT_COLLECTION_HPP


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

#include <acado/user_interaction/plot_window.hpp>


BEGIN_NAMESPACE_ACADO


class PlotCollection
{
        friend class Plotting;

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

                PlotCollection( const PlotCollection& rhs
                                                );

                ~PlotCollection( );

                PlotCollection& operator=(      const PlotCollection& rhs
                                                                        );


                inline PlotWindow& operator()(  uint idx
                                                                                );

                inline PlotWindow operator()(   uint idx
                                                                                ) const;


                int operator<<( PlotWindow& window
                                                );

                int addPlotWindow(      PlotWindow& window
                                                        );


                returnValue clearAllWindows( );


                inline uint getNumPlotWindows( ) const;


                returnValue enableNominalControls( );
                
                returnValue disableNominalControls( );


                returnValue enableNominalParameters( );
                
                returnValue disableNominalParameters( );


                returnValue enableNominalOutputs( );
                
                returnValue disableNominalOutputs( );


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


    //
    // DATA MEMBERS:
    //
        protected:
                PlotWindow* first;                              
                PlotWindow* last;                               
                uint number;                                    
};


CLOSE_NAMESPACE_ACADO


#include <acado/user_interaction/plot_collection.ipp>


#endif  // ACADO_TOOLKIT_PLOT_COLLECTION_HPP


/*
 *      end of file
 */