OpendTect  6.6
Public Member Functions | Static Public Member Functions | List of all members
od_ostream Class Reference

OD class for stream write common access to the user log file, or std::cout in other than od_main. More...

Inheritance diagram for od_ostream:
[legend]

Public Member Functions

 od_ostream ()
 
 od_ostream (const char *fnm, bool useexist=false)
 
 od_ostream (const FilePath &fp, bool useexist=false)
 
 od_ostream (const od_ostream &)=delete
 
 od_ostream (const OS::MachineCommand &mc, const char *workdir=nullptr)
 
 od_ostream (od_ostream &&)
 
 od_ostream (std::ostream &s)
 
 od_ostream (std::ostream *s)
 
od_ostreamadd (char)
 
od_ostreamadd (const char *)
 
od_ostreamadd (const CompoundKey &)
 
od_ostreamadd (const IOPar &)
 
od_ostreamadd (const OD::String &)
 
od_ostreamadd (const SeparString &)
 
od_ostreamadd (const uiString &)
 
od_ostreamadd (const void *)
 produces pErrMsg but works More...
 
od_ostreamadd (double)
 
od_ostreamadd (float)
 
od_ostreamadd (int)
 
od_ostreamadd (int64_t)
 
od_ostreamadd (long)
 
od_ostreamadd (od_istream &)
 
od_ostreamadd (od_ostream &)
 
od_ostreamadd (short)
 
od_ostreamadd (uint64_t)
 
od_ostreamadd (unsigned char)
 
od_ostreamadd (unsigned int)
 
od_ostreamadd (unsigned long)
 
od_ostreamadd (unsigned short)
 
template<class T >
od_ostreamaddBin (const T &)
 
bool addBin (const void *, Count nrbytes)
 
od_ostreamaddNewLine ()
 
od_ostreamaddPrecise (double)
 
od_ostreamaddPrecise (float)
 
od_ostreamaddPtr (const void *)
 
od_ostreamaddTab ()
 
void flush ()
 
Pos lastWrittenPosition () const
 
bool open (const char *, bool useexist=false)
 
od_ostreamoperator= (const od_ostream &)=delete
 
od_ostreamoperator= (od_ostream &&)
 
void setWritePosition (Pos, Ref r=Abs)
 
std::ostream & stdStream ()
 
- Public Member Functions inherited from od_stream
virtual ~od_stream ()
 
void addErrMsgTo (BufferString &) const
 
void addErrMsgTo (uiRetVal &) const
 
void addErrMsgTo (uiString &) const
 
void close ()
 
uiString errMsg () const
 see also below. More...
 
const char * fileName () const
 
bool forRead () const
 
bool forWrite () const
 
bool isBad () const
 eof is not Bad More...
 
bool isLocal () const
 
bool isOK () const
 eof is not OK More...
 
Pos position () const
 
void setFileName (const char *)
 
void setNoClose (bool yn=true)
 
void setPosition (Pos, Ref r=Abs)
 
StreamDatastreamData ()
 
const StreamDatastreamData () const
 

Static Public Member Functions

static od_ostreamlogStream ()
 used by ErrMsg and UsrMsg More...
 
static od_ostreamnullStream ()
 
- Static Public Member Functions inherited from od_stream
static od_streamcreate (const char *, bool forread, BufferString &errmsg)
 returns null on failure, never a bad stream More...
 
static od_streamcreate (const char *, bool forread, uiString &errmsg)
 returns null on failure, never a bad stream More...
 
static const char * sStdErr ()
 pass this as filename to get cerr More...
 
static const char * sStdIO ()
 pass this as filename to get cin or cout More...
 

Additional Inherited Members

- Public Types inherited from od_stream
typedef od_stream_Count Count
 
typedef od_stream_Pos Pos
 
enum  Ref { Abs , Rel , End }
 
- Protected Member Functions inherited from od_stream
 od_stream ()
 
 od_stream (const char *, bool, bool editmode=false)
 
 od_stream (const FilePath &, bool, bool editmode=false)
 
 od_stream (const OS::MachineCommand &, const char *workdir, bool editmode=false)
 
 od_stream (std::istream &)
 
 od_stream (std::istream *)
 
 od_stream (std::ostream &)
 
 od_stream (std::ostream *)
 
BufferString noStdStreamPErrMsg () const
 
od_streamoperator= (const od_stream &)=delete
 
- Protected Attributes inherited from od_stream
uiString errmsg_
 
bool mine_ = true
 
bool noclose_ = false
 
StreamData sd_
 

Detailed Description

OD class for stream write common access to the user log file, or std::cout in other than od_main.

<>

Constructor & Destructor Documentation

◆ od_ostream() [1/8]

od_ostream::od_ostream ( )
inline

◆ od_ostream() [2/8]

od_ostream::od_ostream ( const char *  fnm,
bool  useexist = false 
)
inline

◆ od_ostream() [3/8]

od_ostream::od_ostream ( const FilePath fp,
bool  useexist = false 
)
inline

◆ od_ostream() [4/8]

od_ostream::od_ostream ( const OS::MachineCommand mc,
const char *  workdir = nullptr 
)
inline

◆ od_ostream() [5/8]

od_ostream::od_ostream ( std::ostream *  s)
inline

◆ od_ostream() [6/8]

od_ostream::od_ostream ( std::ostream &  s)
inline

◆ od_ostream() [7/8]

od_ostream::od_ostream ( const od_ostream )
delete

◆ od_ostream() [8/8]

od_ostream::od_ostream ( od_ostream &&  )

Member Function Documentation

◆ add() [1/21]

od_ostream& od_ostream::add ( char  )

◆ add() [2/21]

od_ostream& od_ostream::add ( const char *  )

◆ add() [3/21]

od_ostream& od_ostream::add ( const CompoundKey )

◆ add() [4/21]

od_ostream& od_ostream::add ( const IOPar )

◆ add() [5/21]

od_ostream& od_ostream::add ( const OD::String )

◆ add() [6/21]

od_ostream& od_ostream::add ( const SeparString )

◆ add() [7/21]

od_ostream& od_ostream::add ( const uiString )

◆ add() [8/21]

od_ostream& od_ostream::add ( const void *  )

produces pErrMsg but works

◆ add() [9/21]

od_ostream& od_ostream::add ( double  )

◆ add() [10/21]

od_ostream& od_ostream::add ( float  )

◆ add() [11/21]

od_ostream& od_ostream::add ( int  )

◆ add() [12/21]

od_ostream& od_ostream::add ( int64_t  )

◆ add() [13/21]

od_ostream& od_ostream::add ( long  )

◆ add() [14/21]

od_ostream& od_ostream::add ( od_istream )

◆ add() [15/21]

od_ostream& od_ostream::add ( od_ostream )
inline

◆ add() [16/21]

od_ostream& od_ostream::add ( short  )

◆ add() [17/21]

od_ostream& od_ostream::add ( uint64_t  )

◆ add() [18/21]

od_ostream& od_ostream::add ( unsigned char  )

◆ add() [19/21]

od_ostream& od_ostream::add ( unsigned int  )

◆ add() [20/21]

od_ostream& od_ostream::add ( unsigned long  )

◆ add() [21/21]

od_ostream& od_ostream::add ( unsigned short  )

◆ addBin() [1/2]

template<class T >
od_ostream & od_ostream::addBin ( const T &  t)
inline

◆ addBin() [2/2]

bool od_ostream::addBin ( const void *  ,
Count  nrbytes 
)

◆ addNewLine()

od_ostream& od_ostream::addNewLine ( )
inline

◆ addPrecise() [1/2]

od_ostream& od_ostream::addPrecise ( double  )

◆ addPrecise() [2/2]

od_ostream& od_ostream::addPrecise ( float  )

◆ addPtr()

od_ostream& od_ostream::addPtr ( const void *  )

◆ addTab()

od_ostream& od_ostream::addTab ( )
inline

◆ flush()

void od_ostream::flush ( )

◆ lastWrittenPosition()

Pos od_ostream::lastWrittenPosition ( ) const

◆ logStream()

static od_ostream& od_ostream::logStream ( )
static

used by ErrMsg and UsrMsg

◆ nullStream()

static od_ostream& od_ostream::nullStream ( )
static

◆ open()

bool od_ostream::open ( const char *  ,
bool  useexist = false 
)

◆ operator=() [1/2]

od_ostream& od_ostream::operator= ( const od_ostream )
delete

◆ operator=() [2/2]

od_ostream& od_ostream::operator= ( od_ostream &&  )

◆ setWritePosition()

void od_ostream::setWritePosition ( Pos  ,
Ref  r = Abs 
)

◆ stdStream()

std::ostream& od_ostream::stdStream ( )

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