OpenFOAM logo
Open Source CFD Toolkit

Ostream.H File Reference


Detailed Description

View Ostream.H
License
This file is part of OpenFOAM.

OpenFOAM is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.

OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
An Ostream is an abstract base class for all output systems;
be they streams, files, token lists etc.  The basic operations
are construct, close, read token, read primitive and read binary
block.  In addition version control and line number counting is
incorporated.  Usually one would use the read primitive member
functions,  but if one were reading a stream on unknown data
sequence one can read token by token, and then analyse.

Definition in file Ostream.H.

Go to the source code of this file.

Namespaces

namespace  Foam

Classes

class  Ostream

Typedefs

typedef Ostream &(* OstreamManip )(Ostream &)

Functions

Ostream & operator<< (Ostream &os, OstreamManip f)
 operator<< handling for manipulators without arguments
Ostream & operator<< (Ostream &os, IOstreamManip f)
 operator<< handling for manipulators without arguments
Ostream & indent (Ostream &os)
 Indent stream.
Ostream & incrIndent (Ostream &os)
 Increment the indent level.
Ostream & decrIndent (Ostream &os)
 Decrement the indent level.
Ostream & flush (Ostream &os)
 Flush stream.
Ostream & endl (Ostream &os)
 Add '
' and flush stream.

Variables

const char tab = '\t'
const char nl = '\n'


Typedef Documentation

typedef Ostream&(* OstreamManip)(Ostream &)
 

Definition at line 203 of file Ostream.H.


Function Documentation

Ostream& decrIndent Ostream &  os  )  [inline]
 

Decrement the indent level.

Definition at line 234 of file Ostream.H.

Ostream& endl Ostream &  os  )  [inline]
 

Add '
' and flush stream.

Definition at line 250 of file Ostream.H.

References Foam::nl.

Referenced by treeLeaf::trim().

Ostream& flush Ostream &  os  )  [inline]
 

Flush stream.

Definition at line 242 of file Ostream.H.

Ostream& incrIndent Ostream &  os  )  [inline]
 

Increment the indent level.

Definition at line 227 of file Ostream.H.

Ostream& indent Ostream &  os  )  [inline]
 

Indent stream.

Definition at line 220 of file Ostream.H.

Ostream& operator<< Ostream &  os,
IOstreamManip  f
[inline]
 

operator<< handling for manipulators without arguments

Definition at line 212 of file Ostream.H.

Ostream& operator<< Ostream &  os,
OstreamManip  f
[inline]
 

operator<< handling for manipulators without arguments

Definition at line 206 of file Ostream.H.


Variable Documentation

const char nl = '\n' [static]
 

Definition at line 259 of file Ostream.H.

Referenced by Foam::endl().

const char tab = '\t' [static]
 

Definition at line 258 of file Ostream.H.

For further information go to www.openfoam.org