export_argument_list.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_EXPORT_ARGUMENT_LIST_HPP
#define ACADO_TOOLKIT_EXPORT_ARGUMENT_LIST_HPP


#include <acado/utils/acado_utils.hpp>
#include <acado/code_generation/export_argument.hpp>

BEGIN_NAMESPACE_ACADO


class ExportArgumentList
{
        //
        // PUBLIC MEMBER FUNCTIONS:
        //
        public:

                ExportArgumentList( );

                ExportArgumentList(     const ExportArgument& _argument1,
                                                        const ExportArgument& _argument2 = emptyConstExportArgument,
                                                        const ExportArgument& _argument3 = emptyConstExportArgument,
                                                        const ExportArgument& _argument4 = emptyConstExportArgument,
                                                        const ExportArgument& _argument5 = emptyConstExportArgument,
                                                        const ExportArgument& _argument6 = emptyConstExportArgument,
                                                        const ExportArgument& _argument7 = emptyConstExportArgument,
                                                        const ExportArgument& _argument8 = emptyConstExportArgument,
                                                        const ExportArgument& _argument9 = emptyConstExportArgument
                                                        );
                
                ExportArgumentList(     const ExportArgumentList& arg
                                                        );

                virtual ~ExportArgumentList( );

                ExportArgumentList& operator=(  const ExportArgumentList& rhs
                                                                                );


                returnValue addArgument(        const ExportArgument& _argument1,
                                                                        const ExportArgument& _argument2 = emptyConstExportArgument,
                                                                        const ExportArgument& _argument3 = emptyConstExportArgument,
                                                                        const ExportArgument& _argument4 = emptyConstExportArgument,
                                                                        const ExportArgument& _argument5 = emptyConstExportArgument,
                                                                        const ExportArgument& _argument6 = emptyConstExportArgument,
                                                                        const ExportArgument& _argument7 = emptyConstExportArgument,
                                                                        const ExportArgument& _argument8 = emptyConstExportArgument,
                                                                        const ExportArgument& _argument9 = emptyConstExportArgument
                                                                        );


                uint getNumArguments( ) const;


                virtual returnValue exportCode( std::ostream& stream,
                                                                                const std::string& _realString = "real_t",
                                                                                const std::string& _intString = "int",
                                                                                int _precision = 16
                                                                                ) const;


                returnValue clear( );
                
                
                returnValue doIncludeType( );
                
                
                returnValue doNotIncludeType( );

                const std::vector< ExportArgument >& get( ) const;

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

                returnValue addSingleArgument(  const ExportArgument& _argument
                                                                                );


        //
        // DATA MEMBERS:
        //
        protected:

                std::vector< ExportArgument > arguments;
                
                bool includeType;
};


CLOSE_NAMESPACE_ACADO



#endif  // ACADO_TOOLKIT_EXPORT_ARGUMENT_LIST_HPP


/*
 *      end of file
 */