filespec.h

Go to the documentation of this file.

#ifndef filespec_h
#define filespec_h

/*+
________________________________________________________________________

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

-*/

#include "basicmod.h"
#include "bufstringset.h"
#include "ranges.h"


mExpClass(Basic) FileSpec
{
public:

                        FileSpec(const char* fnm=0);
                        FileSpec(const IOPar&);

    BufferStringSet     fnames_;
    StepInterval<int>   nrs_;
    int                 zeropad_;       
    BufferString        survsubdir_;    

    bool                isEmpty() const
                        { return fnames_.isEmpty() || fnames_.get(0).isEmpty();}
    bool                isMulti() const         { return nrFiles() > 1; }
    bool                isRangeMulti() const;

    int                 nrFiles() const;
    const char*         fileName(int nr=0) const;
    const char*         absFileName(int nr=0) const; 
    const char*         dirName() const;        
    const char*         fullDirName() const;    

    const char*         dispName() const;       
    const char*         usrStr() const;         
    void                setUsrStr( const char* str ) { usrstr_ = str; }

    void                setEmpty()
                        { fnames_.setEmpty(); mSetUdf(nrs_.start); }
    void                setFileName( const char* nm )
                        { setEmpty(); if ( nm && *nm ) fnames_.add(nm);}
    void                ensureBaseDir(const char* dirnm);
    void                makeAbsoluteIfRelative(const char* dirnm);

    void                fillPar(IOPar&) const;
    bool                usePar(const IOPar&);
    void                getReport(IOPar&) const;
    static const char*  sKeyFileNrs();

    void                makePathsRelative(const char* todir=0);
                        //< default is survey directory
    static void         makePathsRelative(IOPar&,const char* todir=0);
                        //< default is survey directory

    void                getMultiFromString(const char*);

protected:

    BufferString        usrstr_;

};


#endif