export_index.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_INDEX_HPP
#define ACADO_TOOLKIT_EXPORT_INDEX_HPP

#include <acado/code_generation/export_data.hpp>

BEGIN_NAMESPACE_ACADO

class ExportIndexNode;
class ExportArgument;

class ExportIndex : public ExportData
{
public:

        ExportIndex();

        ExportIndex(    const int _value );

        explicit ExportIndex(   const std::string& _name,
                                                        const std::string& _prefix = std::string()
                                                        );

        ExportIndexNode* operator->();

        const ExportIndexNode* operator->() const;

        operator ExportArgument();

        friend ExportIndex operator+(   const ExportIndex& _arg1,
                                                                        const ExportIndex& _arg2
                                                                        );


        friend ExportIndex operator-(   const ExportIndex& _arg1,
                                                                        const ExportIndex& _arg2
                                                                        );


        friend ExportIndex operator*(   const ExportIndex& _arg1,
                                                                        const ExportIndex& _arg2
                                                                        );


        friend ExportIndex operator/(   const ExportIndex& _arg1,
                                                                        const ExportIndex& _arg2
                                                                        );

        friend ExportIndex operator%(   const ExportIndex& _arg1,
                                                                        const ExportIndex& _arg2
                                                                        );

        friend std::string operator==(  const ExportIndex& _arg1,
                                                                        const ExportIndex& _arg2
                                                                        );

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

        const std::string get( ) const;

        int getGivenValue( ) const;

        bool isGiven( ) const;

        bool isBinary() const;

        bool isVariable() const;
};

struct ExportIndexComparator
{
    bool operator() (const ExportIndex& val1, const ExportIndex& val2) const
    {
        int tmp = std::string( val1.getName() ).compare( std::string( val2.getName() ) );

        return (tmp < 0) ? true : false;
    }
};

const ExportIndex emptyConstExportIndex( int( 0 ) );
const ExportIndex constExportIndexValueOne( int( 1 ) );

CLOSE_NAMESPACE_ACADO

#endif  // ACADO_TOOLKIT_EXPORT_INDEX_HPP