Parameter.h

Go to the documentation of this file.

/*  This file is part of Charon.

    Charon 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.

    Charon 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 Charon.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _Parameter_H
#define _Parameter_H

#include "AbstractData.hxx"
#include "DllEx.h"
#include <string>

class ParameteredObject;
class ParameterFile;

class charon_core_DLL_PUBLIC AbstractParameter {
private:
    charon_core_LOCAL AbstractParameter(const AbstractParameter&);

protected:
    std::string _name;

    ParameteredObject* _parent;


    std::string _followLink(
        const ParameterFile& pf, const std::string paramName) const;

public:
    AbstractParameter();


    void init(ParameteredObject* parent, const std::string& name);

    virtual ~AbstractParameter();

    ParameteredObject& getParent();

    const ParameteredObject& getParent() const;

    std::string getName() const;


    virtual std::string guessType() const = 0;


    virtual void save(ParameterFile& pf) const = 0;


    virtual void load(const ParameterFile& pf) = 0;


    virtual std::string getDefaultString() = 0;

    virtual void intoStream(std::ostream & os) const = 0;
};


std::ostream charon_core_DLL_PUBLIC & operator<< (
        std::ostream& os, const AbstractParameter& param);

template <typename T>
class charon_core_PUBLIC Parameter :
            public AbstractParameter, public AbstractData<T> {
private:
    T _defaultValue;

    T _value;

public:
    Parameter(T defaultValue = T());

    virtual ~Parameter();


    virtual T& operator=(const T& B);


    virtual Parameter<T>& operator=(const Parameter<T>& B);

    virtual operator T() const;

    void    setDefault(const T& value);

    // overload inherited functions
    virtual std::string guessType() const;
    virtual const T& operator()() const;
    virtual T& operator()();
    virtual void save(ParameterFile& pf) const;
    virtual void load(const ParameterFile& pf);
    virtual std::string getDefaultString();

    virtual void intoStream(std::ostream & os) const;
};

template <typename T>
class charon_core_PUBLIC ParameterList :
            public AbstractParameter, public AbstractMultiData<T> {
private:
    std::vector<T> _value;

    std::string _defaultValue;

public:

    ParameterList(std::string defaultValue = "");

    virtual ~ParameterList();


    void    setDefault(const std::string& value);


    virtual std::vector<T>& operator=(const std::vector<T>& B);


    virtual ParameterList<T>& operator=(const ParameterList<T>& B);

    operator std::vector<T>() const;

    std::vector<T>& operator()();

    const std::vector<T>& operator()() const;

    virtual std::string guessType() const;
    virtual void save(ParameterFile& pf) const;
    virtual void load(const ParameterFile& pf);
    virtual std::string getDefaultString();

    // inherited by AbstractMultiData<T>
    virtual std::size_t size() const;
    virtual const T& operator[](std::size_t pos) const;
    virtual T& operator[](std::size_t pos);

    virtual void intoStream(std::ostream & os) const;
};

#endif // _Parameter_H