wellmarker.h

Go to the documentation of this file.

#ifndef wellmarker_h
#define wellmarker_h

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Bert Bril
 Date:          Aug 2003
 RCS:           $Id$
________________________________________________________________________


-*/

#include "wellmod.h"
#include "color.h"
#include "ranges.h"
#include "namedobj.h"
#include "manobjectset.h"

class TaskRunner;


namespace Well
{
class Track;

mExpClass(Well) Marker : public ::NamedObject
{
public:

                        Marker( const char* nm=0, float dh=0, Color c=Color() )
                        : ::NamedObject(nm)
                        , dah_(dh)
                        , color_(c)
                        , levelid_(-1)          {}
                        Marker( int lvlid, float dh )
                            : dah_(dh)
                            , color_(Color::Black())
                            , levelid_(lvlid)   {}
    Marker&             operator =(const Marker&);
    inline bool         operator ==( const Marker& m )
                        { return m.name() == name(); }
    bool                operator > ( const Marker& wm ) const
                        { return dah_ > wm.dah_; }

    inline float        dah() const             { return dah_; }
    inline void         setDah( float v )       { dah_ = v; }
    inline int          levelID() const         { return levelid_; }
    inline void         setLevelID( int id )    { levelid_ = id; }
    Color               color() const;

    static const char*  sKeyDah();

    // setName() and setColor() only used as fallback, if not attached to level
    void                setColor( Color col )   { color_ = col; }

protected:

    float               dah_;
    Color               color_;
    int                 levelid_;

};


mExpClass(Well) MarkerSet : public ManagedObjectSet<Marker>
{
public:

                        MarkerSet()                     {}
    void                fillWithAll(TaskRunner* tr=0);

    const Marker*       getByName(const char* nm) const { return gtByName(nm); }
    Marker*             getByName(const char* nm)       { return gtByName(nm); }
    const Marker*       getByLvlID(int id) const        { return gtByLvlID(id);}
    Marker*             getByLvlID(int id)              { return gtByLvlID(id);}
    int                 getIdxAbove(float z,const Well::Track* trck=0) const;
    int                 getIdxBelow(float z,const Well::Track* trck=0) const;

    bool                isPresent(const char* n) const  { return getByName(n); }
    int                 indexOf(const char*) const;
    void                sortByDAH();
    bool                insertNew(Well::Marker*); //becomes mine
    void                addSameWell(const ObjectSet<Marker>&);
    void                mergeOtherWell(const ObjectSet<Marker>&);
    virtual void        append( const ObjectSet<Marker>& ms )
                                                        { mergeOtherWell(ms); }

    int                 indexOf( const Marker* m ) const
                        { return ObjectSet<Marker>::indexOf(m); }
    bool                isPresent( const Marker* m ) const
                        { return ObjectSet<Marker>::isPresent(m); }

    void                getNames(BufferStringSet&) const;
    void                getColors(TypeSet<Color>&) const;
    void                fillPar(IOPar&) const;
    void                usePar(const IOPar&);

protected:

    virtual ObjectSet<Marker>& doAdd(Marker*);
    Marker*             gtByName(const char*) const;
    Marker*             gtByLvlID(int) const;
    void                addCopy(const ObjectSet<Marker>&,int,float);
    void                alignOrderingWith(const ObjectSet<Marker>&);
    void                moveBlock(int,int,const TypeSet<int>&);
    void                insertNewAfter(int,ObjectSet<Marker>&);

};


mExpClass(Well) MarkerRange
{
public:

                        MarkerRange(const MarkerSet&,
                            const Interval<int>& idxrg=Interval<int>(-1,-1));
                        MarkerRange(const MarkerSet&,
                                const char*,const char*);

    inline int          size() const            { return rg_.width(false) + 1; }
    bool                isValid() const;

    inline bool         isIncluded( int i ) const
                                                { return rg_.includes(i,false);}
    bool                isIncluded(const char*) const;
    bool                isIncluded(float z) const;

    void                getNames(BufferStringSet&) const;
    MarkerSet*          getResultSet() const; 


    const MarkerSet&    markers() const         { return markers_; }
    const Interval<int>& idxRange() const       { return rg_; }
    Interval<int>&      idxRange()              { return rg_; }
    float               thickness() const;

protected:

    const MarkerSet&    markers_;
    Interval<int>       rg_;
    bool                isconst_;

    void                init(const Interval<int>&);

};


mExpClass(Well) MarkerChgRange : public MarkerRange
{
public:

                        MarkerChgRange( MarkerSet& ms,
                            const Interval<int>& idxrg=Interval<int>(-1,-1) )
                            : MarkerRange(ms,idxrg)     {}
                        MarkerChgRange( MarkerSet& ms, const char* m1,
                                                        const char* m2 )
                            : MarkerRange(ms,m1,m2)     {}

    void                setThickness(float);
    void                remove();

    inline MarkerSet&   getMarkers()
                        { return const_cast<MarkerSet&>(markers_); }

};



} // namespace Well

#endif