OpendTect  6.6
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
MemValReplacer< T > Class Template Reference

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

Inheritance diagram for MemValReplacer< T >:
[legend]

Public Member Functions

 MemValReplacer ()
 
 MemValReplacer (T *, const T &fromval, const T &toval, int64_t sz)
 
 MemValReplacer (ValueSeries< T > &, const T &from, const T &to, int64_t sz)
 
void setFromValue (const T &val)
 
void setPtr (T *ptr)
 
void setPtr (ValueSeries< T > &vs)
 
void setSize (int64_t sz)
 
void setToValue (const T &val)
 
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 ParallelTask
virtual ~ParallelTask ()
 
bool execute ()
 
virtual bool executeParallel (bool parallel)
 
int64_t nrDone () const
 May be -1, i.e. class does not report nrdone. More...
 
void setProgressMeter (ProgressMeter *)
 Must be called before execute() More...
 
int64_t totalNr () const
 
- 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 Member Functions

int minThreadSize () const
 
int64_t nrIterations () const
 
bool setPtr (int64_t start, int64_t size)
 
- Protected Member Functions inherited from ParallelTask
 ParallelTask (const char *nm=0)
 
 ParallelTask (const ParallelTask &)
 
void addToNrDone (int64_t increment)
 
int64_t calculateThreadSize (int64_t totalnr, int nrthreads, int thread) const
 
virtual int maxNrThreads () const
 
void quickAddToNrDone (int64_t loopidx)
 
void resetNrDone ()
 
virtual bool stopAllOnFailure () const
 
- 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

fromval_
 
T * ptr_
 
int64_t sz_
 
toval_
 
ValueSeries< T > * vs_
 
- 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_
 

Private Member Functions

bool doPrepare (int)
 
bool doWork (int64_t, int64_t, int)
 

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

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

◆ MemValReplacer() [2/3]

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

◆ MemValReplacer() [3/3]

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

Member Function Documentation

◆ doPrepare()

template<class T >
bool MemValReplacer< T >::doPrepare ( int  nrthreads)
inlineprivatevirtual

Called once, before any doWork is called.

Reimplemented from ParallelTask.

◆ doWork()

template<class T >
bool MemValReplacer< T >::doWork ( int64_t  start,
int64_t  stop,
int  threadidx 
)
inlineprivatevirtual

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
startfirst index
stoplast index
threadidxgives 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
inlineprotectedvirtual
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 >
int64_t MemValReplacer< T >::nrIterations ( ) const
inlineprotectedvirtual
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 ( int64_t  start,
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 ( 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
inlinevirtual

will be message() again in 7.x

Reimplemented from Task.

◆ uiNrDoneText()

template<class T >
uiString MemValReplacer< T >::uiNrDoneText ( ) const
inlinevirtual

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 >
int64_t MemValReplacer< T >::sz_
protected

◆ toval_

template<class T >
T MemValReplacer< T >::toval_
protected

◆ vs_

template<class T >
ValueSeries<T>* MemValReplacer< T >::vs_
protected

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