OpendTect  6.6
Public Member Functions | Protected Attributes | List of all members
VelocityModelScanner Class Reference
Inheritance diagram for VelocityModelScanner:
[legend]

Public Member Functions

 VelocityModelScanner (const IOObj &, const VelocityDesc &)
 
 ~VelocityModelScanner ()
 
const Interval< float > & getBotVAvg () const
 
const Interval< float > & getTopVAvg () const
 
int nextStep ()
 
od_int64 nrDone () const
 
od_int64 totalNr () const
 
uiString uiMessage () const
 will be message() again in 7.x More...
 
uiString uiNrDoneText () const
 will be nrDoneText() in 7.x More...
 
- Public Member Functions inherited from SequentialTask
 SequentialTask (const char *nm=nullptr)
 
virtual ~SequentialTask ()
 
virtual int doStep ()
 
bool execute ()
 
ProgressMeterprogressMeter ()
 
const ProgressMeterprogressMeter () const
 
void setProgressMeter (ProgressMeter *)
 Must be called before execute() More...
 
- 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
 
- 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 &)
 
virtual const name_typename () const
 
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

bool definedv0_
 
bool definedv1_
 
TrcKeySamplingIterator hsiter_
 
uiString msg_
 
int nrdone_
 
const IOObjobj_
 
SeisTrcReaderreader_
 
Interval< float > startavgvel_
 
Interval< float > stopavgvel_
 
TrcKeySampling subsel_
 
const VelocityDescvd_
 
bool zistime_
 
- Protected Attributes inherited from SequentialTask
int lastupdate_
 
ProgressMeterprogressmeter_
 
- 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 ()
 
- 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

Scans a velocity model for minimum top/bottom average velocity.

<>

Constructor & Destructor Documentation

◆ VelocityModelScanner()

VelocityModelScanner::VelocityModelScanner ( const IOObj ,
const VelocityDesc  
)

◆ ~VelocityModelScanner()

VelocityModelScanner::~VelocityModelScanner ( )

Member Function Documentation

◆ getBotVAvg()

const Interval<float>& VelocityModelScanner::getBotVAvg ( ) const
inline

◆ getTopVAvg()

const Interval<float>& VelocityModelScanner::getTopVAvg ( ) const
inline

◆ nextStep()

int VelocityModelScanner::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.

◆ nrDone()

od_int64 VelocityModelScanner::nrDone ( ) const
inlinevirtual
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.

◆ totalNr()

od_int64 VelocityModelScanner::totalNr ( ) const
inlinevirtual

Reimplemented from Task.

◆ uiMessage()

uiString VelocityModelScanner::uiMessage ( ) const
inlinevirtual

will be message() again in 7.x

Reimplemented from Task.

◆ uiNrDoneText()

uiString VelocityModelScanner::uiNrDoneText ( ) const
inlinevirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

Member Data Documentation

◆ definedv0_

bool VelocityModelScanner::definedv0_
protected

◆ definedv1_

bool VelocityModelScanner::definedv1_
protected

◆ hsiter_

TrcKeySamplingIterator VelocityModelScanner::hsiter_
protected

◆ msg_

uiString VelocityModelScanner::msg_
protected

◆ nrdone_

int VelocityModelScanner::nrdone_
protected

◆ obj_

const IOObj& VelocityModelScanner::obj_
protected

◆ reader_

SeisTrcReader* VelocityModelScanner::reader_
protected

◆ startavgvel_

Interval<float> VelocityModelScanner::startavgvel_
protected

◆ stopavgvel_

Interval<float> VelocityModelScanner::stopavgvel_
protected

◆ subsel_

TrcKeySampling VelocityModelScanner::subsel_
protected

◆ vd_

const VelocityDesc& VelocityModelScanner::vd_
protected

◆ zistime_

bool VelocityModelScanner::zistime_
protected

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