/*
 * (C) Copyright 1996-2016 ECMWF.
 *
 * This software is licensed under the terms of the Apache Licence Version 2.0
 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
 * In applying this licence, ECMWF does not waive the privileges and immunities
 * granted to it by virtue of its status as an intergovernmental organisation nor
 * does it submit to any jurisdiction.
 */

/*! \file ColourTechnique.h
    \brief Definition of the Template class ColourTechnique.

    Magics Team - ECMWF 2004

    Started: Wed 18-Aug-2004

    Changes:

*/

#ifndef ColourTechnique_H
#define ColourTechnique_H

#include "ColourTable.h"
#include "Factory.h"
#include "IntervalMap.h"
#include "MagTranslator.h"
#include "magics.h"

#include "ColourTechniqueAttributes.h"

#include "PaletteColourTechniqueAttributes.h"
namespace magics {

class LevelSelection;
class LegendVisitor;

struct ColourInfo {
    ColourInfo() : index_(-1), level_(0), left_("NONE"), right_("NONE") {}
    ColourInfo(int index, double level, const Colour& left, const Colour& right) :
        index_(index), level_(level), left_(left), right_(right) {}

    int index_;
    double level_;
    Colour left_;
    Colour right_;
};


class ColourTechniqueInterface {
public:
    virtual const Colour& getMinColour() const = 0;
    virtual const Colour& getMaxColour() const = 0;
    virtual const string& getDirection() const = 0;
    virtual stringarray getColours() const     = 0;
    virtual ListPolicy getPolicy() const = 0;

};


class ColourTechnique : public map<double, ColourInfo>, 
    public ColourTechniqueAttributes {
public:
    ColourTechnique();
    virtual ~ColourTechnique();
    virtual void set(const map<string, string>&) {}
    virtual void set(const XmlNode&) {}
    virtual bool accept(const string&) { return false; }
    virtual ColourTechnique* clone() const { return new ColourTechnique(); }
    void toxml(ostream&) const {}
    virtual void set(const ColourTechniqueInterface&) {}


    Colour operator()(double) const;
    Colour left(double) const;
    Colour right(double) const;
    Colour colour(double) const;
    double leftRange(double) const;
    double rightRange(double) const;

    virtual void set(LevelSelection&, LevelSelection&, ColourTable&, int)  {}
    void prepare(LevelSelection&, LevelSelection&, bool rainbow = false);

    void colours(vector<string>&) const;

    void visit(LegendVisitor&);
    ListPolicy getPolicy() const { return policy_; }

    bool minOutOfBound() const { return minOutOfBound_; }
    bool maxOutOfBound() const { return maxOutOfBound_; }

protected:
    //! Method to print string about this class on to a stream of type ostream (virtual).
    virtual void print(ostream&) const;
    IntervalMap<Colour> bands_;

    map<double, pair<double, double> > ranges_;
    double maxLevel_;

    bool minOutOfBound_;
    bool maxOutOfBound_;

    ListPolicy policy_;


private:
    //! Copy constructor - No copy allowed
    ColourTechnique(const ColourTechnique&);
    //! Overloaded << operator to copy - No copy allowed
    ColourTechnique& operator=(const ColourTechnique&);

    // -- Friends
    //! Overloaded << operator to call print().
    friend ostream& operator<<(ostream& s, const ColourTechnique& p) {
        p.print(s);
        return s;
    }
};


class PaletteColourTechnique : public ColourTechnique, 
    public PaletteColourTechniqueAttributes
{
public:
    PaletteColourTechnique();
    virtual ~PaletteColourTechnique() override;
    void set(const map<string, string>& map) override { PaletteColourTechniqueAttributes::set(map); }
    void set(const XmlNode& node) override { PaletteColourTechniqueAttributes::set(node); }
    bool accept(const string& node) override { return PaletteColourTechniqueAttributes::accept(node); }

    void set(const ColourTechniqueInterface&) override;

    virtual void copy(const PaletteColourTechnique&) {
        PaletteColourTechniqueAttributes::copy(*this);
        ColourTechniqueAttributes::copy(*this);
    }




    virtual ColourTechnique* clone() const override {
        PaletteColourTechnique* object = new PaletteColourTechnique();
        object->copy(*this);
        return object;
    }

    


protected:
    void set(LevelSelection&, LevelSelection&, ColourTable&, int)  override;
    //! Method to print string about this class on to a stream of type ostream (virtual).
    virtual void print(ostream&) const override;

private:
    //! Copy constructor - No copy allowed
    PaletteColourTechnique(const PaletteColourTechnique&);
    //! Overloaded << operator to copy - No copy allowed
    PaletteColourTechnique& operator=(const PaletteColourTechnique&);

    // -- Friends
    //! Overloaded << operator to call print().
    friend ostream& operator<<(ostream& s, const PaletteColourTechnique& p) {
        p.print(s);
        return s;
    }

};


template <>
class MagTranslator<string, ColourTechnique> {
public:
    ColourTechnique* operator()(const string& val) { return SimpleObjectMaker<ColourTechnique>::create(val); }
    ColourTechnique* magics(const string& param) {
        ColourTechnique* object = 0;
        ParameterManager::update(param, object);
        return object;
    }
};


}  // namespace magics
#endif
