output_fcn.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 
27 
34 #ifndef ACADO_TOOLKIT_OUTPUT_FCN_HPP
35 #define ACADO_TOOLKIT_OUTPUT_FCN_HPP
36 
37 
39 
40 
42 
43 
44 
55 class OutputFcn : public Function
56 {
57  //
58  // PUBLIC MEMBER FUNCTIONS:
59  //
60  public:
62  OutputFcn( );
63 
65  OutputFcn( const OutputFcn& rhs );
66 
68  virtual ~OutputFcn( );
69 
71  OutputFcn& operator=( const OutputFcn& rhs );
72 
73 
74  Output operator()( uint componentIdx );
75 
76 
81  returnValue evaluate( double *x ,
82  double *_result );
83 
84 
85 
91  const VariablesGrid *xa,
92  const VariablesGrid *p ,
93  const VariablesGrid *u ,
94  const VariablesGrid *w ,
95  VariablesGrid *_result );
96 
97 
98 
106  DVector evaluate( const EvaluationPoint &x ,
107  const int &number = 0 );
108 
109 
110  inline BooleanType isDefined( ) const;
111 
112  //
113  // PROTECTED MEMBER FUNCTIONS:
114  //
115  protected:
116 
117 
118 
119  //
120  // DATA MEMBERS:
121  //
122  protected:
123 };
124 
125 
127 
128 
129 
130 #include <acado/function/output_fcn.ipp>
131 
132 
133 #endif // ACADO_TOOLKIT_OUTPUT_FCN_HPP
134 
135 /*
136  * end of file
137  */
Allows to setup and evaluate a general function based on SymbolicExpressions.
Definition: function_.hpp:59
returnValue evaluate(double *x, double *_result)
Definition: output_fcn.cpp:91
Allows to setup and evaluate output functions based on SymbolicExpressions.
Definition: output_fcn.hpp:55
Provides a time grid consisting of vector-valued optimization variables at each grid point...
Allows to pass back messages to the calling function.
virtual ~OutputFcn()
Definition: output_fcn.cpp:58
Allows to setup function evaluation points.
BEGIN_NAMESPACE_ACADO typedef unsigned int uint
Definition: acado_types.hpp:42
#define CLOSE_NAMESPACE_ACADO
OutputFcn & operator=(const OutputFcn &rhs)
Definition: output_fcn.cpp:63
void rhs(const real_t *x, real_t *f)
BooleanType isDefined() const
#define BEGIN_NAMESPACE_ACADO
Output operator()(uint componentIdx)
Definition: output_fcn.cpp:74


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