export_algorithm.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_ALGORITHM_HPP
#define ACADO_TOOLKIT_EXPORT_ALGORITHM_HPP

#include <acado/utils/acado_utils.hpp>
#include <acado/user_interaction/algorithmic_base.hpp>
#include <acado/matrix_vector/matrix_vector.hpp>

#include <acado/code_generation/export_variable.hpp>
#include <acado/code_generation/export_function.hpp>
#include <acado/code_generation/export_acado_function.hpp>
#include <acado/code_generation/export_arithmetic_statement.hpp>
#include <acado/code_generation/export_function_call.hpp>
#include <acado/code_generation/export_for_loop.hpp>

BEGIN_NAMESPACE_ACADO

class ExportAlgorithm : public AlgorithmicBase
{
    //
    // PUBLIC MEMBER FUNCTIONS:
    //

    public:

        ExportAlgorithm(        UserInteraction* _userInteraction = 0,
                                                        const std::string& _commonHeaderName = std::string()
                                                        );

        virtual ~ExportAlgorithm( );

                virtual returnValue setup( );


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

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


                virtual returnValue getCode(    ExportStatementBlock& code
                                                                                ) = 0;


                returnValue setDimensions(      uint _NX = 0,
                                                                        uint _NU = 0,
                                                                        uint _NP = 0,
                                                                        uint _NI = 0,
                                                                        uint _NOD = 0
                                                                        );


                returnValue setDimensions(      uint _NX,
                                                                        uint _NDX,
                                                                        uint _NXA,
                                                                        uint _NU,
                                                                        uint _NP,
                                                                        uint _NI,
                                                                        uint _NOD
                                                                        );


                uint getNX( ) const;
                
                uint getNXA( ) const;

                uint getNDX( ) const;

                uint getNU( ) const;

                uint getNP( ) const;

                uint getNOD( ) const;

                uint getN( ) const;
                
                void setNY( uint NY_ );
                uint getNY( ) const;

                void setNYN( uint NYN_ );
                uint getNYN( ) const;

    protected:

                uint NX;                                                        
                uint NDX;                                                       
                uint NXA;                                                       
                uint NU;                                                        
                uint NP;                                                        
                uint NOD;                                                       
                uint N;                                                         
                uint NY;                                                        
                uint NYN;                                                       
                std::string commonHeaderName;           
};


CLOSE_NAMESPACE_ACADO


#endif  // ACADO_TOOLKIT_EXPORT_ALGORITHM_HPP

// end of file.