user_interaction.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_USER_INTERACTION_HPP
#define ACADO_TOOLKIT_USER_INTERACTION_HPP


#include <acado/utils/acado_utils.hpp>
#include <acado/user_interaction/options.hpp>
#include <acado/user_interaction/logging.hpp>
#include <acado/user_interaction/plotting.hpp>



BEGIN_NAMESPACE_ACADO


class UserInteraction : public Options, public Logging, public Plotting
{
        //
        // PUBLIC MEMBER FUNCTIONS:
        //
        public:

                UserInteraction( );

                UserInteraction(        const UserInteraction& rhs
                                                        );

                virtual ~UserInteraction( );

                UserInteraction& operator=(     const UserInteraction& rhs
                                                                        );


                virtual int operator<<( PlotWindow& _window
                                                                );

                virtual int addPlotWindow(      PlotWindow& _window
                                                                        );

                virtual int operator<<( LogRecord& _record
                                                                );


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

                virtual returnValue getPlotDataFromMemberLoggings(      PlotWindow& _window
                                                                                                                        ) const;


                BlockStatus getStatus( ) const;

                returnValue setStatus(  BlockStatus _status
                                                                );


    //
    // DATA MEMBERS:
    //
        protected:

                BlockStatus status;                                     
};


CLOSE_NAMESPACE_ACADO


//#include <acado/user_interaction/user_interaction.ipp>


#endif  // ACADO_TOOLKIT_USER_INTERACTION_HPP


/*
 *      end of file
 */