OpendTect  7.0
Public Member Functions | Protected Attributes | List of all members
Well::InfoCollector Class Reference

Collects information about all wells in store. More...

Inheritance diagram for Well::InfoCollector:
[legend]

Public Member Functions

 InfoCollector (bool wellloginfo=true, bool markers=true, bool trackinfo=false)
 
 ~InfoCollector ()
 
void getAllLogNames (BufferStringSet &) const
 
void getAllMarkerInfos (BufferStringSet &nms, TypeSet< OD::Color > &colors) const
 
const Interval< float > getTracksTVDRange () const
 
const TypeSet< MultiID > & ids () const
 
const ObjectSet< Info > & infos () const
 Same size as ids() More...
 
const ObjectSet< BufferStringSet > & logs () const
 If selected, same size as ids() More...
 
const ObjectSet< MarkerSet > & markers () const
 If selected, same size as ids() More...
 
int nextStep () override
 
od_int64 nrDone () const override
 
void setSurvey (const SurveyDiskLocation &)
 
SurveyDiskLocationsurvey () const
 
od_int64 totalNr () const override
 
uiString uiMessage () const override
 will be message() again in 7.x More...
 
uiString uiNrDoneText () const override
 will be nrDoneText() in 7.x More...
 
- Public Member Functions inherited from Executor
 Executor (const char *nm)
 
virtual ~Executor ()
 
int doStep () override
 
bool execute () override
 
bool go (od_ostream &s, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
 
bool go (od_ostream *s=0, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
 
- Public Member Functions inherited from SequentialTask
 SequentialTask (const char *nm=nullptr)
 
virtual ~SequentialTask ()
 
bool execute () override
 
- Public Member Functions inherited from ReportingTask
virtual ~ReportingTask ()
 
void getProgress (const ReportingTask &)
 
- Public Member Functions inherited from Task
virtual ~Task ()
 
virtual void controlWork (Control)
 
virtual void enableWorkControl (bool=true)
 Must be called before execute() More...
 
virtual uiRetVal errorWithDetails () const
 
virtual Control getState () const
 
bool workControlEnabled () const
 
- Public Member Functions inherited from NamedCallBacker
 NamedCallBacker (const char *nm=0)
 
 NamedCallBacker (const NamedCallBacker &)
 
virtual Notifier< NamedCallBacker > & objectToBeDeleted () const
 
bool operator== (const NamedCallBacker &oth) const
 
bool operator== (const NamedObject &oth) const
 
- Public Member Functions inherited from CallBacker
 CallBacker ()
 
 CallBacker (const CallBacker &)
 
virtual ~CallBacker ()
 
bool attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const
 
bool attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const
 
void detachAllNotifiers () const
 Call from the destructor of your inherited object. More...
 
void detachCB (const NotifierAccess &, const CallBack &) const
 
void detachCB (const NotifierAccess *notif, const CallBack &cb) const
 
virtual bool isCapsule () const
 
bool isNotifierAttached (const NotifierAccess *) const
 Only for debugging purposes, don't use. More...
 
void stopReceivingNotifications () const
 
virtual CallBackertrueCaller ()
 
- Public Member Functions inherited from NamedObject
 NamedObject (const char *nm=nullptr)
 
 NamedObject (const NamedObject &oth)
 
virtual ~NamedObject ()
 
virtual BufferString getName () const
 
bool getNameFromPar (const IOPar &)
 
const name_typename () const override
 
NamedObjectoperator= (const NamedObject &)
 
bool operator== (const NamedObject &oth) const
 
virtual void setName (const char *nm)
 
- Public Member Functions inherited from ObjectWithName
virtual ~ObjectWithName ()
 
bool hasName (const char *nm) const
 
bool hasName (const name_type &nm) const
 
void putNameInPar (IOPar &) const
 

Protected Attributes

int curidx_
 
uiString curmsg_
 
IODirEntryListdirentries_
 
bool dologs_
 
bool domrkrs_
 
bool dotracks_
 
TypeSet< MultiIDids_
 
ObjectSet< Infoinfos_
 
const IODiriodir_
 
ObjectSet< BufferStringSetlogs_
 
ObjectSet< MarkerSetmarkers_
 
SurveyDiskLocationsurvloc_
 
int totalnr_
 
Interval< float > trackstvdrg_
 
- Protected Attributes inherited from Task
Control control_
 
Threads::ConditionVarworkcontrolcondvar_
 
- Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool > delalreadytriggered_
 
Notifier< NamedCallBackerdelnotif_
 
- Protected Attributes inherited from NamedObject
BufferString name_
 

Additional Inherited Members

- Public Types inherited from Task
enum  Control { Run , Pause , Stop }
 
- Public Types inherited from ObjectWithName
typedef OD::String name_type
 
- 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 ()
 
- Static Public Member Functions inherited from CallBacker
static void createReceiverForCurrentThread ()
 
static void removeReceiverForCurrentThread ()
 
- Public Attributes inherited from Executor
Notifier< Executorpoststep
 Only when MoreToDo will be returned. More...
 
Notifier< Executorprestep
 
- Public Attributes inherited from ReportingTask
Notifier< ReportingTaskprogressUpdated
 
- Protected Member Functions inherited from Executor
virtual bool goImpl (od_ostream *, bool, bool, int)
 
- Protected Member Functions inherited from ReportingTask
 ReportingTask (const char *nm=nullptr)
 
void incrementProgress ()
 
ProgressMeterprogressMeter () const
 
void reportProgressFinished ()
 
void reportProgressStarted ()
 
void resetProgress ()
 
void setProgressMeter (ProgressMeter *) override
 Must be called before execute() More...
 
void updateProgressMeter (bool forced=false, std::int64_t *totalnr=0)
 
void updateReportedName ()
 
- Protected Member Functions inherited from Task
 Task (const char *nm=nullptr)
 
virtual bool shouldContinue ()
 
- Protected Member Functions inherited from NamedCallBacker
void sendDelNotif () const
 

Detailed Description

Collects information about all wells in store.

<>

Constructor & Destructor Documentation

◆ InfoCollector()

Well::InfoCollector::InfoCollector ( bool  wellloginfo = true,
bool  markers = true,
bool  trackinfo = false 
)

◆ ~InfoCollector()

Well::InfoCollector::~InfoCollector ( )

Member Function Documentation

◆ getAllLogNames()

void Well::InfoCollector::getAllLogNames ( BufferStringSet ) const

◆ getAllMarkerInfos()

void Well::InfoCollector::getAllMarkerInfos ( BufferStringSet nms,
TypeSet< OD::Color > &  colors 
) const

◆ getTracksTVDRange()

const Interval<float> Well::InfoCollector::getTracksTVDRange ( ) const
inline

◆ ids()

const TypeSet<MultiID>& Well::InfoCollector::ids ( ) const
inline

◆ infos()

const ObjectSet<Info>& Well::InfoCollector::infos ( ) const
inline

Same size as ids()

◆ logs()

const ObjectSet<BufferStringSet>& Well::InfoCollector::logs ( ) const
inline

If selected, same size as ids()

◆ markers()

const ObjectSet<MarkerSet>& Well::InfoCollector::markers ( ) const
inline

If selected, same size as ids()

◆ nextStep()

int Well::InfoCollector::nextStep ( )
overridevirtual
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.

◆ nrDone()

od_int64 Well::InfoCollector::nrDone ( ) const
inlineoverridevirtual
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.

◆ setSurvey()

void Well::InfoCollector::setSurvey ( const SurveyDiskLocation )

◆ survey()

SurveyDiskLocation& Well::InfoCollector::survey ( ) const

◆ totalNr()

od_int64 Well::InfoCollector::totalNr ( ) const
inlineoverridevirtual

Reimplemented from Task.

◆ uiMessage()

uiString Well::InfoCollector::uiMessage ( ) const
inlineoverridevirtual

will be message() again in 7.x

Reimplemented from Task.

◆ uiNrDoneText()

uiString Well::InfoCollector::uiNrDoneText ( ) const
inlineoverridevirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

Member Data Documentation

◆ curidx_

int Well::InfoCollector::curidx_
protected

◆ curmsg_

uiString Well::InfoCollector::curmsg_
protected

◆ direntries_

IODirEntryList* Well::InfoCollector::direntries_
protected

◆ dologs_

bool Well::InfoCollector::dologs_
protected

◆ domrkrs_

bool Well::InfoCollector::domrkrs_
protected

◆ dotracks_

bool Well::InfoCollector::dotracks_
protected

◆ ids_

TypeSet<MultiID> Well::InfoCollector::ids_
protected

◆ infos_

ObjectSet<Info> Well::InfoCollector::infos_
protected

◆ iodir_

const IODir* Well::InfoCollector::iodir_
protected

◆ logs_

ObjectSet<BufferStringSet> Well::InfoCollector::logs_
protected

◆ markers_

ObjectSet<MarkerSet> Well::InfoCollector::markers_
protected

◆ survloc_

SurveyDiskLocation& Well::InfoCollector::survloc_
protected

◆ totalnr_

int Well::InfoCollector::totalnr_
protected

◆ trackstvdrg_

Interval<float> Well::InfoCollector::trackstvdrg_
protected

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