options.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_OPTIONS_HPP
#define ACADO_TOOLKIT_OPTIONS_HPP

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

BEGIN_NAMESPACE_ACADO

class Options
{
        friend class AlgorithmicBase;
        
        //
        // PUBLIC MEMBER FUNCTIONS:
        //
        public:

                Options( );

                Options(        const OptionsList& _optionsList
                                        );

                virtual ~Options( );

                returnValue addOptionsList( );


                returnValue get(        OptionsName name,
                                                        int& value
                                                        ) const;

                returnValue get(        OptionsName name,
                                                        double& value
                                                        ) const;

                returnValue get(        OptionsName name,
                                                        std::string& value
                                                        ) const;

                returnValue get(        uint idx,
                                                        OptionsName name,
                                                        int& value
                                                        ) const;

                returnValue get(        uint idx,
                                                        OptionsName name,
                                                        double& value
                                                        ) const;

                returnValue get(        uint idx,
                                                        OptionsName name,
                                                        std::string& value
                                                        ) const;

                returnValue set(        OptionsName name,
                                                        int value
                                                        );

                returnValue set(        OptionsName name,
                                                        double value
                                                        );

                returnValue set(        OptionsName name,
                                                        const std::string& value
                                                        );

                returnValue set(        uint idx,
                                                        OptionsName name,
                                                        int value
                                                        );

                returnValue set(        uint idx,
                                                        OptionsName name,
                                                        double value
                                                        );

                returnValue set(        uint idx,
                                                        OptionsName name,
                                                        const std::string& value
                                                        );


        returnValue setOptions( const Options &arg
                                                                );

                returnValue setOptions( uint idx,
                                                                const Options &arg
                                                                );

                Options getOptions(     uint idx
                                                        ) const;


                uint getNumOptionsLists( ) const;


                returnValue printOptionsList( ) const;

                returnValue printOptionsList(   uint idx
                                                                                ) const;



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

                virtual returnValue setupOptions( );


                returnValue clearOptionsList( );


                BooleanType haveOptionsChanged( ) const;

                BooleanType haveOptionsChanged( uint idx
                                                                                ) const;


                returnValue declareOptionsUnchanged( );
                
                returnValue declareOptionsUnchanged(    uint idx
                                                                                                );


                returnValue addOption(  OptionsName name,
                                                                int value
                                                                );

                returnValue addOption(  OptionsName name,
                                                                double value
                                                                );

                returnValue addOption(  OptionsName name,
                                                                const std::string& value
                                                                );

                returnValue addOption(  uint idx,
                                                                OptionsName name,
                                                                int value
                                                                );

                returnValue addOption(  uint idx,
                                                                OptionsName name,
                                                                double value
                                                                );

                returnValue addOption(  uint idx,
                                                                OptionsName name,
                                                                const std::string& value
                                                                );

    //
    // DATA MEMBERS:
    //
        protected:

                std::vector< OptionsList > lists;
};

CLOSE_NAMESPACE_ACADO

#endif  // ACADO_TOOLKIT_OPTIONS_HPP

/*
 *      end of file
 */