export_statement.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_STATEMENT_HPP
#define ACADO_TOOLKIT_EXPORT_STATEMENT_HPP

#include <acado/utils/acado_utils.hpp>

#include <memory>

BEGIN_NAMESPACE_ACADO


class ExportIndex;
class MemoryAllocator;


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

                typedef std::shared_ptr< ExportStatement > StatementPtr;

                typedef std::vector< StatementPtr > StatementPtrArray;

                typedef std::shared_ptr< MemoryAllocator > MemoryAllocatorPtr;

        ExportStatement( );

                ExportStatement(        const ExportStatement& arg
                                                        );

        virtual ~ExportStatement( );

        ExportStatement& operator=(     const ExportStatement& arg
                                                                        );

                virtual ExportStatement* clone( ) const = 0;


                virtual returnValue exportDataDeclaration(      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 = 0;

                virtual ExportStatement& acquire( ExportIndex&  )
                {
                        return *this;
                }

                virtual ExportStatement& release( const ExportIndex&  )
                {
                        return *this;
                }

                virtual ExportStatement& allocate( MemoryAllocatorPtr  )
                {
                        return *this;
                }
        
        
    public:
        static std::string fcnPrefix;
        static std::string varPrefix;
};


CLOSE_NAMESPACE_ACADO


#endif  // ACADO_TOOLKIT_EXPORT_STATEMENT_HPP

// end of file.