export_function.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_HPP
#define ACADO_TOOLKIT_EXPORT_FUNCTION_HPP

#include <acado/utils/acado_utils.hpp>
#include <acado/code_generation/export_variable.hpp>
#include <acado/code_generation/export_argument_list.hpp>
#include <acado/code_generation/export_statement_block.hpp>
#include <acado/code_generation/export_statement_string.hpp>
#include <acado/code_generation/memory_allocator.hpp>

#include <memory>

BEGIN_NAMESPACE_ACADO


class ExportFunction : public ExportStatementBlock
{
public:
        ExportFunction( 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
                                        );

        virtual ~ExportFunction( );

        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
                                                );

        ExportFunction& setup(  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 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
                                                                );

        ExportFunction& setReturnValue( const ExportVariable& _functionReturnValue,
                                                                        bool _returnAsPointer = false
                                                                        );


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

        std::string getName( ) const;

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

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

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

        virtual bool isDefined( ) const;

        unsigned getNumArguments( ) const;

        ExportFunction& addIndex( const ExportIndex& _index );

        ExportFunction& addVariable( const ExportVariable& _var );

        virtual ExportFunction& acquire( ExportIndex& obj );

        virtual ExportFunction& release( const ExportIndex& obj );

        virtual ExportFunction& doc( const std::string& _doc );

        virtual ExportFunction& setPrivate(     bool _set = true );

        virtual bool isPrivate() const;

protected:
        returnValue clear( );

        std::string name;
        std::string description;

        ExportArgumentList functionArguments;
        ExportVariable retVal;
        bool returnAsPointer;
        MemoryAllocatorPtr memAllocator;
        std::vector< ExportVariable > localVariables;
        bool flagPrivate;
};

CLOSE_NAMESPACE_ACADO

#endif  // ACADO_TOOLKIT_EXPORT_FUNCTION_HPP