OpendTect  6.3
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
Seis2DLineGetter Class Referenceabstract

interface for object that reads entire or parts of entire 2D lines. More...

Inheritance diagram for Seis2DLineGetter:
[legend]

Public Member Functions

 Seis2DLineGetter (SeisTrcBuf &, int trcsperstep, const Seis::SelData *)
 
virtual ~Seis2DLineGetter ()
 
uiString message () const
 
uiString nrDoneText () const
 
virtual od_int64 nrDone () const =0
 
virtual od_int64 totalNr () const =0
 
virtual const SeisTrcTranslatortranslator () const
 
- Public Member Functions inherited from Executor
 Executor (const char *nm)
 
virtual ~Executor ()
 
virtual int doStep ()
 
bool go (od_ostream *s=0, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
 
bool go (od_ostream &s, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
 
virtual bool execute ()
 
- Public Member Functions inherited from SequentialTask
 SequentialTask (const char *nm=0)
 
virtual ~SequentialTask ()
 
void setProgressMeter (ProgressMeter *)
 Must be called before execute() More...
 
ProgressMeterprogressMeter ()
 
const ProgressMeterprogressMeter () const
 
bool execute ()
 
- Public Member Functions inherited from Task
virtual ~Task ()
 
virtual uiRetVal errorWithDetails () const
 
virtual void enableWorkControl (bool=true)
 Must be called before execute() More...
 
bool workControlEnabled () const
 
virtual void controlWork (Control)
 
virtual Control getState () const
 
- Public Member Functions inherited from NamedCallBacker
 NamedCallBacker (const char *nm=0)
 
 NamedCallBacker (const NamedCallBacker &)
 
bool operator== (const NamedCallBacker &oth) const
 
bool operator== (const NamedObject &oth) const
 
virtual Notifier< NamedCallBacker > & objectToBeDeleted () 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 detachCB (const NotifierAccess &, const CallBack &) const
 
void detachCB (const NotifierAccess *notif, const CallBack &cb) const
 
bool isNotifierAttached (const NotifierAccess *) const
 Only for debugging purposes, don't use. More...
 
virtual bool isCapsule () const
 
void stopReceivingNotifications () const
 
- Public Member Functions inherited from NamedObject
 NamedObject (const char *nm=0)
 
 NamedObject (const NamedObject &oth)
 
virtual ~NamedObject ()
 
NamedObjectoperator= (const NamedObject &)
 
bool operator== (const NamedObject &oth) const
 
virtual const OD::Stringname () const
 
virtual BufferString getName () const
 
virtual void setName (const char *nm)
 
bool getNameFromPar (const IOPar &)
 
void putNameInPar (IOPar &) const
 

Protected Member Functions

virtual int nextStep ()=0
 
- Protected Member Functions inherited from Executor
virtual bool goImpl (od_ostream *, bool, bool, int)
 
- Protected Member Functions inherited from Task
 Task (const char *nm=0)
 
virtual bool shouldContinue ()
 
- Protected Member Functions inherited from NamedCallBacker
void sendDelNotif () const
 
- Protected Member Functions inherited from CallBacker
void detachAllNotifiers () const
 Call from the destructor of your inherited object. More...
 

Protected Attributes

SeisTrcBuftbuf_
 
uiString msg_
 
Seis::SelDataseldata_
 
- Protected Attributes inherited from SequentialTask
ProgressMeterprogressmeter_
 
int lastupdate_
 
- Protected Attributes inherited from Task
Control control_
 
Threads::ConditionVarworkcontrolcondvar_
 
- Protected Attributes inherited from NamedCallBacker
Notifier< NamedCallBackerdelnotif_
 
Threads::Atomic< bool > delalreadytriggered_
 
- Protected Attributes inherited from NamedObject
BufferString name_
 

Private Member Functions

 mODTextTranslationClass (Seis2DLineGetter)
 

Additional Inherited Members

- Public Types inherited from Task
enum  Control { Run, Pause, Stop }
 
- 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 stdMessage ()
 
static uiString stdNrDoneText ()
 
- Static Public Member Functions inherited from CallBacker
static void createReceiverForCurrentThread ()
 
static void removeReceiverForCurrentThread ()
 
- Public Attributes inherited from Executor
Notifier< Executorprestep
 
Notifier< Executorpoststep
 Only when MoreToDo will be returned. More...
 

Detailed Description

interface for object that reads entire or parts of entire 2D lines.

Constructor & Destructor Documentation

Seis2DLineGetter::Seis2DLineGetter ( SeisTrcBuf ,
int  trcsperstep,
const Seis::SelData  
)
virtual Seis2DLineGetter::~Seis2DLineGetter ( )
virtual

Member Function Documentation

uiString Seis2DLineGetter::message ( ) const
inlinevirtual

Implements Executor.

Seis2DLineGetter::mODTextTranslationClass ( Seis2DLineGetter  )
private
virtual int Seis2DLineGetter::nextStep ( )
protectedpure virtual
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.

Implemented in SEGYDirect2DLineGetter, and SeisCBVS2DLineGetter.

virtual od_int64 Seis2DLineGetter::nrDone ( ) const
pure virtual
Note
only used for displaying progress.

Implements Executor.

Implemented in SEGYDirect2DLineGetter, and SeisCBVS2DLineGetter.

uiString Seis2DLineGetter::nrDoneText ( ) const
inlinevirtual

Implements Executor.

virtual od_int64 Seis2DLineGetter::totalNr ( ) const
pure virtual

Reimplemented from Task.

Implemented in SEGYDirect2DLineGetter, and SeisCBVS2DLineGetter.

virtual const SeisTrcTranslator* Seis2DLineGetter::translator ( ) const
inlinevirtual

Member Data Documentation

uiString Seis2DLineGetter::msg_
protected
Seis::SelData* Seis2DLineGetter::seldata_
protected
SeisTrcBuf& Seis2DLineGetter::tbuf_
protected

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