export_function_call.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_FUNCTION_CALL_HPP
#define ACADO_TOOLKIT_EXPORT_FUNCTION_CALL_HPP

#include <acado/utils/acado_utils.hpp>

#include <acado/code_generation/export_statement.hpp>
#include <acado/code_generation/export_function.hpp>


BEGIN_NAMESPACE_ACADO



class ExportFunctionCall : public ExportStatement
{
    //
    // PUBLIC MEMBER FUNCTIONS:
    //
    public:

                ExportFunctionCall(     const std::string& _name = "acadoFcn",
                                                        const ExportArgument& _argument1 = emptyConstExportArgument,
                                                        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
                                                        );

                ExportFunctionCall(     const ExportFunction& _f,
                                                        const ExportArgument& _argument1 = emptyConstExportArgument,
                                                        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
                                                        );

                ExportFunctionCall(     const ExportFunctionCall& arg
                                                        );

                virtual ~ExportFunctionCall( );

                ExportFunctionCall& operator=(  const ExportFunctionCall& arg
                                                                                );

                virtual ExportStatement* clone( ) const;


                returnValue init(       const std::string& _name = "defaultFunctionName",
                                                        const ExportArgument& _argument1 = emptyConstExportArgument,
                                                        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
                                                        );

                returnValue init(       const ExportFunction& _f,
                                                        const ExportArgument& _argument1 = emptyConstExportArgument,
                                                        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
                                                        );


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


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

                returnValue clear( );


                returnValue     setName(        const std::string& _name
                                                                );


    protected:

                std::string name;                                                               
                ExportArgumentList functionArguments;           
};


CLOSE_NAMESPACE_ACADO


#endif  // ACADO_TOOLKIT_EXPORT_STATEMENT_HPP

// end of file.