OpendTect  7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
EM::dgbSurfDataWriter Class Reference

Writes auxdata to file. More...

Inheritance diagram for EM::dgbSurfDataWriter:
[legend]

Public Member Functions

 dgbSurfDataWriter (const EM::Horizon3D &surf, int dataidx, const TrcKeySampling *sel, bool binary, const char *filename)
 
 ~dgbSurfDataWriter ()
 
int nextStep () override
 
od_int64 nrDone () const override
 
od_int64 totalNr () const override
 
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 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
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 CallBackertrueCaller ()
 
- 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_typename () const override
 
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
 

Static Public Member Functions

static BufferString createHovName (const char *base, int idx)
 
static const char * sKeyAttrName ()
 
static const char * sKeyFileType ()
 
static const char * sKeyFloatDataChar ()
 
static const char * sKeyInt64DataChar ()
 
static const char * sKeyIntDataChar ()
 
static const char * sKeyShift ()
 
static bool writeDummyHeader (const char *fnm, const char *attrnm)
 
- 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 stdNrDoneText ()
 
static uiString uiStdNrDoneText ()
 
- Static Public Member Functions inherited from CallBacker
static void createReceiverForCurrentThread ()
 
static void removeReceiverForCurrentThread ()
 

Protected Member Functions

bool writeFloat (float)
 
bool writeHeader ()
 
bool writeInt (int)
 
bool writeInt64 (od_int64)
 
- Protected Member Functions inherited from Executor
virtual bool goImpl (od_ostream *, bool, bool, int)
 
- Protected Member Functions inherited from ReportingTask
 ReportingTask (const char *nm=nullptr)
 
void incrementProgress ()
 
ProgressMeterprogressMeter () 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

bool binary_
 
int chunksize_
 
int dataidx_
 
uiString errmsg_
 
BufferString filename_
 
int nrdone_
 
int sectionindex_
 
const TrcKeySamplingsel_
 
od_ostreamstream_
 
TypeSet< EM::SubIDsubids_
 
const EM::Horizon3Dsurf_
 
int totalnr_
 
TypeSet< float > values_
 
- 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_
 

Additional Inherited Members

- Public Types inherited from Task
enum  Control { Run , Pause , Stop }
 
- Public Types inherited from ObjectWithName
typedef OD::String name_type
 
- Public Attributes inherited from Executor
Notifier< Executorpoststep
 Only when MoreToDo will be returned. More...
 
Notifier< Executorprestep
 
- Public Attributes inherited from ReportingTask
Notifier< ReportingTaskprogressUpdated
 

Detailed Description

Writes auxdata to file.

<>

Constructor & Destructor Documentation

◆ dgbSurfDataWriter()

EM::dgbSurfDataWriter::dgbSurfDataWriter ( const EM::Horizon3D surf,
int  dataidx,
const TrcKeySampling sel,
bool  binary,
const char *  filename 
)
Parameters
surfThe surface with the values
dataidxThe index of the data to be written
selA selection of which data that should be written. Can be null, i.e. no selection
binarySpecify whether the data should be written in binary format
filenameFile name to write to

◆ ~dgbSurfDataWriter()

EM::dgbSurfDataWriter::~dgbSurfDataWriter ( )

Member Function Documentation

◆ createHovName()

static BufferString EM::dgbSurfDataWriter::createHovName ( const char *  base,
int  idx 
)
static

◆ nextStep()

int EM::dgbSurfDataWriter::nextStep ( )
overridevirtual
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.

◆ nrDone()

od_int64 EM::dgbSurfDataWriter::nrDone ( ) const
overridevirtual
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.

◆ sKeyAttrName()

static const char* EM::dgbSurfDataWriter::sKeyAttrName ( )
static

◆ sKeyFileType()

static const char* EM::dgbSurfDataWriter::sKeyFileType ( )
static

◆ sKeyFloatDataChar()

static const char* EM::dgbSurfDataWriter::sKeyFloatDataChar ( )
static

◆ sKeyInt64DataChar()

static const char* EM::dgbSurfDataWriter::sKeyInt64DataChar ( )
static

◆ sKeyIntDataChar()

static const char* EM::dgbSurfDataWriter::sKeyIntDataChar ( )
static

◆ sKeyShift()

static const char* EM::dgbSurfDataWriter::sKeyShift ( )
static

◆ totalNr()

od_int64 EM::dgbSurfDataWriter::totalNr ( ) const
overridevirtual

Reimplemented from Task.

◆ uiMessage()

uiString EM::dgbSurfDataWriter::uiMessage ( ) const
overridevirtual

will be message() again in 7.x

Reimplemented from Task.

◆ uiNrDoneText()

uiString EM::dgbSurfDataWriter::uiNrDoneText ( ) const
overridevirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

◆ writeDummyHeader()

static bool EM::dgbSurfDataWriter::writeDummyHeader ( const char *  fnm,
const char *  attrnm 
)
static

◆ writeFloat()

bool EM::dgbSurfDataWriter::writeFloat ( float  )
protected

◆ writeHeader()

bool EM::dgbSurfDataWriter::writeHeader ( )
protected

◆ writeInt()

bool EM::dgbSurfDataWriter::writeInt ( int  )
protected

◆ writeInt64()

bool EM::dgbSurfDataWriter::writeInt64 ( od_int64  )
protected

Member Data Documentation

◆ binary_

bool EM::dgbSurfDataWriter::binary_
protected

◆ chunksize_

int EM::dgbSurfDataWriter::chunksize_
protected

◆ dataidx_

int EM::dgbSurfDataWriter::dataidx_
protected

◆ errmsg_

uiString EM::dgbSurfDataWriter::errmsg_
protected

◆ filename_

BufferString EM::dgbSurfDataWriter::filename_
protected

◆ nrdone_

int EM::dgbSurfDataWriter::nrdone_
protected

◆ sectionindex_

int EM::dgbSurfDataWriter::sectionindex_
protected

◆ sel_

const TrcKeySampling* EM::dgbSurfDataWriter::sel_
protected

◆ stream_

od_ostream* EM::dgbSurfDataWriter::stream_
protected

◆ subids_

TypeSet<EM::SubID> EM::dgbSurfDataWriter::subids_
protected

◆ surf_

const EM::Horizon3D& EM::dgbSurfDataWriter::surf_
protected

◆ totalnr_

int EM::dgbSurfDataWriter::totalnr_
protected

◆ values_

TypeSet<float> EM::dgbSurfDataWriter::values_
protected

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