SurveyFile Class Reference

Utility class to work with OpendTect survey/project zip files. More...

Public Member Functions
	SurveyFile (const char *zipfile, bool automount=false)
mDeprecatedObs	SurveyFile (const char *zipfile, const char *)
	~SurveyFile ()
uiRetVal	activate ()
uiRetVal	deactivate ()
uiRetVal	errMsg () const
BufferString	getSurveyDir () const
BufferString	getSurveyFile () const
BufferString	getTempBaseDir () const
const BufferString	getZipArchiveLocation () const
bool	isManaged () const
bool	isMounted () const
bool	isOK () const
uiRetVal	mount (bool isNew=false, TaskRunner *trun=nullptr)
uiRetVal	save (TaskRunner *trun=nullptr)
void	setManaged (bool yn)
uiRetVal	unmount (bool save=true, TaskRunner *trun=nullptr)

Static Public Member Functions
static const char *	bckupExtStr ()
static const char *	extStr ()
static BufferString	filtStr ()

Protected Member Functions
bool	createSurvey (TaskRunner *)
void	readSurveyDirNameFromFile ()

Protected Attributes
uiRetVal	lasterrs_
bool	mounted_ = false
BufferString	surveydirnm_
BufferString	surveyfile_
BufferString	tmpbasedir_

Detailed Description

Utility class to work with OpendTect survey/project zip files.

Encapsulates actions on a OpendTect survey/project zip file including:

• unpacking to a temporary base data folder (mount)
• making the unpacked survey the active survey (activate)

• cleaning up the unpacked folder back and optionally saving the survey back to a zip file with backup (unmount) The default extension for the survey/project files is ".odz". Backup files have an extension of "odz_bck". The destructor automatically deletes the temporary base folder and unpacked survey without saving.

  <>

Constructor & Destructor Documentation

SurveyFile() [1/2]

SurveyFile::SurveyFile	(	const char *	zipfile,
		bool	automount = false
	)

SurveyFile() [2/2]

mDeprecatedObs SurveyFile::SurveyFile	(	const char *	zipfile,
		const char *
	)

~SurveyFile()

SurveyFile::~SurveyFile

(

)

Member Function Documentation

activate()

uiRetVal SurveyFile::activate

(

)

bckupExtStr()

static const char* SurveyFile::bckupExtStr ( )

static

createSurvey()

bool SurveyFile::createSurvey ( TaskRunner *  )

protected

deactivate()

uiRetVal SurveyFile::deactivate

(

)

errMsg()

uiRetVal SurveyFile::errMsg ( ) const

inline

extStr()

static const char* SurveyFile::extStr ( )

inlinestatic

filtStr()

static BufferString SurveyFile::filtStr ( )

static

getSurveyDir()

BufferString SurveyFile::getSurveyDir ( ) const

inline

getSurveyFile()

BufferString SurveyFile::getSurveyFile ( ) const

inline

getTempBaseDir()

BufferString SurveyFile::getTempBaseDir ( ) const

inline

getZipArchiveLocation()

const BufferString SurveyFile::getZipArchiveLocation ( ) const

inline

isManaged()

bool SurveyFile::isManaged

(

)

const

isMounted()

bool SurveyFile::isMounted ( ) const

inline

isOK()

bool SurveyFile::isOK ( ) const

inline

mount()

uiRetVal SurveyFile::mount	(	bool	isNew = false,
		TaskRunner *	trun = nullptr
	)

readSurveyDirNameFromFile()

void SurveyFile::readSurveyDirNameFromFile ( )

protected

save()

uiRetVal SurveyFile::save

(

TaskRunner *

trun = nullptr

)

setManaged()

void SurveyFile::setManaged

(

bool

yn

)

unmount()

uiRetVal SurveyFile::unmount	(	bool	save = true,
		TaskRunner *	trun = nullptr
	)

Member Data Documentation

lasterrs_

uiRetVal SurveyFile::lasterrs_

protected

mounted_

bool SurveyFile::mounted_ = false

protected

surveydirnm_

BufferString SurveyFile::surveydirnm_

protected

surveyfile_

BufferString SurveyFile::surveyfile_

protected

tmpbasedir_

BufferString SurveyFile::tmpbasedir_

protected