ctxtioobj.h

Go to the documentation of this file.

#pragma once
 
/*+
________________________________________________________________________
 
 (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("Use id_")          const char*&    id;
        mDeprecated("Use dirnm_")       const char*&    dirnm;
        mDeprecated("Use desc_")        const char*&    desc;
    };
 
    static int                  totalNrStdDirs();
    static const StdDirData*    getStdDirData(StdSelType);
    static BufferString         getDataDirName(StdSelType);
    static BufferString         getDataDirName(StdSelType,bool dironly);
 
    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; }
 
    int                 nrMatches() const;
    inline bool         haveMatches() const { return nrMatches() > 0; }
 
    mDeprecated("Use stdseltype_")      StdSelType&             stdseltype;
    mDeprecated("Use trgroup_")         const TranslatorGroup*& trgroup;
    mDeprecated("Use newonlevel_")      int&                    newonlevel;
    mDeprecated("Use multi_")           bool&                   multi;
    mDeprecated("Use forread_")         bool&                   forread;
    mDeprecated("Use selkey_")          MultiID&                selkey;
    mDeprecated("Use maydooper_")       bool&                   maydooper;
    mDeprecated("Use deftransl_")       BufferString&           deftransl;
    mDeprecated("Use toselect_")        IOObjSelConstraints&    toselect;
};
 
 
mExpClass(General) CtxtIOObj : public NamedObject
{
public:
    mStartAllowDeprecatedSection
                        CtxtIOObj( const IOObjContext& ct, IOObj* o=0 )
                            : NamedObject(ct), ctxt_(ct), ioobj_(o) , iopar_(0)
                            , ctxt(ctxt_), ioobj(ioobj_), iopar(iopar_)
                        { if ( o ) setName(o->name()); }
                        CtxtIOObj( const CtxtIOObj& ct )
                            : NamedObject(ct), ctxt_(ct.ctxt_)
                            , ioobj_(ct.ioobj_?ct.ioobj_->clone():0)
                            , iopar_(ct.iopar_?new IOPar(*ct.iopar_):0)
                            , ctxt(ctxt_), ioobj(ioobj_), iopar(iopar_)
                        {}
    mStopAllowDeprecatedSection
    void                destroyAll();
 
    virtual const OD::String& name() const      { return ctxt_.name(); }
    virtual void        setName(const char* nm) { ctxt_.setName(nm); }
    virtual BufferString getName() const        { return ctxt_.getName(); }
 
    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("Use ctxt_")    IOObjContext&   ctxt;
    mDeprecated("Use ioobj_")   IOObj*&         ioobj;
    mDeprecated("Use iopar_")   IOPar*&         iopar;
};