OpendTect-6_4  6.4
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
FileSpec Class Reference

Specification for one or more files. More...

Inheritance diagram for FileSpec:
[legend]

Public Member Functions

 FileSpec (const char *fnm=0)
 
 FileSpec (const IOPar &)
 
bool isEmpty () const
 
bool isMulti () const
 
bool isRangeMulti () const
 
int nrFiles () const
 
const char * fileName (int nr=0) const
 
const char * absFileName (int nr=0) const
 adds path if necessary More...
 
const char * dirName () const
 only the dir name More...
 
const char * fullDirName () const
 full name of dir More...
 
const char * dispName () const
 for titles etc More...
 
const char * usrStr () const
 a user-typed filename More...
 
void setUsrStr (const char *str)
 
void setEmpty ()
 
void setFileName (const char *nm)
 
void ensureBaseDir (const char *dirnm)
 
void makeAbsoluteIfRelative (const char *dirnm)
 
void fillPar (IOPar &) const
 
bool usePar (const IOPar &)
 
void getReport (IOPar &) const
 
void makePathsRelative (const char *todir=0)
 
void getMultiFromString (const char *)
 

Static Public Member Functions

static const char * sKeyFileNrs ()
 
static void makePathsRelative (IOPar &, const char *todir=0)
 

Public Attributes

BufferStringSet fnames_
 
StepInterval< int > nrs_
 
int zeropad_
 left-pad the nrs_ to this length More...
 
BufferString survsubdir_
 For example "Seismics". More...
 

Protected Attributes

BufferString usrstr_
 

Detailed Description

Specification for one or more files.

If the paths are not absolute, they will be considered relative to the current survey directory. If you work with relative pathnames, you can specify a subdir-from-survey-dir.

Constructor & Destructor Documentation

FileSpec::FileSpec ( const char *  fnm = 0)
FileSpec::FileSpec ( const IOPar )

Member Function Documentation

const char* FileSpec::absFileName ( int  nr = 0) const

adds path if necessary

const char* FileSpec::dirName ( ) const

only the dir name

const char* FileSpec::dispName ( ) const

for titles etc

void FileSpec::ensureBaseDir ( const char *  dirnm)
const char* FileSpec::fileName ( int  nr = 0) const
void FileSpec::fillPar ( IOPar ) const
const char* FileSpec::fullDirName ( ) const

full name of dir

void FileSpec::getMultiFromString ( const char *  )
void FileSpec::getReport ( IOPar ) const
bool FileSpec::isEmpty ( ) const
inline
bool FileSpec::isMulti ( ) const
inline
bool FileSpec::isRangeMulti ( ) const
void FileSpec::makeAbsoluteIfRelative ( const char *  dirnm)
void FileSpec::makePathsRelative ( const char *  todir = 0)
static void FileSpec::makePathsRelative ( IOPar ,
const char *  todir = 0 
)
static
int FileSpec::nrFiles ( ) const
void FileSpec::setEmpty ( )
inline
void FileSpec::setFileName ( const char *  nm)
inline
void FileSpec::setUsrStr ( const char *  str)
inline
static const char* FileSpec::sKeyFileNrs ( )
static
bool FileSpec::usePar ( const IOPar )
const char* FileSpec::usrStr ( ) const

a user-typed filename

Member Data Documentation

BufferStringSet FileSpec::fnames_
StepInterval<int> FileSpec::nrs_
BufferString FileSpec::survsubdir_

For example "Seismics".

BufferString FileSpec::usrstr_
protected
int FileSpec::zeropad_

left-pad the nrs_ to this length


Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B. V. 2019