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

ValueSeries Copier. More...

Inheritance diagram for MemCopier< T >:
[legend]

Public Member Functions

 MemCopier ()
 
 MemCopier (T *, const T *, int64_t sz)
 
 MemCopier (T *, const ValueSeries< T > &, int64_t sz)
 
 MemCopier (ValueSeries< T > &, const T *, int64_t sz)
 
 MemCopier (ValueSeries< T > &, const ValueSeries< T > &, int64_t sz)
 
void setInput (const T *ptr)
 
void setInput (const ValueSeries< T > &vs)
 
void setOutput (T *ptr)
 
void setOutput (ValueSeries< T > &vs)
 
void setSize (int64_t sz)
 
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

const T * inptr_
 
const ValueSeries< T > * invs_
 
T * outptr_
 
ValueSeries< T > * outvs_
 
int64_t sz_
 
- 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 MemCopier< T >

ValueSeries Copier.

For ordinary copying of arrays, use OD::memCopy. It will autonmatically switch to parallel execution if necessary.

<>

Constructor & Destructor Documentation

◆ MemCopier() [1/5]

template<class T >
MemCopier< T >::MemCopier
inline

◆ MemCopier() [2/5]

template<class T >
MemCopier< T >::MemCopier ( T *  o,
const T *  i,
int64_t  sz 
)
inline

◆ MemCopier() [3/5]

template<class T >
MemCopier< T >::MemCopier ( T *  o,
const ValueSeries< T > &  i,
int64_t  sz 
)
inline

◆ MemCopier() [4/5]

template<class T >
MemCopier< T >::MemCopier ( ValueSeries< T > &  o,
const T *  i,
int64_t  sz 
)
inline

◆ MemCopier() [5/5]

template<class T >
MemCopier< T >::MemCopier ( ValueSeries< T > &  o,
const ValueSeries< T > &  i,
int64_t  sz 
)
inline

Member Function Documentation

◆ doPrepare()

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

Called once, before any doWork is called.

Reimplemented from ParallelTask.

◆ doWork()

template<class T >
bool MemCopier< 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 MemCopier< 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 MemCopier< T >::nrIterations ( ) const
inlineprotectedvirtual
Returns
the number of times the process should be run.

Implements ParallelTask.

◆ setInput() [1/2]

template<class T >
void MemCopier< T >::setInput ( const T *  ptr)
inline

◆ setInput() [2/2]

template<class T >
void MemCopier< T >::setInput ( const ValueSeries< T > &  vs)
inline

◆ setOutput() [1/2]

template<class T >
void MemCopier< T >::setOutput ( T *  ptr)
inline

◆ setOutput() [2/2]

template<class T >
void MemCopier< T >::setOutput ( ValueSeries< T > &  vs)
inline

◆ setPtr()

template<class T >
bool MemCopier< T >::setPtr ( int64_t  start,
int64_t  size 
)
inlineprotected

◆ setSize()

template<class T >
void MemCopier< T >::setSize ( int64_t  sz)
inline

◆ uiMessage()

template<class T >
uiString MemCopier< T >::uiMessage ( ) const
inlinevirtual

will be message() again in 7.x

Reimplemented from Task.

◆ uiNrDoneText()

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

will be nrDoneText() in 7.x

Reimplemented from Task.

Member Data Documentation

◆ inptr_

template<class T >
const T* MemCopier< T >::inptr_
protected

◆ invs_

template<class T >
const ValueSeries<T>* MemCopier< T >::invs_
protected

◆ outptr_

template<class T >
T* MemCopier< T >::outptr_
protected

◆ outvs_

template<class T >
ValueSeries<T>* MemCopier< T >::outvs_
protected

◆ sz_

template<class T >
int64_t MemCopier< T >::sz_
protected

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