clock.hpp
Go to the documentation of this file.
00001 /*
00002  *    This file is part of ACADO Toolkit.
00003  *
00004  *    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
00005  *    Copyright (C) 2008-2014 by Boris Houska, Hans Joachim Ferreau,
00006  *    Milan Vukov, Rien Quirynen, KU Leuven.
00007  *    Developed within the Optimization in Engineering Center (OPTEC)
00008  *    under supervision of Moritz Diehl. All rights reserved.
00009  *
00010  *    ACADO Toolkit is free software; you can redistribute it and/or
00011  *    modify it under the terms of the GNU Lesser General Public
00012  *    License as published by the Free Software Foundation; either
00013  *    version 3 of the License, or (at your option) any later version.
00014  *
00015  *    ACADO Toolkit is distributed in the hope that it will be useful,
00016  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
00017  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018  *    Lesser General Public License for more details.
00019  *
00020  *    You should have received a copy of the GNU Lesser General Public
00021  *    License along with ACADO Toolkit; if not, write to the Free Software
00022  *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
00023  *
00024  */
00025 
00026 
00033 #ifndef ACADO_TOOLKIT_CLOCK_HPP
00034 #define ACADO_TOOLKIT_CLOCK_HPP
00035 
00036 
00037 #include <acado/utils/acado_utils.hpp>
00038 
00039 
00040 BEGIN_NAMESPACE_ACADO
00041 
00042 
00053 class Clock
00054 {
00055         //
00056         //  PUBLIC MEMBER FUNCTIONS:
00057         //
00058         public:
00059 
00062                 Clock( );
00063 
00068                 Clock(  const Clock &rhs
00069                                 );
00070 
00073                 virtual ~Clock();
00074 
00079                 Clock& operator=(       const Clock &rhs
00080                                                         );
00081 
00086                 virtual Clock* clone( ) const = 0;
00087 
00088 
00095                 virtual returnValue init(       double _initialTime
00096                                                                         );
00097 
00102                 virtual returnValue reset( );
00103 
00104 
00111                 virtual returnValue start( ) = 0;
00112         
00121                 virtual returnValue step(       double _timeShift
00122                                                                         ) = 0;
00123         
00130                 virtual returnValue stop ( ) = 0;
00131 
00132 
00140                 virtual returnValue getTime(    double& _elapsedTime
00141                                                                                 );
00142 
00148                 virtual double getTime( );
00149 
00150 
00155                 inline ClockStatus getStatus( ) const;
00156 
00157 
00158 
00159         //
00160         //  PROTECTED MEMBERS:
00161         //
00162         protected:
00163                 double elapsedTime;                             
00164                 ClockStatus status;                             
00165 };
00166 
00167 
00168 CLOSE_NAMESPACE_ACADO
00169 
00170 
00171 #include <acado/clock/clock.ipp>
00172 
00173 
00174 // collect all remaining headers of clock directory
00175 #include <acado/clock/real_clock.hpp>
00176 #include <acado/clock/simulation_clock.hpp>
00177 
00178 
00179 #endif  // ACADO_TOOLKIT_CLOCK_HPP
00180 
00181 
00182 /*
00183  *      end of file
00184  */


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:36:49