export_data_internal.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_INTERNAL_HPP
#define ACADO_TOOLKIT_EXPORT_DATA_INTERNAL_HPP

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

BEGIN_NAMESPACE_ACADO

class ExportDataInternal : public CasADi::SharedObjectNode
{
public:

        explicit ExportDataInternal(    const std::string& _name = std::string(),
                                                                        ExportType _type = REAL,
                                                                        ExportStruct _dataStruct = ACADO_LOCAL,
                                                                        const std::string& _prefix = std::string()
                                                                        );

        virtual ~ExportDataInternal( );

        virtual ExportDataInternal* clone() const = 0;

        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 = 0;

        virtual bool isGiven( ) const = 0;

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

        //
        // PROTECTED MEMBER FUNCTIONS:
        //
protected:

        returnValue setFullName( void );

protected:

        std::string name;

        ExportType type;

        std::string prefix;

        ExportStruct dataStruct;

        std::string fullName;

        std::string description;
};

CLOSE_NAMESPACE_ACADO

#endif // ACADO_TOOLKIT_EXPORT_DATA_INTERNAL_HPP