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...

#include <od_ostream.h>

Inheritance diagram for od_ostream:

Public Member Functions
	od_ostream ()
	od_ostream (const char *fnm, bool useexist=false)
	od_ostream (const FilePath &fp, bool useexist=false)
	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_ostream &	add (char)
od_ostream &	add (const char *)
od_ostream &	add (const CompoundKey &)
od_ostream &	add (const IOPar &)
od_ostream &	add (const MultiID &)
od_ostream &	add (const OD::String &)
od_ostream &	add (const SeparString &)
od_ostream &	add (const uiString &)
od_ostream &	add (const void *)
	produces pErrMsg but works
od_ostream &	add (double)
od_ostream &	add (float)
od_ostream &	add (long)
od_ostream &	add (od_int16)
od_ostream &	add (od_int32)
od_ostream &	add (od_int64)
od_ostream &	add (od_istream &)
od_ostream &	add (od_ostream &)
od_ostream &	add (od_uint16)
od_ostream &	add (od_uint32)
od_ostream &	add (od_uint64)
od_ostream &	add (unsigned char)
od_ostream &	add (unsigned long)
template<class T >
od_ostream &	addBin (const T &)
bool	addBin (const void *, Count nrbytes)
od_ostream &	addNewLine ()
od_ostream &	addPrecise (double)
od_ostream &	addPrecise (float)
od_ostream &	addPtr (const void *)
od_ostream &	addTab ()
void	flush ()
Pos	lastWrittenPosition () const
bool	open (const char *, bool useexist=false)
od_ostream &	operator= (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.
const char *	fileName () const
bool	forRead () const
bool	forWrite () const
bool	isBad () const
	eof is not Bad
bool	isLocal () const
bool	isOK () const
	eof is not OK
Pos	position () const
void	setFileName (const char *)
void	setNoClose (bool yn=true)
void	setPosition (Pos, Ref r=Abs)
StreamData &	streamData ()
const StreamData &	streamData () const

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

Private Member Functions
	od_ostream (const od_ostream &)=delete
od_ostream &	operator= (const od_ostream &)=delete

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_stream &	operator= (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

(

od_ostream &&

)

od_ostream() [8/8]

od_ostream::od_ostream ( const od_ostream & )

privatedelete

Member Function Documentation

add() [1/22]

od_ostream & od_ostream::add

(

char

)

add() [2/22]

od_ostream & od_ostream::add

(

const char *

)

add() [3/22]

od_ostream & od_ostream::add

(

const CompoundKey &

)

add() [4/22]

od_ostream & od_ostream::add

(

const IOPar &

)

add() [5/22]

od_ostream & od_ostream::add

(

const MultiID &

)

add() [6/22]

od_ostream & od_ostream::add

(

const OD::String &

)

add() [7/22]

od_ostream & od_ostream::add

(

const SeparString &

)

add() [8/22]

od_ostream & od_ostream::add

(

const uiString &

)

add() [9/22]

od_ostream & od_ostream::add

(

const void *

)

produces pErrMsg but works

add() [10/22]

od_ostream & od_ostream::add

(

double

)

add() [11/22]

od_ostream & od_ostream::add

(

float

)

add() [12/22]

od_ostream & od_ostream::add

(

long

)

add() [13/22]

od_ostream & od_ostream::add

(

od_int16

)

add() [14/22]

od_ostream & od_ostream::add

(

od_int32

)

add() [15/22]

od_ostream & od_ostream::add

(

od_int64

)

add() [16/22]

od_ostream & od_ostream::add

(

od_istream &

)

add() [17/22]

od_ostream & od_ostream::add ( od_ostream & )

inline

add() [18/22]

od_ostream & od_ostream::add

(

od_uint16

)

add() [19/22]

od_ostream & od_ostream::add

(

od_uint32

)

add() [20/22]

od_ostream & od_ostream::add

(

od_uint64

)

add() [21/22]

od_ostream & od_ostream::add

(

unsigned char

)

add() [22/22]

od_ostream & od_ostream::add

(

unsigned long

)

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 & )

privatedelete

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

(

)