export_module.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_MODULE_HPP
#define ACADO_TOOLKIT_EXPORT_MODULE_HPP

#include <acado/user_interaction/user_interaction.hpp>

BEGIN_NAMESPACE_ACADO

class ExportStatementBlock;

class ExportModule : public UserInteraction
{
//
// PUBLIC MEMBER FUNCTIONS:
//
public:

        ExportModule( );

        virtual ~ExportModule( );

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

protected:

        virtual returnValue exportAcadoHeader(  const std::string& _dirName,
                                                                                        const std::string& _fileName,
                                                                                        const std::string& _realString = "real_t",
                                                                                        const std::string& _intString = "int",
                                                                                        int _precision = 16
                                                                                        ) const = 0;


        virtual returnValue collectDataDeclarations(    ExportStatementBlock& declarations,
                                                                                                        ExportStruct dataStruct = ACADO_ANY
                                                                                                        ) const = 0;


        virtual returnValue collectFunctionDeclarations(        ExportStatementBlock& declarations
                                                                                                                ) const = 0;

        returnValue setupOptions( );

        std::string commonHeaderName;
};

CLOSE_NAMESPACE_ACADO

#endif  // ACADO_TOOLKIT_EXPORT_MODULE_HPP