Goes through some mem or a ValSeries and replaces one value with another. More...

Inheritance diagram for MemValReplacer< T >:

Public Member Functions
	MemValReplacer ()

	MemValReplacer (T *, const T &fromval, const T &toval, std::int64_t sz)

	MemValReplacer (ValueSeries< T > &, const T &from, const T &to, std::int64_t sz)

void	setFromValue (const T &val)

void	setPtr (T *ptr)

void	setPtr (ValueSeries< T > &vs)

void	setSize (std::int64_t sz)

void	setToValue (const T &val)

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 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

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

Protected Member Functions
int	minThreadSize () const override

std::int64_t	nrIterations () const override

bool	setPtr (std::int64_t start, std::int64_t size)

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

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 ()

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
T	fromval_

T *	ptr_

std::int64_t	sz_

T	toval_

ValueSeries< T > *	vs_ = nullptr

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_

Private Member Functions
bool	doPrepare (int) override

bool	doWork (std::int64_t, std::int64_t, int) override

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< ReportingTask >	progressUpdated

Detailed Description

template<class T>
class MemValReplacer< T >

Goes through some mem or a ValSeries and replaces one value with another.

<>

Constructor & Destructor Documentation

◆ MemValReplacer() [1/3]

template<class T >

MemValReplacer< T >::MemValReplacer

inline

◆ MemValReplacer() [2/3]

template<class T >

MemValReplacer< T >::MemValReplacer	(	T *	ptr,
		const T &	fromval,
		const T &	toval,
		std::int64_t	sz
	)

inline

◆ MemValReplacer() [3/3]

template<class T >

MemValReplacer< T >::MemValReplacer	(	ValueSeries< T > &	vs,
		const T &	from,
		const T &	to,
		std::int64_t	sz
	)

inline

Member Function Documentation

◆ doPrepare()

template<class T >

bool MemValReplacer< T >::doPrepare ( int nrthreads )

inlineoverrideprivatevirtual

Called once, before any doWork is called.

Reimplemented from ParallelTask.

◆ doWork()

template<class T >

bool MemValReplacer< T >::doWork	(	std::int64_t	start,
		std::int64_t	stop,
		int	threadidx
	)

inlineoverrideprivatevirtual

The functions that does the job. The function will be called with all intervals from 0 to ParallelTask::nrIterations()-1. The function must be designed to be able to run in parallel.

Parameters

start	first index
stop	last index
threadidx	gives an identifier (between 0 and nr of threads -1) that is unique to each call to doWork.

Implements ParallelTask.

◆ minThreadSize()

template<class T >

int MemValReplacer< T >::minThreadSize ( ) const

inlineoverrideprotectedvirtual

Returns: the minimum number of computations that effectively can be run in a separate thread. A small number will give a large overhead for when each step is quick and nrIterations is not big.

Reimplemented from ParallelTask.

◆ nrIterations()

template<class T >

std::int64_t MemValReplacer< T >::nrIterations ( ) const

inlineoverrideprotectedvirtual

Returns: the number of times the process should be run.

Implements ParallelTask.

◆ setFromValue()

template<class T >

void MemValReplacer< T >::setFromValue ( const T & val )

inline

◆ setPtr() [1/3]

template<class T >

bool MemValReplacer< T >::setPtr	(	std::int64_t	start,
		std::int64_t	size
	)

inlineprotected

◆ setPtr() [2/3]

template<class T >

void MemValReplacer< T >::setPtr ( T * ptr )

inline

◆ setPtr() [3/3]

template<class T >

void MemValReplacer< T >::setPtr ( ValueSeries< T > & vs )

inline

◆ setSize()

template<class T >

void MemValReplacer< T >::setSize ( std::int64_t sz )

inline

◆ setToValue()

template<class T >

void MemValReplacer< T >::setToValue ( const T & val )

inline

◆ uiMessage()

template<class T >

uiString MemValReplacer< T >::uiMessage ( ) const

inlineoverridevirtual

will be message() again in 7.x

Reimplemented from Task.

◆ uiNrDoneText()

template<class T >

uiString MemValReplacer< T >::uiNrDoneText ( ) const

inlineoverridevirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

Member Data Documentation

◆ fromval_

template<class T >

T MemValReplacer< T >::fromval_

protected

◆ ptr_

template<class T >

T* MemValReplacer< T >::ptr_

protected

◆ sz_

template<class T >

std::int64_t MemValReplacer< T >::sz_

protected

◆ toval_

template<class T >

T MemValReplacer< T >::toval_

protected

◆ vs_

template<class T >

ValueSeries<T>* MemValReplacer< T >::vs_ = nullptr

protected

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

template<class T> class MemValReplacer< T >

Constructor & Destructor Documentation

◆ MemValReplacer() [1/3]

◆ MemValReplacer() [2/3]

◆ MemValReplacer() [3/3]

Member Function Documentation

◆ doPrepare()

◆ doWork()

◆ minThreadSize()

◆ nrIterations()

◆ setFromValue()

◆ setPtr() [1/3]

◆ setPtr() [2/3]

◆ setPtr() [3/3]

◆ setSize()

◆ setToValue()

◆ uiMessage()

◆ uiNrDoneText()

Member Data Documentation

◆ fromval_

◆ ptr_

◆ sz_

◆ toval_

◆ vs_

template<class T>
class MemValReplacer< T >