OpendTect  7.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
NearestCoordFinder Class Reference

Find nearest coordinate in a TypeSet. More...

Inheritance diagram for NearestCoordFinder:
[legend]

Public Member Functions

 NearestCoordFinder (const TypeSet< Coord3 > &, const Coord3 &)
 
 ~NearestCoordFinder ()
 
double nearestDistance () const
 
int nearestIndex () const
 
- Public Member Functions inherited from ParallelTask
virtual ~ParallelTask ()
 
void doParallel (bool yn)
 
bool execute () override
 
virtual bool executeParallel (bool parallel)
 
std::int64_t nrDone () const override
 May be -1, i.e. class does not report nrdone. More...
 
std::int64_t totalNr () const 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
 
virtual uiString uiMessage () const
 will be message() again in 7.x More...
 
virtual uiString uiNrDoneText () const
 will be nrDoneText() in 7.x More...
 
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 Member Functions

bool doFinish (bool success) override
 
bool doPrepare (int nrthreads) override
 
bool doWork (od_int64, od_int64, int) override
 
od_int64 nrIterations () const override
 
- Protected Member Functions inherited from ParallelTask
 ParallelTask (const char *nm=0)
 
 ParallelTask (const ParallelTask &)
 
void addToNrDone (std::int64_t increment)
 
std::int64_t calculateThreadSize (std::int64_t totalnr, int nrthreads, int thread) const
 
virtual int maxNrThreads () const
 
virtual int minThreadSize () const
 
void quickAddToNrDone (std::int64_t loopidx)
 
void resetNrDone ()
 
virtual bool stopAllOnFailure () const
 
- 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
 

Protected Attributes

Coord3 crd_
 
const TypeSet< Coord3 > & crds_
 
TypeSet< double > mindists_
 
TypeSet< int > minidxs_
 
double nearestdist_ = mUdf(double)
 
int nearestidx_ = -1
 
- 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 ParallelTask
static uiString sPosFinished ()
 
static uiString sTrcFinished ()
 
- 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 ReportingTask
Notifier< ReportingTaskprogressUpdated
 

Detailed Description

Find nearest coordinate in a TypeSet.

<>

Constructor & Destructor Documentation

◆ NearestCoordFinder()

NearestCoordFinder::NearestCoordFinder ( const TypeSet< Coord3 > &  ,
const Coord3  
)

◆ ~NearestCoordFinder()

NearestCoordFinder::~NearestCoordFinder ( )

Member Function Documentation

◆ doFinish()

bool NearestCoordFinder::doFinish ( bool  success)
overrideprotectedvirtual

Called after all doWork have finished.

Parameters
successindicates whether all doWork returned true.

Reimplemented from ParallelTask.

◆ doPrepare()

bool NearestCoordFinder::doPrepare ( int  nrthreads)
overrideprotectedvirtual

Called once, before any doWork is called.

Reimplemented from ParallelTask.

◆ doWork()

bool NearestCoordFinder::doWork ( od_int64  ,
od_int64  ,
int   
)
overrideprotected

◆ nearestDistance()

double NearestCoordFinder::nearestDistance ( ) const
inline

◆ nearestIndex()

int NearestCoordFinder::nearestIndex ( ) const
inline

◆ nrIterations()

od_int64 NearestCoordFinder::nrIterations ( ) const
overrideprotectedvirtual
Returns
the number of times the process should be run.

Implements ParallelTask.

Member Data Documentation

◆ crd_

Coord3 NearestCoordFinder::crd_
protected

◆ crds_

const TypeSet<Coord3>& NearestCoordFinder::crds_
protected

◆ mindists_

TypeSet<double> NearestCoordFinder::mindists_
protected

◆ minidxs_

TypeSet<int> NearestCoordFinder::minidxs_
protected

◆ nearestdist_

double NearestCoordFinder::nearestdist_ = mUdf(double)
protected

◆ nearestidx_

int NearestCoordFinder::nearestidx_ = -1
protected

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