FunctionParameter.h

/*
Hyperspace Explorer - visualizing higher-dimensional geometry
Copyright (C) 2008-2010  Lene Preuss <lene.preuss@gmail.com>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

*/

#ifndef FUNCTION_PARAMETER_H
#define FUNCTION_PARAMETER_H

#include "FunctionParameterValue.h"

#include <string>
#include <memory>


class FunctionParameter {

    public:

        typedef std::shared_ptr< FunctionParameterValueBase > value_ptr_type;
        typedef std::shared_ptr< FunctionParameter > parameter_ptr_type;

        FunctionParameter(const std::string &name, const std::string &description = "");

        double toDouble() const;
        unsigned toUnsigned() const;
        int toInt() const;
        std::string toString() const;

        VecMath::Rotation<5> toRotation5() const;
        VecMath::Rotation<6> toRotation6() const;
        VecMath::Rotation<7> toRotation7() const;
        VecMath::Rotation<8> toRotation8() const;
        VecMath::Rotation<9> toRotation9() const;
        VecMath::Rotation<10> toRotation10() const;

        const std::string &getName() const;

        void setName(const std::string &name);

        const std::string &getDescription() const;

        void setDescription(const std::string &description);

        void setValue(FunctionParameter::value_ptr_type value);

        void setValue(const std::string &newValue);

        void setDefaultValue(FunctionParameter::value_ptr_type defaultValue);

        FunctionParameter::value_ptr_type value() const;

        FunctionParameter::value_ptr_type defaultValue() const;

    private:

        std::string _name;

        std::string _description;

        FunctionParameter::value_ptr_type _value;

        FunctionParameter::value_ptr_type _defaultValue;
};

#endif