ctxtioobj.h

Go to the documentation of this file.

#ifndef ctxtioobj_h
#define ctxtioobj_h

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H. Bril
 Date:          7-1-1996
 RCS:           $Id$
________________________________________________________________________

-*/

#include "generalmod.h"
#include "namedobj.h"
#include "multiid.h"
#include "enums.h"
#include "ioobj.h"
#include "iopar.h"

class TranslatorGroup;
class IOStream;

mExpClass(General) IOObjSelConstraints
{
public:

                        IOObjSelConstraints();
                        IOObjSelConstraints(const IOObjSelConstraints&);
                        ~IOObjSelConstraints();
    IOObjSelConstraints& operator =(const IOObjSelConstraints&);

    IOPar&              require_;
    IOPar&              dontallow_;

    BufferString        allowtransls_;  
    bool                allownonuserselectable_; 

    bool                isGood(const IOObj&,bool forread=true) const;
    void                clear();

    static bool         isAllowedTranslator(const char* tnm,const char* allowd);

};


mExpClass(General) IOObjContext : public NamedObject
{
public:

    enum StdSelType     { Seis=0, Surf, Loc, Feat, WllInf, NLA, Misc, Attr, Mdl,
                          Geom, None };
                        mDeclareEnumUtils(StdSelType);

                        IOObjContext(const TranslatorGroup*,
                                     const char* prefname=0);
                        IOObjContext(const IOObjContext&);

    IOObjContext&       operator =(const IOObjContext&);

    StdSelType          stdseltype_;
    const TranslatorGroup* trgroup_;    
    int                 newonlevel_;    
    bool                multi_;         

    bool                forread_;
    MultiID             selkey_;        
    bool                maydooper_;     
    BufferString        deftransl_;     
    IOObjSelConstraints toselect_;

    bool                validIOObj(const IOObj&) const;

    struct StdDirData
    {
                                        StdDirData(const char*,const char*,
                                                   const char*);

        const char*                     id_;
        const char*                     dirnm_;
        const char*                     desc_;

        mDeprecated const char*&        id;
        mDeprecated const char*&        dirnm;
        mDeprecated const char*&        desc;
    };

    static int                  totalNrStdDirs();
    static const StdDirData*    getStdDirData(StdSelType);
    static BufferString         getDataDirName(StdSelType);

    const char*         objectTypeName() const;
    inline bool         hasStdSelKey() const    { return stdseltype_ != None; }
    MultiID             getSelKey() const;
    IOStream*           crDefaultWriteObj(const Translator&,
                                          const MultiID&) const;
    void                fillTrGroup() const;
    void                fixTranslator( const char* trusrnm )
                        { deftransl_ = toselect_.allowtransls_ = trusrnm; }

    mDeprecated StdSelType&             stdseltype;
    mDeprecated const TranslatorGroup*& trgroup;
    mDeprecated int&                    newonlevel;
    mDeprecated bool&                   multi;
    mDeprecated bool&                   forread;
    mDeprecated MultiID&                selkey;
    mDeprecated bool&                   maydooper;
    mDeprecated BufferString&           deftransl;
    mDeprecated IOObjSelConstraints&    toselect;
};


mExpClass(General) CtxtIOObj : public NamedObject
{
public:
    mStartAllowDeprecatedSection
                        CtxtIOObj( const IOObjContext& ct, IOObj* o=0 )
                            : NamedObject(""), ctxt_(ct), ioobj_(o), iopar_(0)
                            , ctxt(ctxt_), ioobj(ioobj_), iopar(iopar_)
                        { setLinkedTo(&ctxt_); }
                        CtxtIOObj( const CtxtIOObj& ct )
                            : NamedObject(""), ctxt_(ct.ctxt_)
                            , ioobj_(ct.ioobj_?ct.ioobj_->clone():0)
                            , iopar_(ct.iopar_?new IOPar(*ct.iopar_):0)
                            , ctxt(ctxt_), ioobj(ioobj_), iopar(iopar_)
                        { setLinkedTo(&ctxt_); }
    mStopAllowDeprecatedSection
    void                destroyAll();

    void                setObj(IOObj*); 
    void                setObj(const MultiID&); 
    void                setPar(IOPar*); 
    int                 fillObj(bool mktmpifnew=false,int translidxfornew=-1);
    void                fillIfOnlyOne();
    void                fillDefault(bool alsoifonlyone=true);
    void                fillDefaultWithKey(const char*,bool alsoifonlyone=true);

    IOObjContext                ctxt_;
    IOObj*                      ioobj_;
    IOPar*                      iopar_;

    //Legacy
    mDeprecated IOObjContext&   ctxt;
    mDeprecated IOObj*&         ioobj;
    mDeprecated IOPar*&         iopar;
};


#endif