export_argument.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_ARGUMENT_HPP
#define ACADO_TOOLKIT_EXPORT_ARGUMENT_HPP

#include <acado/utils/acado_utils.hpp>
#include <acado/matrix_vector/matrix_vector.hpp>
#include <acado/code_generation/export_data.hpp>
#include <acado/code_generation/export_index.hpp>

BEGIN_NAMESPACE_ACADO


class ExportArgumentInternal;


class ExportArgument : public ExportData
{
    //
    // PUBLIC MEMBER FUNCTIONS:
    //
    public:

        ExportArgument( );

                ExportArgument( const std::string& _name,
                                                uint _nRows = 1,
                                                uint _nCols = 1,
                                                ExportType _type = REAL,
                                                ExportStruct _dataStruct = ACADO_LOCAL,
                                                bool _callByValue = false,
                                                const ExportIndex& _addressIdx = emptyConstExportIndex,
                                                const std::string& _prefix = std::string()
                                                );

                ExportArgument( const std::string& _name,
                                                const DMatrixPtr& _data,
                                                ExportType _type = REAL,
                                                ExportStruct _dataStruct = ACADO_LOCAL,
                                                bool _callByValue = false,
                                                const ExportIndex& _addressIdx = emptyConstExportIndex,
                                                const std::string& _prefix = std::string()
                                                );

                ExportArgument( const DMatrix& _data
                                                );

                ExportArgumentInternal* operator->();

                const ExportArgumentInternal* operator->() const;

                ExportArgument getAddress(      const ExportIndex& _rowIdx,
                                                                        const ExportIndex& _colIdx = emptyConstExportIndex
                                                                        ) const;

                const std::string getAddressString(     bool withDataStruct = true
                                                                                        ) const;


                virtual uint getNumRows( ) const;

                virtual uint getNumCols( ) const;

                virtual uint getDim( ) const;


                virtual bool isGiven( ) const;

                bool isCalledByValue( ) const;

                returnValue callByValue( );



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


static const ExportArgument emptyConstExportArgument;


CLOSE_NAMESPACE_ACADO


#endif  // ACADO_TOOLKIT_EXPORT_ARGUMENT_HPP

// end of file.