export_templated_file.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_TEMPLATED_FILE_HPP
#define ACADO_TOOLKIT_EXPORT_TEMPLATED_FILE_HPP

#include <acado/code_generation/export_file.hpp>

#include <map>

BEGIN_NAMESPACE_ACADO

class ExportQpOasesInterface;
class ExportSimulinkInterface;
class ExportAuxiliaryFunctions;

class ExportTemplatedFile : public ExportFile
{
public:

        friend class ExportQpOasesInterface;
        friend class ExportQpOases3Interface;
        friend class ExportSimulinkInterface;
        friend class ExportAuxiliaryFunctions;
        friend class ExportHessianRegularization;
        friend class ExportAuxiliarySimFunctions;
    friend class OCPexport;
    friend class SIMexport;

        ExportTemplatedFile( );
    
            
        ExportTemplatedFile(    const std::string& _templateName,
                                                        const std::string& _fileName,
                                                        const std::string& _commonHeaderName = "",
                                                        const std::string& _realString = "real_t",
                                                        const std::string& _intString = "int",
                                                        int _precision = 16,
                                                        const std::string& _commentString = std::string()
                                                        );

        virtual ~ExportTemplatedFile( )
        {}

    
        virtual returnValue setup(      const std::string& _templateName,
                                const std::string& _fileName,
                                const std::string& _commonHeaderName = "",
                                const std::string& _realString = "real_t",
                                const std::string& _intString = "int",
                                int _precision = 16,
                                const std::string& _commentString = std::string()
                                );

    
        virtual returnValue configure(  )
        {
                return fillTemplate( );
        }

protected:

        returnValue fillTemplate( );
        std::string templateName;
        std::map< std::string, std::string > dictionary;
        std::string folders;
};

CLOSE_NAMESPACE_ACADO

#endif  // ACADO_TOOLKIT_EXPORT_TEMPLATED_FILE_HPP