reference_trajectory.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_REFERENCE_TRAJECTORY_HPP
#define ACADO_TOOLKIT_REFERENCE_TRAJECTORY_HPP


#include <acado/utils/acado_utils.hpp>
#include <acado/simulation_environment/simulation_block.hpp>

#include <acado/variables_grid/variables_grid.hpp>


BEGIN_NAMESPACE_ACADO



class ReferenceTrajectory //: public SimulationBlock
{
        //
        // PUBLIC MEMBER FUNCTIONS:
        //
        public:
                ReferenceTrajectory( );

                ReferenceTrajectory(    const ReferenceTrajectory& rhs
                                                                );

                virtual ~ReferenceTrajectory( );

                ReferenceTrajectory& operator=( const ReferenceTrajectory& rhs
                                                                                );

                virtual ReferenceTrajectory* clone( ) const = 0;


                virtual returnValue init(       double startTime = 0.0,
                                                                        const DVector& _x  = emptyConstVector,
                                                                        const DVector& _xa = emptyConstVector,
                                                                        const DVector& _u  = emptyConstVector,
                                                                        const DVector& _p  = emptyConstVector,
                                                                        const DVector& _w  = emptyConstVector
                                                                        ) = 0;


                virtual returnValue step(       double _currentTime,
                                                                        const DVector& _y,
                                                                        const DVector& _x  = emptyConstVector,
                                                                        const DVector& _xa = emptyConstVector,
                                                                        const DVector& _u  = emptyConstVector,
                                                                        const DVector& _p  = emptyConstVector,
                                                                        const DVector& _w  = emptyConstVector
                                                                        ) = 0;

                virtual returnValue step(       const DVector& _x,
                                                                        const VariablesGrid& _u = emptyConstVariablesGrid,
                                                                        const VariablesGrid& _p = emptyConstVariablesGrid,
                                                                        const VariablesGrid& _w = emptyConstVariablesGrid
                                                                        ) = 0;

                virtual returnValue getReference(       double tStart,
                                                                                        double tEnd,
                                                                                        VariablesGrid& _yRef
                                                                                        ) const = 0;


                virtual uint getDim( ) const = 0;

                inline BooleanType isDefined( ) const;


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



        //
        // DATA MEMBERS:
        //
        protected:
                
};


CLOSE_NAMESPACE_ACADO


#include <acado/reference_trajectory/reference_trajectory.ipp>


// collecting remaining headers
#include <acado/reference_trajectory/static_reference_trajectory.hpp>
#include <acado/reference_trajectory/adaptive_reference_trajectory.hpp>


#endif  // ACADO_TOOLKIT_REFERENCE_TRAJECTORY_HPP

/*
 *      end of file
 */