OpendTect  7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
Vel::FunctionAscIO Class Reference
Inheritance diagram for Vel::FunctionAscIO:
[legend]

Public Member Functions

 FunctionAscIO (const Table::FormatDesc &fd, od_istream &, od_int64 filesizeinkb=-1)
 
 FunctionAscIO (const Table::FormatDesc &fd, od_istream &, Pos::GeomID geomid, od_int64 filesizeinkb)
 
 ~FunctionAscIO ()
 
float getUdfVal () const
 
bool isXY () const
 
void setOutput (BinIDValueSet &bvs)
 
- Public Member Functions inherited from Table::AscIO
 AscIO (const FormatDesc &fd)
 
virtual ~AscIO ()
 
const FormatDescdesc () const
 
uiString errMsg () const
 
double getdValue (int idx, double udf=mUdf(double)) const
 
float getfValue (int idx, float udf=mUdf(float)) const
 
const char * text (int ifld) const
 
uiString warnMsg () const
 
- Public Member Functions inherited from SequentialTask
 SequentialTask (const char *nm=nullptr)
 
virtual ~SequentialTask ()
 
virtual int doStep ()
 
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
 
virtual uiString uiMessage () const
 will be message() again in 7.x More...
 
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 Table::FormatDescgetDesc ()
 
static Table::FormatDescgetDesc (bool is2d)
 
static void updateDesc (Table::FormatDesc &)
 
static void updateDesc (Table::FormatDesc &, bool is2d)
 
- Static Public Member Functions inherited from Table::AscIO
static const UnitOfMeasuregetDepthUnit ()
 
static const UnitOfMeasuregetTimeUnit ()
 
static const ZDomain::InfozDomain (const FormatDesc &, int idx, uiRetVal &)
 
- 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

int nextStep () override
 
od_int64 nrDone () const override
 
od_int64 totalNr () const override
 
uiString uiNrDoneText () const override
 will be nrDoneText() in 7.x More...
 
- Protected Member Functions inherited from Table::AscIO
void addVal (const char *, const UnitOfMeasure *) const
 
int columnOf (bool hdr, int iinf, int ielem) const
 
void emptyVals () const
 
int formOf (bool hdr, int iinf) const
 
BinID getBinID (int inlfld, int crlfld, double udf=mUdf(double)) const
 
double getDValue (int, double udf=mUdf(double)) const
 
float getFValue (int, float udf=mUdf(float)) const
 
bool getHdrVals (od_istream &) const
 
int getIntValue (int, int udf=mUdf(int)) const
 
int getNextBodyVals (od_istream &) const
 Executor convention. More...
 
Coord getPos (int xfld, int yfld, double udf=mUdf(double), bool isll=false, ConstRefMan< Coords::CoordSystem > crs=SI().getCoordSystem()) const
 
Coord3 getPos3D (int xfld, int yfld, int zfld, double udf=mUdf(double), bool isll=false, ConstRefMan< Coords::CoordSystem > crs=SI().getCoordSystem()) const
 
BufferString getText (int) const
 
bool putHdrVals (od_ostream &) const
 
bool putNextBodyVals (od_ostream &) const
 
- 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
 

Static Protected Member Functions

static void createDescBody (Table::FormatDesc &)
 
static void createDescBody (Table::FormatDesc &, bool is2d)
 

Protected Attributes

bool first_
 
od_int64 nrdone_
 
od_int64 nrkbytes_
 
BinIDValueSetoutput_
 
od_istreamstrm_
 
- Protected Attributes inherited from Table::AscIO
Convertercnvrtr_
 
uiString errmsg_
 
ExportHandlerexphndlr_
 
const FormatDescfd_
 
BufferStringSet fullline_
 
bool hdrread_
 
ImportHandlerimphndlr_
 
bool needfullline_
 
ObjectSet< const UnitOfMeasureunits_
 
BufferStringSet vals_
 
uiString warnmsg_
 
- 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 ReportingTask
Notifier< ReportingTaskprogressUpdated
 

Detailed Description

<>

Constructor & Destructor Documentation

◆ FunctionAscIO() [1/2]

Vel::FunctionAscIO::FunctionAscIO ( const Table::FormatDesc fd,
od_istream ,
od_int64  filesizeinkb = -1 
)

◆ FunctionAscIO() [2/2]

Vel::FunctionAscIO::FunctionAscIO ( const Table::FormatDesc fd,
od_istream ,
Pos::GeomID  geomid,
od_int64  filesizeinkb 
)

◆ ~FunctionAscIO()

Vel::FunctionAscIO::~FunctionAscIO ( )

Member Function Documentation

◆ createDescBody() [1/2]

static void Vel::FunctionAscIO::createDescBody ( Table::FormatDesc )
staticprotected

◆ createDescBody() [2/2]

static void Vel::FunctionAscIO::createDescBody ( Table::FormatDesc ,
bool  is2d 
)
staticprotected

◆ getDesc() [1/2]

static Table::FormatDesc* Vel::FunctionAscIO::getDesc ( )
static

◆ getDesc() [2/2]

static Table::FormatDesc* Vel::FunctionAscIO::getDesc ( bool  is2d)
static

◆ getUdfVal()

float Vel::FunctionAscIO::getUdfVal ( ) const

◆ isXY()

bool Vel::FunctionAscIO::isXY ( ) const

◆ nextStep()

int Vel::FunctionAscIO::nextStep ( )
overrideprotectedvirtual
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 Vel::FunctionAscIO::nrDone ( ) const
inlineoverrideprotectedvirtual
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.

◆ setOutput()

void Vel::FunctionAscIO::setOutput ( BinIDValueSet bvs)
inline

◆ totalNr()

od_int64 Vel::FunctionAscIO::totalNr ( ) const
inlineoverrideprotectedvirtual

Reimplemented from Task.

◆ uiNrDoneText()

uiString Vel::FunctionAscIO::uiNrDoneText ( ) const
inlineoverrideprotectedvirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

◆ updateDesc() [1/2]

static void Vel::FunctionAscIO::updateDesc ( Table::FormatDesc )
static

◆ updateDesc() [2/2]

static void Vel::FunctionAscIO::updateDesc ( Table::FormatDesc ,
bool  is2d 
)
static

Member Data Documentation

◆ first_

bool Vel::FunctionAscIO::first_
protected

◆ nrdone_

od_int64 Vel::FunctionAscIO::nrdone_
protected

◆ nrkbytes_

od_int64 Vel::FunctionAscIO::nrkbytes_
protected

◆ output_

BinIDValueSet* Vel::FunctionAscIO::output_
protected

◆ strm_

od_istream& Vel::FunctionAscIO::strm_
protected

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