simulation_block.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 
00027 #ifndef ACADO_TOOLKIT_SIMULATION_BLOCK_HPP
00028 #define ACADO_TOOLKIT_SIMULATION_BLOCK_HPP
00029 
00030 
00031 #include <acado/utils/acado_utils.hpp>
00032 #include <acado/clock/clock.hpp>
00033 #include <acado/user_interaction/user_interaction.hpp>
00034 
00035 
00042 BEGIN_NAMESPACE_ACADO
00043 
00044 
00056 class SimulationBlock : public UserInteraction
00057 {
00058         //
00059         //  PUBLIC MEMBER FUNCTIONS:
00060         //
00061         public:
00064                 SimulationBlock( );
00065 
00071                 SimulationBlock(        BlockName _name,
00072                                                         double _samplingTime = DEFAULT_SAMPLING_TIME
00073                                                         );
00074         
00079                 SimulationBlock(        const SimulationBlock& rhs
00080                                                         );
00081         
00084                 virtual ~SimulationBlock( );
00085         
00090                 SimulationBlock& operator=(     const SimulationBlock& rhs
00091                                                                         );
00092 
00093 
00099                 inline BooleanType isDefined( ) const;
00100 
00101 
00106                 inline BlockName getName( ) const;
00107 
00112                 inline double getSamplingTime( ) const;
00113 
00114 
00121                 inline returnValue setName(     BlockName _name
00122                                                                         );
00123 
00131                 inline returnValue setSamplingTime(     double _samplingTime
00132                                                                                         );
00133 
00134 
00135 
00136         //
00137         //  PROTECTED MEMBER FUNCTIONS:
00138         //
00139         protected:
00140         
00141         
00142         //
00143         //  PROTECTED MEMBERS:
00144         //
00145         protected:
00146                 BlockName name;                                 
00147                 double samplingTime;                    
00149                 RealClock realClock;                    
00150 };
00151 
00152 
00153 CLOSE_NAMESPACE_ACADO
00154 
00155 
00156 
00157 #include <acado/simulation_environment/simulation_block.ipp>
00158 
00159 
00160 #endif  // ACADO_TOOLKIT_SIMULATION_BLOCK_HPP
00161 
00162 
00163 /*
00164  *      end of file
00165  */


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