export_data.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_DATA_HPP
#define ACADO_TOOLKIT_EXPORT_DATA_HPP

#include <acado/utils/acado_utils.hpp>
#include <casadi/symbolic/shared_object.hpp>

BEGIN_NAMESPACE_ACADO

// Forward declaration
class ExportDataInternal;

class ExportData : public CasADi::SharedObject
{
    //
    // PUBLIC MEMBER FUNCTIONS:
    //
    public:
        ExportData( );

        virtual ~ExportData( );

        ExportDataInternal* operator->();

        const ExportDataInternal* operator->() const;

                returnValue     setName(        const std::string& _name
                                                                );

                returnValue     setType(        ExportType _type
                                                                );
                                                                
                returnValue     setDataStruct(  ExportStruct _dataStruct
                                                                        );
                returnValue setPrefix(  const std::string& _prefix
                                                                );
                std::string getName( ) const;

                ExportType getType( ) const;

                std::string getTypeString(      const std::string& _realString = "real_t",
                                                                        const std::string& _intString = "int"
                                                                        ) const;

                ExportStruct getDataStruct( ) const;

                std::string getDataStructString( ) const;
                
                std::string getPrefix( ) const;

                std::string getFullName( ) const;


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


                virtual bool isGiven( );

                virtual returnValue setDoc(const std::string& _doc);

                virtual std::string getDoc() const;
};

CLOSE_NAMESPACE_ACADO


#endif  // ACADO_TOOLKIT_EXPORT_DATA_HPP

// end of file.