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

>Provides file download facility More...

Inheritance diagram for FileDownloader:
[legend]

Public Member Functions

 FileDownloader (const char *url)
 
 FileDownloader (const char *url, DataBuffer *db)
 
 FileDownloader (const BufferStringSet &urls, const BufferStringSet &outputpaths)
 
 ~FileDownloader ()
 
od_int64 getDownloadSize ()
 
uiString uiMessage () const
 will be message() again in 7.x More...
 
int nextStep ()
 
od_int64 nrDone () const
 
uiString uiNrDoneText () const
 will be nrDoneText() in 7.x More...
 
od_int64 totalNr () const
 
- Public Member Functions inherited from SequentialTask
 SequentialTask (const char *nm=0)
 
virtual ~SequentialTask ()
 
void setProgressMeter (ProgressMeter *)
 Must be called before execute() More...
 
ProgressMeterprogressMeter ()
 
const ProgressMeterprogressMeter () const
 
virtual int doStep ()
 
bool execute ()
 
- Public Member Functions inherited from Task
virtual ~Task ()
 
virtual void enableWorkControl (bool=true)
 Must be called before execute() More...
 
bool workControlEnabled () const
 
virtual void controlWork (Control)
 
virtual Control getState () const
 
- Public Member Functions inherited from NamedObject
 NamedObject (const char *nm=0)
 
 NamedObject (const NamedObject *linkedto)
 
 NamedObject (const NamedObject &)
 
virtual ~NamedObject ()
 
void setLinkedTo (NamedObject *)
 
bool operator== (const NamedObject &oth) const
 
virtual const OD::Stringname () const
 
virtual const OD::StringannotName () const
 
virtual void setName (const char *)
 
void setCleanName (const char *)
 cleans string first More...
 
void deleteNotify (const CallBack &)
 
- Public Member Functions inherited from CallBacker
 CallBacker ()
 
 CallBacker (const CallBacker &)
 
virtual ~CallBacker ()
 
bool attachCB (NotifierAccess &, const CallBack &, bool onlyifnew=false)
 
bool attachCB (NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false)
 
void detachCB (NotifierAccess &, const CallBack &)
 
void detachCB (NotifierAccess *notif, const CallBack &cb)
 
bool isNotifierAttached (NotifierAccess *) const
 Only for debugging purposes, don't use. More...
 

Protected Member Functions

void setSaveAsPaths (const BufferStringSet &, const char *)
 
int errorOccured ()
 
bool writeData ()
 
bool writeDataToFile (const char *buffer, int size)
 
bool writeDataToBuffer (const char *buffer, int size)
 
- Protected Member Functions inherited from Task
 Task (const char *nm=0)
 
virtual bool shouldContinue ()
 
- Protected Member Functions inherited from CallBacker
void detachAllNotifiers ()
 Call from the destructor of your inherited object. More...
 

Protected Attributes

bool initneeded_
 
BufferStringSet urls_
 
BufferStringSet saveaspaths_
 
int nrfilesdownloaded_
 
DataBufferdatabuffer_
 
od_ostreamosd_
 
QEventLoop * qeventloop_
 
ODNetworkReplyodnr_
 
od_int64 nrdone_
 
od_int64 totalnr_
 
uiString msg_
 
- Protected Attributes inherited from SequentialTask
ProgressMeterprogressmeter_
 
int lastupdate_
 
- Protected Attributes inherited from Task
Control control_
 
Threads::ConditionVarworkcontrolcondvar_
 
- Protected Attributes inherited from NamedObject
BufferStringname_
 
NamedObjectlinkedto_
 
CallBackSetdelnotify_
 

Private Member Functions

 mODTextTranslationClass (FileDownloader)
 

Additional Inherited Members

- Public Types inherited from Task
enum  Control { Run, Pause, Stop }
 
- Static Public Member Functions inherited from SequentialTask
static int ErrorOccurred ()
 
static int Finished ()
 
static int MoreToDo ()
 
static int WarningAvailable ()
 
- Static Public Member Functions inherited from Task
static uiString stdNrDoneText ()
 
static uiString uiStdNrDoneText ()
 

Detailed Description

>Provides file download facility

Constructor & Destructor Documentation

FileDownloader::FileDownloader ( const char *  url)
FileDownloader::FileDownloader ( const char *  url,
DataBuffer db 
)
FileDownloader::FileDownloader ( const BufferStringSet urls,
const BufferStringSet outputpaths 
)
FileDownloader::~FileDownloader ( )

Member Function Documentation

int FileDownloader::errorOccured ( )
protected
od_int64 FileDownloader::getDownloadSize ( )
FileDownloader::mODTextTranslationClass ( FileDownloader  )
private
int FileDownloader::nextStep ( )
virtual
Return values
MoreToDo()Not finished. Call me again.
Finished()Nothing more to do.
ErrorOccurred()Something went wrong.
Note
if function returns a value greater than cMoreToDo(), it should be interpreted as cMoreToDo().

Implements SequentialTask.

od_int64 FileDownloader::nrDone ( ) const
virtual
Note
nrDone is only used for displaying progress and will be compared to totalNr to show user how large part of the task that is finished.

Reimplemented from Task.

void FileDownloader::setSaveAsPaths ( const BufferStringSet ,
const char *   
)
protected
od_int64 FileDownloader::totalNr ( ) const
virtual

Reimplemented from Task.

uiString FileDownloader::uiMessage ( ) const
virtual

will be message() again in 7.x

Note
totalNr is only used for displaying progress.

Reimplemented from Task.

uiString FileDownloader::uiNrDoneText ( ) const
virtual

will be nrDoneText() in 7.x

Reimplemented from Task.

bool FileDownloader::writeData ( )
protected
bool FileDownloader::writeDataToBuffer ( const char *  buffer,
int  size 
)
protected
bool FileDownloader::writeDataToFile ( const char *  buffer,
int  size 
)
protected

Member Data Documentation

DataBuffer* FileDownloader::databuffer_
protected
bool FileDownloader::initneeded_
protected
uiString FileDownloader::msg_
protected
od_int64 FileDownloader::nrdone_
protected
int FileDownloader::nrfilesdownloaded_
protected
ODNetworkReply* FileDownloader::odnr_
protected
od_ostream* FileDownloader::osd_
protected
QEventLoop* FileDownloader::qeventloop_
protected
BufferStringSet FileDownloader::saveaspaths_
protected
od_int64 FileDownloader::totalnr_
protected
BufferStringSet FileDownloader::urls_
protected

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