stratunitref.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Bert Bril
 Date:          Dec 2003 / Sep 2010
________________________________________________________________________


-*/

#include "stratmod.h"
#include "compoundkey.h"
#include "stratlevel.h"
#include "enums.h"
#include "iopar.h"


namespace Strat
{

class RefTree;
class Lithology;
class NodeUnitRef;
class LeafUnitRef;

mExpClass(Strat) UnitRef : public CallBacker
{
public:

    enum Type           { NodeOnly, Leaved, Leaf };
                        mDeclareEnumUtils(Type)

                        UnitRef(NodeUnitRef*,const char* d=0);
    virtual             ~UnitRef();

    virtual Type        type() const            = 0;
    virtual bool        isEmpty() const         { return false; }
    virtual bool        isUndef() const         { return false; }
    virtual bool        hasChildren() const     = 0;
    bool                isLeaf() const          { return type()==Leaf; }
    bool                isLeaved() const        { return type()==Leaved; }
    CompoundKey         fullCode() const;
    CompoundKey         parentCode() const;

    virtual const OD::String& code() const      = 0;
    virtual void        setCode(const char*)    {}
    const OD::String&   description() const     { return desc_; }
    virtual void        setDescription( const char* d ) { desc_ = d; }
    Color               color() const           { return color_; }
    void                setColor(Color);
    IOPar&              pars()                  { return pars_; }
    const IOPar&        pars() const            { return pars_; }

    NodeUnitRef*        upNode(int skip=0);
    const NodeUnitRef*  upNode( int skip=0 ) const
                        { return ((UnitRef*)this)->upNode( skip ); }
    void                setUpNode(NodeUnitRef* newpar)
                        { upnode_ = newpar; }
    NodeUnitRef*        topNode();
    const NodeUnitRef*  topNode() const;
    RefTree&            refTree(); // is the topNode
    const RefTree&      refTree() const;
    virtual bool        isParentOf(const UnitRef&) const { return false; }
    virtual int         level() const                   = 0;

    Notifier<UnitRef>   changed;
    Notifier<UnitRef>   toBeDeleted;

    virtual const LeafUnitRef*  firstLeaf() const       = 0;

protected:

    NodeUnitRef*        upnode_;

    BufferString        desc_;
    Color               color_;
    IOPar               pars_;

    void                doFill(BufferString&,int) const;
    void                doFill(BufferString&,IntegerID<int>) const;

    void                doUse(const char*,int*);
    void                doUse(const char*,IntegerID<int>&);

    void                notifChange(bool isrem=false);

    friend class        NodeUnitRef;

public:

    int                 treeDepth() const;
    bool                isBelow(const UnitRef*) const;
    bool                precedes(const UnitRef&) const;

    virtual void        fill( BufferString& bs ) const  { doFill(bs,mUdf(int));}
    virtual void        use( const char* s )            { doUse(s,0); }
    virtual void        getPropsFrom(const IOPar&);
    virtual void        putPropsTo(IOPar&) const;

    static const char*  sKeyPropsFor()          { return "Properties for "; }
    static const char*  sKeyTreeProps()         { return "entire tree"; }

};


mExpClass(Strat) NodeUnitRef : public UnitRef
{
public:

                        NodeUnitRef(NodeUnitRef*,const char*,const char* d=0);
                        ~NodeUnitRef();
    void                setEmpty();

    virtual bool        isEmpty() const         { return refs_.isEmpty(); }
    virtual bool        hasChildren() const     { return !refs_.isEmpty(); }
    virtual bool        hasLeaves() const       = 0;

    virtual const OD::String& code() const      { return code_; }
    virtual void        setCode( const char* c ) { code_ = c; }

    virtual Interval<float> timeRange() const   { return timerg_; }
    virtual void        setTimeRange(const Interval<float>&);
    void                incTimeRange(const Interval<float>&);

    int                 nrRefs() const          { return refs_.size(); }
    UnitRef&            ref( int idx )          { return *refs_[idx]; }
    const UnitRef&      ref( int idx ) const    { return *refs_[idx]; }
    int                 indexOf( const UnitRef* ur ) const
                        { return refs_.indexOf((const NodeUnitRef*)ur); }
    virtual bool        isParentOf(const UnitRef&) const;

    UnitRef*            find( const char* urcode )      { return fnd(urcode); }
    const UnitRef*      find( const char* urcode ) const{ return fnd(urcode); }

    virtual int         nrLeaves() const;
    virtual int         level() const { return upnode_?upnode_->level()+1:0; }

protected:

    ObjectSet<UnitRef>  refs_;
    Interval<float>     timerg_;
    BufferString        code_;

    UnitRef*            fnd(const char*) const;
    void                takeChildrenFrom(NodeUnitRef*);
    void                changeTimeRange( float dtime);
    friend class        RefTree;

public:

    virtual bool        add(UnitRef*,bool rev=false);
    virtual bool        insert(UnitRef*,int posidx);
    virtual UnitRef*    replace(int uridx,UnitRef*);
    void                moveChild(int,bool up);
    void                remove( int uridx )
                        { delete refs_.removeSingle(uridx); }
    void                remove( const UnitRef* ur )
                        { remove( indexOf( ur ) ); }
    void                removeAllChildren()
                        { deepErase( refs_ ); }

    virtual void        getPropsFrom(const IOPar&);
    virtual void        putPropsTo(IOPar&) const;

};


mExpClass(Strat) NodeOnlyUnitRef : public NodeUnitRef
{
public:
                        NodeOnlyUnitRef( NodeUnitRef* up, const char* c,
                                     const char* d=0 )
                        : NodeUnitRef(up,c,d)   {}

    virtual bool        hasLeaves() const       { return false; }
    virtual Type        type() const            { return NodeOnly; }
    virtual const LeafUnitRef*  firstLeaf() const;

};


mExpClass(Strat) LeavedUnitRef : public NodeUnitRef
{
public:

    typedef Level::ID   LevelID;

                        LeavedUnitRef( NodeUnitRef* up, const char* c,
                                     const char* d=0 )
                        : NodeUnitRef(up,c,d)   {}

    virtual Type        type() const            { return Leaved; }
    virtual bool        hasLeaves() const       { return true; }

    LevelID             levelID() const         { return levelid_; }
    void                setLevelID(LevelID);

    virtual int         nrLeaves() const        { return refs_.size(); }
    virtual const LeafUnitRef*  firstLeaf() const
                        { return refs_.isEmpty() ? 0 : refs_[0]->firstLeaf(); }

    LeafUnitRef*        getLeaf(int);
    const LeafUnitRef*  getLeaf( int i ) const
                        { return const_cast<LeavedUnitRef*>(this)->getLeaf(i); }
    LeafUnitRef*        getLeaf(const Lithology&);
    const LeafUnitRef*  getLeaf( const Lithology& l ) const
                        { return const_cast<LeavedUnitRef*>(this)->getLeaf(l); }

protected:

    LevelID             levelid_;

    virtual void        fill( BufferString& bs ) const
                        { doFill(bs,levelid_); }
    virtual void        use( const char* s )    { doUse(s,levelid_); }

};


mExpClass(Strat) LeafUnitRef : public UnitRef
{
public:

                        LeafUnitRef(NodeUnitRef*,int lithidx=-1,
                                    const char* desc=0);
    virtual bool        isUndef() const;

    virtual Type        type() const            { return Leaf; }
    virtual bool        hasChildren() const     { return false; }
    virtual const OD::String& code() const;
    int                 lithology() const       { return lith_; }
    void                setLithology(int);

    const Lithology&    getLithology() const;
    Color               dispColor(bool lith_else_upnode) const;
    virtual int         level() const { return upnode_?upnode_->level()+1:0; }
    virtual const LeafUnitRef*  firstLeaf() const { return this; }

protected:

    int                 lith_; // TODO: use IntegerID

    virtual void        fill( BufferString& bs ) const  { doFill(bs,lith_); }
    virtual void        use( const char* s )    { doUse(s,&lith_); }


public:

    virtual void        getPropsFrom(const IOPar&);

};


inline NodeUnitRef* UnitRef::topNode()
{ return upnode_ ? upnode_->topNode() : (NodeUnitRef*)this; }
inline const NodeUnitRef* UnitRef::topNode() const
{ return upnode_ ? upnode_->topNode() : (NodeUnitRef*)this; }


}; // namespace Strat