ITstream Class Reference

Input token stream. More...

#include <OpenFOAM/ITstream.H>

---

Detailed Description

Input token stream.

Source files

• src/OpenFOAM/db/IOstreams/Tstreams/ITstream.H
• src/OpenFOAM/db/IOstreams/Tstreams/ITstream.C

Definition at line 50 of file ITstream.H.

Inheritance diagram for ITstream:

Collaboration diagram for ITstream:

List of all members.

Public Member Functions
	ITstream (const string &name, const tokenList &tokens, streamFormat format=ASCII, versionNumber version=currentVersion)
	Construct from components.
	ITstream (const ITstream &its)
	Construct as copy.
virtual	~ITstream ()
const fileName &	name () const
	Return the name of the stream.
fileName &	name ()
	Return non-const access to the name of the stream.
label	tokenIndex () const
	Return the current token index.
label &	tokenIndex ()
	Return non-const access to the current token index.
label	nRemainingTokens () const
	Return the number of remaining tokens.
ios_base::fmtflags	flags () const
	Return flags of output stream.
virtual Istream &	read (token &)
	Return next token from stream.
virtual Istream &	read (char &)
	Read a character.
virtual Istream &	read (word &)
	Read a word.
virtual Istream &	read (string &)
virtual Istream &	read (label &)
	Read a label.
virtual Istream &	read (floatScalar &)
	Read a floatScalar.
virtual Istream &	read (doubleScalar &)
	Read a doubleScalar.
virtual Istream &	read (char *, std::streamsize)
	Read binary block.
virtual Istream &	rewind ()
	Rewind and return the stream so that it may be read again.
ios_base::fmtflags	flags (const ios_base::fmtflags)
	Set flags of stream.
void	print (Ostream &) const
	Print description of IOstream to Ostream.

---

Constructor & Destructor Documentation

ITstream	(	const string &	name,
		const tokenList &	tokens,
		streamFormat	format = ASCII,
		versionNumber	version = currentVersion
	)		[inline]

Construct from components.

Definition at line 70 of file ITstream.H.

References IOstream::setGood(), and IOstream::setOpened().

ITstream

(

const ITstream &

its  )

[inline]

Construct as copy.

Definition at line 88 of file ITstream.H.

References IOstream::setGood(), and IOstream::setOpened().

virtual ~ITstream

(

)

[inline, virtual]

Definition at line 102 of file ITstream.H.

---

Member Function Documentation

const fileName& name

(

)

const [inline, virtual]

Return the name of the stream.

Reimplemented from IOstream.

Reimplemented in primitiveEntry.

Definition at line 111 of file ITstream.H.

fileName& name

(

)

[inline, virtual]

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

Reimplemented from IOstream.

Reimplemented in primitiveEntry.

Definition at line 117 of file ITstream.H.

label tokenIndex

(

)

const [inline]

Return the current token index.

Definition at line 123 of file ITstream.H.

label& tokenIndex

(

)

[inline]

Return non-const access to the current token index.

Definition at line 129 of file ITstream.H.

label nRemainingTokens

(

)

const [inline]

Return the number of remaining tokens.

Definition at line 135 of file ITstream.H.

References List< T >::size().

ios_base::fmtflags flags

(

)

const [inline, virtual]

Return flags of output stream.

Implements IOstream.

Definition at line 141 of file ITstream.H.

Foam::Istream & read

(

token &

t  )

[virtual]

Return next token from stream.

Implements Istream.

Definition at line 56 of file ITstream.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, Istream::getBack(), token::lineNumber(), and token::undefinedToken.

Foam::Istream & read

(

char &

)

[virtual]

Read a character.

Implements Istream.

Definition at line 110 of file ITstream.C.

References notImplemented.

Foam::Istream & read

(

word &

)

[virtual]

Read a word.

Implements Istream.

Definition at line 117 of file ITstream.C.

References notImplemented.

Foam::Istream & read

(

string &

)

[virtual]

Implements Istream.

Definition at line 124 of file ITstream.C.

References notImplemented.

Foam::Istream & read

(

label &

)

[virtual]

Read a label.

Implements Istream.

Definition at line 131 of file ITstream.C.

References notImplemented.

Foam::Istream & read

(

floatScalar &

)

[virtual]

Read a floatScalar.

Implements Istream.

Definition at line 138 of file ITstream.C.

References notImplemented.

Foam::Istream & read

(

doubleScalar &

)

[virtual]

Read a doubleScalar.

Implements Istream.

Definition at line 145 of file ITstream.C.

References notImplemented.

Foam::Istream & read	(	char *	,
		std::streamsize
	)		[virtual]

Read binary block.

Implements Istream.

Definition at line 152 of file ITstream.C.

References notImplemented.

Foam::Istream & rewind

(

)

[virtual]

Rewind and return the stream so that it may be read again.

Implements Istream.

Definition at line 160 of file ITstream.C.

References IOstream::lineNumber().

Referenced by primitiveEntry::stream().

ios_base::fmtflags flags

(

const ios_base::fmtflags

)

[inline]

Set flags of stream.

Definition at line 180 of file ITstream.H.

void print

(

Ostream &

os  )

const [virtual]

Print description of IOstream to Ostream.

Reimplemented from IOstream.

Definition at line 31 of file ITstream.C.

References UList< T >::begin(), IOstream::lineNumber(), UList< T >::rbegin(), and List< T >::size().

Referenced by Foam::operator<<().

---

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

• src/OpenFOAM/db/IOstreams/Tstreams/ITstream.H
• src/OpenFOAM/db/IOstreams/Tstreams/ITstream.C