FreeFOAM The Cross-Platform CFD Toolkit
OSstream Class Reference

Generic output stream. More...

#include <OpenFOAM/OSstream.H>


Detailed Description

+ Inheritance diagram for OSstream:
+ Collaboration diagram for OSstream:

List of all members.

Public Member Functions

 OSstream (ostream &os, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Set stream status.
virtual const fileNamename () const
 Return the name of the stream.
virtual fileNamename ()
 Return non-const access to the name of the stream.
virtual ios_base::fmtflags flags () const
 Return flags of output stream.
virtual Ostreamwrite (const token &)
 Write next token to stream.
virtual Ostreamwrite (const char)
 Write character.
virtual Ostreamwrite (const char *)
 Write character string.
virtual Ostreamwrite (const word &)
 Write word.
virtual Ostreamwrite (const string &)
 Write string.
virtual OstreamwriteQuoted (const std::string &, const bool quoted=true)
 Write std::string surrounded by quotes.
virtual Ostreamwrite (const label)
 Write label.
virtual Ostreamwrite (const floatScalar)
 Write floatScalar.
virtual Ostreamwrite (const doubleScalar)
 Write doubleScalar.
virtual Ostreamwrite (const char *, std::streamsize)
 Write binary block.
virtual void indent ()
 Add indentation characters.
virtual ios_base::fmtflags flags (const ios_base::fmtflags flags)
 Set flags of output stream.
virtual void flush ()
 Flush stream.
virtual void endl ()
 Add newline and flush stream.
virtual int width () const
 Get width of output field.
virtual int width (const int)
 Set width of output field (and return old width)
virtual int precision () const
 Get precision of output field.
virtual int precision (const int)
 Set precision of output field (and return old precision)
virtual void print (Ostream &) const
 Print description of IOstream to Ostream.
- Public Member Functions inherited from Ostream
 Ostream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Set stream status.
virtual ~Ostream ()
 Destructor.
virtual Ostreamwrite (const keyType &)
 Write keyType.
unsigned short indentLevel () const
 Return indent level.
unsigned short & indentLevel ()
 Access to indent level.
void incrIndent ()
 Incrememt the indent level.
void decrIndent ()
 Decrememt the indent level.
OstreamwriteKeyword (const keyType &)
 Write the keyword followed by an appropriate indentation.
Ostreamoperator() () const
 Return a non-const reference to const Ostream.
- Public Member Functions inherited from IOstream
 IOstream (streamFormat format, versionNumber version, compressionType compression=UNCOMPRESSED)
 Construct setting format and version.
virtual ~IOstream ()
virtual bool check (const char *operation) const
 Check IOstream status for given operation.
void fatalCheck (const char *operation) const
 Check IOstream status for given operation.
bool opened () const
 Return true if stream has been opened.
bool closed () const
 Return true if stream is closed.
bool good () const
 Return true if next operation might succeed.
bool eof () const
 Return true if end of input seen.
bool fail () const
 Return true if next operation will fail.
bool bad () const
 Return true if stream is corrupted.
 operator void * () const
 Return non-zero if the stream has not failed.
bool operator! () const
 Return true if the stream has failed.
streamFormat format () const
 Return current stream format.
streamFormat format (const streamFormat fmt)
 Set the stream format.
streamFormat format (const word &fmt)
 Set the stream format from word.
versionNumber version () const
 Return the stream version.
versionNumber version (const versionNumber ver)
 Set the stream version.
compressionType compression () const
 Return the stream compression.
compressionType compression (const compressionType cmp)
 Set the stream compression.
compressionType compression (const word &cmp)
 Set the stream compression from word.
label lineNumber () const
 Return current stream line number.
label & lineNumber ()
 Return current stream line number.
label lineNumber (const label ln)
 Set the stream line number.
void setEof ()
 Set stream to have reached eof.
void setFail ()
 Set stream to have failed.
void setBad ()
 Set stream to be bad.
virtual ios::fmtflags flags (const ios::fmtflags f)=0
 Set flags of stream.
ios::fmtflags setf (const ios::fmtflags f)
 Set flags of stream.
ios::fmtflags setf (const ios::fmtflags f, const ios::fmtflags mask)
 Set flags of given field of stream.
void unsetf (const ios::fmtflags uf)
 Unset flags of stream.
void print (Ostream &, const int streamState) const
 Check given stream state bits.
InfoProxy< IOstreaminfo () const
 Return info proxy.

Protected Member Functions

ostream & stream ()
 Return the stream reference.
const ostream & stream () const
 Return the const stream reference.

Additional Inherited Members

- Protected Attributes inherited from Ostream
unsigned short indentLevel_
 Current indent level.
- Protected Attributes inherited from IOstream
label lineNumber_
- Static Protected Attributes inherited from Ostream
static const unsigned short indentSize_ = 4
 Number of spaces per indent level.
static const unsigned short entryIndentation_ = 16
 Indentation of the entry from the start of the keyword.

Constructor & Destructor Documentation

OSstream ( ostream &  os,
const string name,
streamFormat  format = ASCII,
versionNumber  version = currentVersion,
compressionType  compression = UNCOMPRESSED 
)
inline

Set stream status.

Definition at line 31 of file OSstreamI.H.


Member Function Documentation

ostream& stream ( )
inlineprotected

Return the stream reference.

Definition at line 72 of file OSstream.H.

Referenced by OStringStream::rewind(), OSHA1stream::sha1(), OStringStream::str(), OSHA1stream::~OSHA1stream(), and OStringStream::~OStringStream().

const ostream& stream ( ) const
inlineprotected

Return the const stream reference.

Definition at line 78 of file OSstream.H.

virtual fileName& name ( )
inlinevirtual

Return non-const access to the name of the stream.

Useful to alter the stream name

Reimplemented from IOstream.

Reimplemented in OFstream.

Definition at line 112 of file OSstream.H.

std::ios_base::fmtflags flags ( ) const
virtual

Return flags of output stream.

Implements IOstream.

Definition at line 241 of file OSstream.C.

Foam::Ostream & write ( const token )
virtual

Write next token to stream.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 32 of file OSstream.C.

Referenced by prefixOSstream::write().

Foam::Ostream & write ( const char  c)
virtual

Write character.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 38 of file OSstream.C.

References token::NL.

Foam::Ostream & write ( const char *  str)
virtual

Write character string.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 50 of file OSstream.C.

References string::count(), and token::NL.

Foam::Ostream & write ( const word str)
virtual

Write word.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 59 of file OSstream.C.

Foam::Ostream & write ( const string str)
virtual

Write string.

In the rare case that the string contains a final trailing backslash, it will be dropped to the appearance of an escaped double-quote.

Implements Ostream.

Reimplemented in ensightFile, and prefixOSstream.

Definition at line 67 of file OSstream.C.

References token::BEGIN_STRING, token::END_STRING, and token::NL.

Foam::Ostream & writeQuoted ( const std::string &  str,
const bool  quoted = true 
)
virtual

Write std::string surrounded by quotes.

Optional write without quotes.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 113 of file OSstream.C.

References token::BEGIN_STRING, string::count(), token::END_STRING, and token::NL.

Referenced by prefixOSstream::writeQuoted().

Foam::Ostream & write ( const label  val)
virtual

Write label.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 174 of file OSstream.C.

Foam::Ostream & write ( const floatScalar  val)
virtual

Write floatScalar.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 182 of file OSstream.C.

Foam::Ostream & write ( const doubleScalar  val)
virtual

Write doubleScalar.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 190 of file OSstream.C.

Foam::Ostream & write ( const char *  buf,
std::streamsize  count 
)
virtual

Write binary block.

Implements Ostream.

Reimplemented in prefixOSstream, and ensightFile.

Definition at line 198 of file OSstream.C.

References Foam::abort(), token::BEGIN_LIST, token::END_LIST, Foam::FatalIOError, FatalIOErrorIn, and format().

void indent ( )
virtual

Add indentation characters.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 217 of file OSstream.C.

Referenced by prefixOSstream::indent().

std::ios_base::fmtflags flags ( const ios_base::fmtflags  flags)
virtual

Set flags of output stream.

Definition at line 248 of file OSstream.C.

void flush ( )
virtual

Flush stream.

Implements Ostream.

Definition at line 226 of file OSstream.C.

References Ostream::flush().

Referenced by DsmcCloud< ParcelType >::dumpParticlePositions(), and Cloud< ParticleType >::writePositions().

void endl ( )
virtual

Add newline and flush stream.

Implements Ostream.

Definition at line 233 of file OSstream.C.

int width ( ) const
virtual

Get width of output field.

Implements Ostream.

Definition at line 258 of file OSstream.C.

int width ( const int  w)
virtual

Set width of output field (and return old width)

Implements Ostream.

Definition at line 264 of file OSstream.C.

int precision ( ) const
virtual

Get precision of output field.

Implements Ostream.

Definition at line 270 of file OSstream.C.

Referenced by Time::readDict(), and STARCD::writeSurface().

int precision ( const int  p)
virtual

Set precision of output field (and return old precision)

Implements Ostream.

Definition at line 276 of file OSstream.C.

void print ( Ostream os) const
virtual

Print description of IOstream to Ostream.

Reimplemented from IOstream.

Reimplemented in OFstream, prefixOSstream, and OStringStream.

Definition at line 43 of file SstreamsPrint.C.

References Foam::name(), and IOstream::print().

Referenced by OStringStream::print(), OFstream::print(), and prefixOSstream::print().


The documentation for this class was generated from the following files: