OpenFOAM logo
Open Source CFD Toolkit

OSstream Class Reference

Inheritance diagram for OSstream:

Inheritance graph
[legend]
Collaboration diagram for OSstream:

Collaboration graph
[legend]
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 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 '
' and flush stream.
virtual int width () const
 Get width of output field.
virtual int width (const int w)
 Set width of output field (and return old width).
virtual int precision () const
 Get precision of output field.
virtual int precision (const int p)
 Set precision of output field (and return old precision).
virtual void print (Ostream &) const
 Print description of IOstream to Ostream.

Protected Member Functions

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

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 89 of file OSstream.H.


Member Function Documentation

virtual void endl  )  [virtual]
 

Add '
' and flush stream.

Implements Ostream.

virtual ios_base::fmtflags flags const ios_base::fmtflags  flags  )  [virtual]
 

Set flags of output stream.

virtual ios_base::fmtflags flags  )  const [virtual]
 

Return flags of output stream.

Implements IOstream.

virtual void flush  )  [virtual]
 

Flush stream.

Implements Ostream.

virtual void indent  )  [virtual]
 

Add indentation characters.

Implements Ostream.

Reimplemented in prefixOSstream.

virtual fileName& name  )  [inline, virtual]
 

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 131 of file OSstream.H.

virtual const fileName& name  )  const [inline, virtual]
 

Return the name of the stream.

Useful for Fstream to return the filename

Reimplemented from IOstream.

Reimplemented in OFstream.

Definition at line 122 of file OSstream.H.

virtual int precision const int  p  )  [virtual]
 

Set precision of output field (and return old precision).

Implements Ostream.

virtual int precision  )  const [virtual]
 

Get precision of output field.

Implements Ostream.

virtual void print Ostream  )  const [virtual]
 

Print description of IOstream to Ostream.

Reimplemented from IOstream.

Reimplemented in OFstream, prefixOSstream, and OStringStream.

const ostream& stream  )  const [inline, protected]
 

Return the const stream reference.

Definition at line 77 of file OSstream.H.

ostream& stream  )  [inline, protected]
 

Return the stream reference.

Definition at line 71 of file OSstream.H.

virtual int width const int  w  )  [virtual]
 

Set width of output field (and return old width).

Implements Ostream.

virtual int width  )  const [virtual]
 

Get width of output field.

Implements Ostream.

virtual Ostream& write const char *  ,
std::streamsize 
[virtual]
 

Write binary block.

Implements Ostream.

Reimplemented in prefixOSstream.

virtual Ostream& write const   doubleScalar  )  [virtual]
 

Write doubleScalar.

Implements Ostream.

Reimplemented in prefixOSstream, prefixOSstream, prefixOSstream, and prefixOSstream.

virtual Ostream& write const   floatScalar  )  [virtual]
 

Write floatScalar.

Implements Ostream.

Reimplemented in prefixOSstream, prefixOSstream, prefixOSstream, and prefixOSstream.

virtual Ostream& write const   label  )  [virtual]
 

Write label.

Implements Ostream.

Reimplemented in prefixOSstream, prefixOSstream, prefixOSstream, and prefixOSstream.

virtual Ostream& write const string  )  [virtual]
 

Write string.

Implements Ostream.

Reimplemented in prefixOSstream.

virtual Ostream& write const word  )  [virtual]
 

Write word.

Implements Ostream.

Reimplemented in prefixOSstream.

virtual Ostream& write const char *   )  [virtual]
 

Write character string.

Implements Ostream.

Reimplemented in prefixOSstream.

virtual Ostream& write const   char  )  [virtual]
 

Write character.

Implements Ostream.

Reimplemented in prefixOSstream, prefixOSstream, prefixOSstream, and prefixOSstream.

virtual Ostream& write const token  )  [virtual]
 

Write next token to stream.

Implements Ostream.

Reimplemented in prefixOSstream.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org