ioobjctxt.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:          Aug 1996 / Sep 2016
________________________________________________________________________

-*/

#include "generalmod.h"
#include "namedobj.h"
#include "dbkey.h"
#include "enums.h"
#include "iopar.h"

class IOObj;
class IOStream;
class CtxtIOObj;
class Translator;
class TranslatorGroup;

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:

    typedef DBKey::GroupNrType  DBGroupNrType;
    typedef DBKey::DirID        DBDirID;

    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_;    
    bool                multi_;         

    bool                forread_;
    DBDirID             dirid_;         
    BufferString        deftransl_;     
    IOObjSelConstraints toselect_;

    bool                validIOObj(const IOObj&) const;

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

        DBDirID         id_;
        const char*     dirnm_;
        const char*     desc_;
    };

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

    FixedString         objectTypeName() const;
    FixedString         translatorGroupName() const;
    inline bool         hasStdSelDirID() const { return stdseltype_ != None; }
    DBDirID             getSelDirID() const;
    IOStream*           crDefaultWriteObj(const Translator&,
                                          const DBKey&) const;
    void                fillTrGroup() const;
    void                fixTranslator( const char* trusrnm )
                        { deftransl_ = toselect_.allowtransls_ = trusrnm; }

    mDeprecated StdSelType&             stdseltype = stdseltype_;
    mDeprecated const TranslatorGroup*& trgroup = trgroup_;
    mDeprecated bool&                   multi = multi_;
    mDeprecated bool&                   forread = forread_;
    mDeprecated BufferString&           deftransl = deftransl_;
    mDeprecated IOObjSelConstraints&    toselect = toselect_;
    mDeprecated DBDirID                 getSelKey() const
                                        { return getSelDirID(); }
};