Well::TrackSampler Class Reference

Collects positions along selected well tracks. The DataPointSet will get new rows with the positions along the track. More...

Inheritance diagram for Well::TrackSampler:

Public Member Functions
	TrackSampler (const TypeSet< MultiID > &ioobjids, ObjectSet< DataPointSet > &, bool zvalsintime)
	~TrackSampler ()
ObjectSet< DataPointSet > &	dataPointSets ()
uiString	errMsg () const
const TypeSet< MultiID > &	ioObjIds () const
int	nextStep () override
od_int64	nrDone () const override
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...
void	usePar (const IOPar &)
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 CallBacker *	trueCaller ()
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_type &	name () const override
NamedObject &	operator= (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

Static Public Member Functions
static const char *	sKeyDahCol ()
static const char *	sKeyFor2D ()
static const char *	sKeyLogNm ()
static const char *	sKeySelRadius ()
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
bool	for2d_
float	locradius_
BufferStringSet	lognms_
bool	minidps_
bool	mkdahcol_
ExtractParams	params_
Public Attributes inherited from Executor
Notifier< Executor >	poststep
	Only when MoreToDo will be returned. More...
Notifier< Executor >	prestep
Public Attributes inherited from ReportingTask
Notifier< ReportingTask >	progressUpdated

Protected Member Functions
void	addPosns (DataPointSet &, const BinIDValue &, const Coord3 &, float dah) const
void	getData (const Data &, DataPointSet &)
bool	getPos (const Data &, float, BinIDValue &, int &, Coord3 &) const
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 ()
ProgressMeter *	progressMeter () 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
int	curid_
int	dahcolnr_
ObjectSet< DataPointSet > &	dpss_
uiString	errmsg_
const TypeSet< MultiID > &	ids_
const bool	zistime_
Interval< float >	zrg_
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_
Notifier< NamedCallBacker >	delnotif_
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

Detailed Description

Collects positions along selected well tracks. The DataPointSet will get new rows with the positions along the track.

<>

Constructor & Destructor Documentation

TrackSampler()

Well::TrackSampler::TrackSampler	(	const TypeSet< MultiID > &	ioobjids,
		ObjectSet< DataPointSet > &	,
		bool	zvalsintime
	)

~TrackSampler()

Well::TrackSampler::~TrackSampler

(

)

Member Function Documentation

addPosns()

void Well::TrackSampler::addPosns ( DataPointSet &  , const BinIDValue &  , const Coord3 &  , float  dah  ) const

protected

dataPointSets()

ObjectSet<DataPointSet>& Well::TrackSampler::dataPointSets ( )

inline

errMsg()

uiString Well::TrackSampler::errMsg ( ) const

inline

getData()

void Well::TrackSampler::getData ( const Data &  , DataPointSet &    )

protected

getPos()

bool Well::TrackSampler::getPos ( const Data &  , float  , BinIDValue &  , int &  , Coord3 &    ) const

protected

ioObjIds()

const TypeSet<MultiID>& Well::TrackSampler::ioObjIds ( ) const

inline

nextStep()

int Well::TrackSampler::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::TrackSampler::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.

sKeyDahCol()

static const char* Well::TrackSampler::sKeyDahCol ( )

static

sKeyFor2D()

static const char* Well::TrackSampler::sKeyFor2D ( )

static

sKeyLogNm()

static const char* Well::TrackSampler::sKeyLogNm ( )

static

sKeySelRadius()

static const char* Well::TrackSampler::sKeySelRadius ( )

static

totalNr()

od_int64 Well::TrackSampler::totalNr ( ) const

inlineoverridevirtual

Reimplemented from Task.

uiMessage()

uiString Well::TrackSampler::uiMessage ( ) const

inlineoverridevirtual

will be message() again in 7.x

Reimplemented from Task.

uiNrDoneText()

uiString Well::TrackSampler::uiNrDoneText ( ) const

inlineoverridevirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

usePar()

void Well::TrackSampler::usePar

(

const IOPar &

)

Member Data Documentation

curid_

int Well::TrackSampler::curid_

protected

dahcolnr_

int Well::TrackSampler::dahcolnr_

protected

dpss_

ObjectSet<DataPointSet>& Well::TrackSampler::dpss_

protected

errmsg_

uiString Well::TrackSampler::errmsg_

protected

for2d_

bool Well::TrackSampler::for2d_

ids_

const TypeSet<MultiID>& Well::TrackSampler::ids_

protected

locradius_

float Well::TrackSampler::locradius_

lognms_

BufferStringSet Well::TrackSampler::lognms_

minidps_

bool Well::TrackSampler::minidps_

mkdahcol_

bool Well::TrackSampler::mkdahcol_

params_

ExtractParams Well::TrackSampler::params_

zistime_

const bool Well::TrackSampler::zistime_

protected

zrg_

Interval<float> Well::TrackSampler::zrg_

protected