FreeFOAM The Cross-Platform CFD Toolkit
IOstream Class Reference

An IOstream is an abstract base class for all input/output systems; be they streams, files, token lists etc. More...

#include <OpenFOAM/IOstream.H>


Detailed Description

An IOstream is an abstract base class for all input/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.

Source files

Definition at line 76 of file IOstream.H.

+ Inheritance diagram for IOstream:
+ Collaboration diagram for IOstream:

List of all members.

Classes

class  versionNumber
 Version number type. More...

Public Types

enum  streamAccess { OPENED, CLOSED }
 Enumeration for whether the stream open or closed. More...
enum  streamFormat { ASCII, BINARY }
 Enumeration for the format of data in the stream. More...
enum  compressionType { UNCOMPRESSED, COMPRESSED }
 Enumeration for the format of data in the stream. More...

Public Member Functions

 IOstream (streamFormat format, versionNumber version, compressionType compression=UNCOMPRESSED)
 Construct setting format and version.
virtual ~IOstream ()
virtual const fileNamename () const
 Return the name of the stream.
virtual fileNamename ()
 Return non-const access to the name of the stream.
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.
virtual ios::fmtflags flags () const =0
 Return flags of stream.
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.
virtual void print (Ostream &) const
 Print description of IOstream to Ostream.
void print (Ostream &, const int streamState) const
 Check given stream state bits.
InfoProxy< IOstreaminfo () const
 Return info proxy.

Static Public Member Functions

static streamFormat formatEnum (const word &)
 Return stream format of given format name.
static compressionType compressionEnum (const word &)
 Return compression of given compression name.
static unsigned int defaultPrecision ()
 Return the default precision.
static unsigned int defaultPrecision (unsigned int p)
 Reset the default precision (and return old precision)

Static Public Attributes

static const versionNumber originalVersion
 Original version number.
static const versionNumber currentVersion
 Current version number.
static unsigned int precision_
 Default precision.

Protected Member Functions

void setOpened ()
 Set stream opened.
void setClosed ()
 Set stream closed.
void setState (ios::iostate state)
 Set stream state.
void setGood ()
 Set stream to be good.

Protected Attributes

label lineNumber_

Friends

Ostreamoperator<< (Ostream &os, const streamFormat &sf)
 Ostream operator.

Member Enumeration Documentation

Enumeration for whether the stream open or closed.

Enumerator:
OPENED 
CLOSED 

Definition at line 84 of file IOstream.H.

Enumeration for the format of data in the stream.

Enumerator:
ASCII 
BINARY 

Definition at line 91 of file IOstream.H.

Enumeration for the format of data in the stream.

Enumerator:
UNCOMPRESSED 
COMPRESSED 

Definition at line 198 of file IOstream.H.


Constructor & Destructor Documentation

IOstream ( streamFormat  format,
versionNumber  version,
compressionType  compression = UNCOMPRESSED 
)
inline

Construct setting format and version.

Definition at line 274 of file IOstream.H.

References IOstream::setBad().

virtual ~IOstream ( )
inlinevirtual

Definition at line 293 of file IOstream.H.


Member Function Documentation

void setOpened ( )
inlineprotected

Set stream opened.

Definition at line 244 of file IOstream.H.

References IOstream::OPENED.

Referenced by ITstream::ITstream().

void setClosed ( )
inlineprotected

Set stream closed.

Definition at line 250 of file IOstream.H.

References IOstream::CLOSED.

void setState ( ios::iostate  state)
inlineprotected

Set stream state.

Definition at line 256 of file IOstream.H.

Referenced by ISstream::get().

void setGood ( )
inlineprotected

Set stream to be good.

Definition at line 262 of file IOstream.H.

Referenced by ITstream::ITstream().

virtual fileName& name ( )
inlinevirtual

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

Useful to alter the stream name

Reimplemented in primitiveEntry, OFstream, IFstream, ISstream, ITstream, and OSstream.

Definition at line 310 of file IOstream.H.

bool check ( const char *  operation) const
virtual

Check IOstream status for given operation.

print IOstream state if error has occured

Definition at line 86 of file IOstream.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, and Foam::name().

Referenced by constTransport< thermo >::constTransport(), eConstThermo< equationOfState >::eConstThermo(), edgeMesh::edgeMesh(), fieldAverageItem::fieldAverageItem(), hConstThermo< equationOfState >::hConstThermo(), ignitionSite::ignitionSite(), incompressible::incompressible(), injector::injector(), janafThermo< equationOfState >::janafThermo(), kinematicParcelInjectionData::kinematicParcelInjectionData(), line< Point, PointRef >::line(), objectMap::objectMap(), Foam::operator<<(), Foam::operator>>(), Particle< ParticleType >::Particle(), perfectGas::perfectGas(), phaseProperties::phaseProperties(), polyBoundaryMesh::polyBoundaryMesh(), pyramid< Point, PointRef, polygonRef >::pyramid(), reactingMultiphaseParcelInjectionData::reactingMultiphaseParcelInjectionData(), reactingParcelInjectionData::reactingParcelInjectionData(), IOPosition< ParticleType >::readData(), ensightPart::reconstruct(), specie::specie(), speciesTransport::speciesTransport(), specieThermo< thermo >::specieThermo(), surfacePatchIOList::surfacePatchIOList(), surfZoneIOList::surfZoneIOList(), sutherlandTransport< thermo >::sutherlandTransport(), tetrahedron< Point, PointRef >::tetrahedron(), thermoParcelInjectionData::thermoParcelInjectionData(), triangle< Point, PointRef >::triangle(), Tuple< Type1, Type2 >::Tuple(), VectorSpace< Form, Cmpt, nCmpt >::VectorSpace(), OFSsurfaceFormat< Face >::write(), triSurface::write(), Particle< ParticleType >::write(), ensightParts::writeData(), polyBoundaryMesh::writeData(), DimensionedField< Type, GeoMesh >::writeData(), GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField::writeEntry(), and ZoneMesh< ZoneType, MeshType >::ZoneMesh().

void fatalCheck ( const char *  operation) const

Check IOstream status for given operation.

print IOstream state if error has occured and exit

Definition at line 101 of file IOstream.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, and Foam::name().

Referenced by dictionaryEntry::dictionaryEntry(), functionEntry::execute(), entry::New(), Foam::operator>>(), PtrList< T >::read(), and primitiveEntry::read().

bool opened ( ) const
inline

Return true if stream has been opened.

Definition at line 327 of file IOstream.H.

References IOstream::OPENED.

bool closed ( ) const
inline

Return true if stream is closed.

Definition at line 333 of file IOstream.H.

References IOstream::CLOSED.

bool good ( ) const
inline

Return true if next operation might succeed.

Definition at line 339 of file IOstream.H.

Referenced by argList::argList(), topoSetSource::checkIs(), AC3DsurfaceFormatCore::cueTo(), argList::displayDoc(), edgeMesh::edgeMesh(), error::error(), surfaceFormatsCore::getLineNoComment(), noiseFFT::noiseFFT(), IOobject::objectStream(), csvTableReader< Type >::operator()(), Foam::operator<<(), Foam::operator>>(), pressureGradientExplicitSource::pressureGradientExplicitSource(), OBJsurfaceFormat< Face >::read(), GTSsurfaceFormat< Face >::read(), NASsurfaceFormat< Face >::read(), OFFsurfaceFormat< Face >::read(), AC3DsurfaceFormat< Face >::read(), SKA::read(), FTRsurfaceFormat< Face >::read(), STARCDsurfaceFormat< Face >::read(), OFSsurfaceFormat< Face >::read(), dictionary::read(), STARCD::readBoundary(), Foam::readCmd(), AC3DsurfaceFormatCore::readCmd(), TimeActivatedExplicitSourceList< Type >::readData(), porousZones::readData(), STARCDsurfaceFormatCore::readHeader(), STARCD::readHeader(), IOobject::readHeader(), STARCDsurfaceFormatCore::readPoints(), Foam::readUpto(), scalarRanges::scalarRanges(), X3DsurfaceFormat< Face >::write(), WRLsurfaceFormat< Face >::write(), SMESHsurfaceFormat< Face >::write(), VTKsurfaceFormat< Face >::write(), GTSsurfaceFormat< Face >::write(), OBJsurfaceFormat< Face >::write(), AC3DsurfaceFormat< Face >::write(), OFFsurfaceFormat< Face >::write(), TRIsurfaceFormat< Face >::write(), OFSsurfaceFormat< Face >::write(), graph::write(), dictionary::write(), indexedOctree< Type >::write(), STLsurfaceFormat< Face >::writeAscii(), correlationFunction< Type >::writeAveraged(), fieldDictionary::writeData(), featureEdgeMesh::writeData(), IOPosition< ParticleType >::writeData(), IOdictionary::writeData(), UniformDimensionedField< Type >::writeData(), surfZoneIOList::writeData(), surfacePatchIOList::writeData(), AverageIOField< Type >::writeData(), coordinateSystems::writeData(), basicSourceList::writeData(), polyTopoChanger::writeData(), TimeActivatedExplicitSourceList< Type >::writeData(), ZoneMesh< ZoneType, MeshType >::writeData(), cellModel::writeData(), porousZones::writeData(), polyBoundaryMesh::writeData(), DimensionedField< Type, GeoMesh >::writeData(), refinementHistory::writeData(), GeometricField< Type, PatchField, GeoMesh >::writeData(), pairPotential::writeEnergyAndForceTables(), IOobject::writeHeader(), and regIOobject::writeObject().

bool fail ( ) const
inline

Return true if next operation will fail.

Definition at line 351 of file IOstream.H.

Referenced by IOstream::operator void *(), and IOstream::operator!().

bool bad ( ) const
inline
operator void * ( ) const
inline

Return non-zero if the stream has not failed.

Definition at line 363 of file IOstream.H.

References IOstream::fail().

bool operator! ( ) const
inline

Return true if the stream has failed.

Definition at line 371 of file IOstream.H.

References IOstream::fail().

Foam::IOstream::streamFormat formatEnum ( const word format)
static

Return stream format of given format name.

Definition at line 40 of file IOstream.C.

References IOstream::ASCII, IOstream::BINARY, Foam::endl(), and WarningIn.

Referenced by IOstream::format(), and Time::readDict().

streamFormat format ( const streamFormat  fmt)
inline

Set the stream format.

Definition at line 389 of file IOstream.H.

streamFormat format ( const word fmt)
inline

Set the stream format from word.

Definition at line 397 of file IOstream.H.

References IOstream::formatEnum().

versionNumber version ( ) const
inline

Return the stream version.

Definition at line 405 of file IOstream.H.

Referenced by Field< Type >::Field(), Foam::operator>>(), IOobject::readHeader(), Foam::setversion(), and IOobject::writeHeader().

versionNumber version ( const versionNumber  ver)
inline

Set the stream version.

Definition at line 411 of file IOstream.H.

Foam::IOstream::compressionType compressionEnum ( const word compression)
static

Return compression of given compression name.

Definition at line 62 of file IOstream.C.

References IOstream::COMPRESSED, Foam::endl(), IOstream::UNCOMPRESSED, and WarningIn.

Referenced by IOstream::compression(), and Time::readDict().

compressionType compression ( ) const
inline

Return the stream compression.

Definition at line 422 of file IOstream.H.

Referenced by Foam::setcompression().

compressionType compression ( const compressionType  cmp)
inline

Set the stream compression.

Definition at line 428 of file IOstream.H.

compressionType compression ( const word cmp)
inline

Set the stream compression from word.

Definition at line 436 of file IOstream.H.

References IOstream::compressionEnum().

label lineNumber ( ) const
inline
label& lineNumber ( )
inline

Return current stream line number.

Definition at line 450 of file IOstream.H.

References IOstream::lineNumber_.

label lineNumber ( const label  ln)
inline

Set the stream line number.

Definition at line 456 of file IOstream.H.

References IOstream::lineNumber_, and Foam::ln().

virtual ios ::fmtflags flags ( ) const
pure virtual

Return flags of stream.

Implemented in ITstream, ISstream, OPstream, OSstream, and IPstream.

Referenced by IOstream::setf(), and IOstream::unsetf().

static unsigned int defaultPrecision ( )
inlinestatic

Return the default precision.

Definition at line 467 of file IOstream.H.

References IOstream::precision_.

Referenced by probes::checkFieldTypes(), and Time::readDict().

static unsigned int defaultPrecision ( unsigned int  p)
inlinestatic

Reset the default precision (and return old precision)

Definition at line 473 of file IOstream.H.

References p, and IOstream::precision_.

void setEof ( )
inline

Set stream to have reached eof.

Definition at line 481 of file IOstream.H.

void setFail ( )
inline

Set stream to have failed.

Definition at line 487 of file IOstream.H.

void setBad ( )
inline

Set stream to be bad.

Definition at line 493 of file IOstream.H.

Referenced by IOstream::IOstream(), and Foam::operator>>().

virtual ios ::fmtflags flags ( const ios::fmtflags  f)
pure virtual

Set flags of stream.

ios ::fmtflags setf ( const ios::fmtflags  f)
inline
ios ::fmtflags setf ( const ios::fmtflags  f,
const ios::fmtflags  mask 
)
inline

Set flags of given field of stream.

Definition at line 509 of file IOstream.H.

References IOstream::flags().

void unsetf ( const ios::fmtflags  uf)
inline

Unset flags of stream.

Definition at line 518 of file IOstream.H.

References IOstream::flags().

void print ( Ostream os) const
virtual

Print description of IOstream to Ostream.

Reimplemented in OPstream, OSstream, ITstream, IPstream, ISstream, OFstream, prefixOSstream, IFstream, OStringStream, and IStringStream.

Definition at line 124 of file IOstream.C.

References Foam::endl().

Referenced by Foam::operator<<(), and OSstream::print().

void print ( Ostream os,
const int  streamState 
) const

Check given stream state bits.

Definition at line 175 of file IOstream.C.

References Foam::endl().

InfoProxy<IOstream> info ( ) const
inline

Return info proxy.

Used to print IOstream information to a stream

Reimplemented in primitiveEntry.

Definition at line 537 of file IOstream.H.

Referenced by Foam::operator>>(), and IOobject::writeHeader().


Friends And Related Function Documentation

Ostream& operator<< ( Ostream os,
const streamFormat sf 
)
friend

Ostream operator.


Member Data Documentation

const IOstream::versionNumber originalVersion
static

Original version number.

Definition at line 208 of file IOstream.H.

Referenced by Foam::operator>>().

const IOstream::versionNumber currentVersion
static

Current version number.

Definition at line 211 of file IOstream.H.

Referenced by regIOobject::write(), globalMeshData::write(), and meshReader::writeMesh().

unsigned int precision_
static

Default precision.

Definition at line 214 of file IOstream.H.

Referenced by IOstream::defaultPrecision().

label lineNumber_
protected

Definition at line 236 of file IOstream.H.

Referenced by ISstream::get(), and IOstream::lineNumber().


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