Array1DInterpol Class Reference

Base class for one dimensional array interpolators. More...

#include <array1dinterpol.h>

Inheritance diagram for Array1DInterpol:

Public Member Functions
virtual	~Array1DInterpol ()
float	getMaxGapSize () const
od_int64	nrDone () const override
od_int64	nrIterations () const
void	reset ()
void	setArray (Array1D< float > &)
void	setExtrapol (bool yn)
void	setFillWithExtremes (bool yn)
void	setMaxGapSize (float)
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
	ReportingTask (const ReportingTask &)=delete
virtual	~ReportingTask ()
void	getProgress (const ReportingTask &)
ReportingTask &	operator= (const ReportingTask &)=delete
void	setSimpleMeter (bool yn, int repperc)
int	simpleMeterStep () const
bool	useSimpleMeter () const
Public Member Functions inherited from Task
	Task (const Task &)=delete
virtual	~Task ()
virtual void	controlWork (Control)
virtual void	enableWorkControl (bool=true)
	Must be called before execute()
virtual uiRetVal	errorWithDetails () const
virtual Control	getState () const
Task &	operator= (const Task &)=delete
virtual od_int64	totalNr () const
virtual uiString	uiMessage () const
bool	workControlEnabled () const
Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=nullptr)
	NamedCallBacker (const NamedCallBacker &)=delete
	~NamedCallBacker ()
virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const
NamedCallBacker &	operator= (const NamedCallBacker &)=delete
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.
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.
CallBacker &	operator= (const CallBacker &)=delete
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

Protected Member Functions
	Array1DInterpol ()
uiString	uiNrDoneText () const override
Protected Member Functions inherited from Executor
virtual bool	goImpl (od_ostream *, bool, bool, int)
Protected Member Functions inherited from SequentialTask
virtual bool	doFinish (bool success, od_ostream *=nullptr)
virtual bool	doPrepare (od_ostream *=nullptr)
virtual int	nextStep ()=0
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()
void	updateProgressMeter (bool forced=false, od_int64 *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
Array1D< float > *	arr_
bool	arrstarted_
bool	doextrapol_
bool	fillwithextremes_
int	maxgapsize_
unsigned int	nrdone_
Protected Attributes inherited from Task
Control	control_ = Task::Run
Threads::ConditionVar *	workcontrolcondvar_ = nullptr
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
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 ReportingTask
static PtrMan< ProgressMeter >	getTextProgressMeter (od_ostream &, const IOPar *iop=nullptr)
static bool	needSimpleLogging (const IOPar &)
static const char *	sKeySimpleLogging ()
static const char *	sKeySimpleLoggingStep ()
Static Public Member Functions inherited from Task
static uiString	uiStdNrDoneText ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()
Public Attributes inherited from Executor
Notifier< Executor >	poststep
	Only when MoreToDo will be returned.
Notifier< Executor >	prestep
Public Attributes inherited from ReportingTask
Notifier< ReportingTask >	progressUpdated

Detailed Description

Base class for one dimensional array interpolators.

<>

Constructor & Destructor Documentation

~Array1DInterpol()

virtual Array1DInterpol::~Array1DInterpol ( )

virtual

Array1DInterpol()

Array1DInterpol::Array1DInterpol ( )

protected

Member Function Documentation

getMaxGapSize()

float Array1DInterpol::getMaxGapSize

(

)

const

nrDone()

od_int64 Array1DInterpol::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.

nrIterations()

od_int64 Array1DInterpol::nrIterations

(

)

const

reset()

void Array1DInterpol::reset

(

)

setArray()

void Array1DInterpol::setArray

(

Array1D< float > &

)

setExtrapol()

void Array1DInterpol::setExtrapol ( bool yn )

inline

setFillWithExtremes()

void Array1DInterpol::setFillWithExtremes ( bool yn )

inline

setMaxGapSize()

void Array1DInterpol::setMaxGapSize

(

float

)

uiNrDoneText()

uiString Array1DInterpol::uiNrDoneText ( ) const

inlineoverrideprotectedvirtual

Reimplemented from Task.

Member Data Documentation

arr_

Array1D<float>* Array1DInterpol::arr_

protected

arrstarted_

bool Array1DInterpol::arrstarted_

protected

doextrapol_

bool Array1DInterpol::doextrapol_

protected

fillwithextremes_

bool Array1DInterpol::fillwithextremes_

protected

maxgapsize_

int Array1DInterpol::maxgapsize_

protected

nrdone_

unsigned int Array1DInterpol::nrdone_

protected