user_interaction.hpp
Go to the documentation of this file.
1 /*
2  * This file is part of ACADO Toolkit.
3  *
4  * ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
5  * Copyright (C) 2008-2014 by Boris Houska, Hans Joachim Ferreau,
6  * Milan Vukov, Rien Quirynen, KU Leuven.
7  * Developed within the Optimization in Engineering Center (OPTEC)
8  * under supervision of Moritz Diehl. All rights reserved.
9  *
10  * ACADO Toolkit is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 3 of the License, or (at your option) any later version.
14  *
15  * ACADO Toolkit is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with ACADO Toolkit; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  *
24  */
25 
26 
33 #ifndef ACADO_TOOLKIT_USER_INTERACTION_HPP
34 #define ACADO_TOOLKIT_USER_INTERACTION_HPP
35 
36 
41 
42 
43 
45 
46 
57 class UserInteraction : public Options, public Logging, public Plotting
58 {
59  //
60  // PUBLIC MEMBER FUNCTIONS:
61  //
62  public:
63 
65  UserInteraction( );
66 
72  );
73 
75  virtual ~UserInteraction( );
76 
82  );
83 
84 
97  virtual int operator<<( PlotWindow& _window
98  );
99 
109  virtual int addPlotWindow( PlotWindow& _window
110  );
111 
122  virtual int operator<<( LogRecord& _record
123  );
124 
125 
126  //
127  // PROTECTED MEMBER FUNCTIONS:
128  //
129  protected:
130 
141  ) const;
142 
143 
148  BlockStatus getStatus( ) const;
149 
157  );
158 
159 
160  //
161  // DATA MEMBERS:
162  //
163  protected:
164 
166 };
167 
168 
170 
171 
172 //#include <acado/user_interaction/user_interaction.ipp>
173 
174 
175 #endif // ACADO_TOOLKIT_USER_INTERACTION_HPP
176 
177 
178 /*
179  * end of file
180  */
virtual int addPlotWindow(PlotWindow &_window)
UserInteraction & operator=(const UserInteraction &rhs)
BlockStatus
returnValue setStatus(BlockStatus _status)
Provides a generic way to plot algorithmic outputs during runtime.
Definition: plotting.hpp:61
Allows to pass back messages to the calling function.
Provides a generic way to store algorithmic information during runtime.
Definition: logging.hpp:55
#define CLOSE_NAMESPACE_ACADO
virtual returnValue getPlotDataFromMemberLoggings(PlotWindow &_window) const
BlockStatus getStatus() const
Allows to setup and plot user-specified plot windows for algorithmic outputs.
Definition: plot_window.hpp:76
Provides a generic way to set and pass user-specified options.
Definition: options.hpp:65
virtual ~UserInteraction()
Encapsulates all user interaction for setting options, logging data and plotting results.
void rhs(const real_t *x, real_t *f)
Allows to setup and store user-specified log records of algorithmic information.
Definition: log_record.hpp:72
#define BEGIN_NAMESPACE_ACADO
virtual int operator<<(PlotWindow &_window)


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Mon Jun 10 2019 12:35:16