simulation_block.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_SIMULATION_BLOCK_HPP
#define ACADO_TOOLKIT_SIMULATION_BLOCK_HPP


#include <acado/utils/acado_utils.hpp>
#include <acado/clock/clock.hpp>
#include <acado/user_interaction/user_interaction.hpp>


BEGIN_NAMESPACE_ACADO


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

                SimulationBlock(        BlockName _name,
                                                        double _samplingTime = DEFAULT_SAMPLING_TIME
                                                        );
        
                SimulationBlock(        const SimulationBlock& rhs
                                                        );
        
                virtual ~SimulationBlock( );
        
                SimulationBlock& operator=(     const SimulationBlock& rhs
                                                                        );


                inline BooleanType isDefined( ) const;


                inline BlockName getName( ) const;

                inline double getSamplingTime( ) const;


                inline returnValue setName(     BlockName _name
                                                                        );

                inline returnValue setSamplingTime(     double _samplingTime
                                                                                        );



        //
        //  PROTECTED MEMBER FUNCTIONS:
        //
        protected:
        
        
        //
        //  PROTECTED MEMBERS:
        //
        protected:
                BlockName name;                                 
                double samplingTime;                    
                RealClock realClock;                    
};


CLOSE_NAMESPACE_ACADO



#include <acado/simulation_environment/simulation_block.ipp>


#endif  // ACADO_TOOLKIT_SIMULATION_BLOCK_HPP


/*
 *      end of file
 */