Public Member Functions | Private Attributes
ITstream Class Reference

Input token stream. More...

Inheritance diagram for ITstream:
Inheritance graph
[legend]
Collaboration diagram for ITstream:
Collaboration graph
[legend]

Public Member Functions

 ITstream (const string &name, const UList< token > &tokens, streamFormat format=ASCII, versionNumber version=currentVersion)
 Construct from components. More...
 
 ITstream (const string &name, const Xfer< List< token > > &tokens, streamFormat format=ASCII, versionNumber version=currentVersion)
 Construct from components, transferring the tokens. More...
 
 ITstream (const ITstream &its)
 Construct as copy. More...
 
virtual ~ITstream ()
 Destructor. More...
 
const fileNamename () const
 Return the name of the stream. More...
 
fileNamename ()
 Return non-const access to the name of the stream. More...
 
label tokenIndex () const
 Return the current token index. More...
 
labeltokenIndex ()
 Return non-const access to the current token index. More...
 
label nRemainingTokens () const
 Return the number of remaining tokens. More...
 
ios_base::fmtflags flags () const
 Return flags of output stream. More...
 
virtual Istreamread (token &)
 Return next token from stream. More...
 
virtual Istreamread (char &)
 Read a character. More...
 
virtual Istreamread (word &)
 Read a word. More...
 
virtual Istreamread (string &)
 
virtual Istreamread (label &)
 Read a label. More...
 
virtual Istreamread (floatScalar &)
 Read a floatScalar. More...
 
virtual Istreamread (doubleScalar &)
 Read a doubleScalar. More...
 
virtual Istreamread (char *, std::streamsize)
 Read binary block. More...
 
virtual Istreamrewind ()
 Rewind and return the stream so that it may be read again. More...
 
ios_base::fmtflags flags (const ios_base::fmtflags)
 Set flags of stream. More...
 
void print (Ostream &) const
 Print description of IOstream to Ostream. More...
 
- Public Member Functions inherited from Istream
 Istream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Set stream status. More...
 
virtual ~Istream ()
 Destructor. More...
 
void putBack (const token &)
 Put back token. More...
 
bool getBack (token &)
 Get the put back token if there is one and return true. More...
 
bool peekBack (token &)
 Peek at the put back token without removing it. More...
 
IstreamreadBegin (const char *funcName)
 
IstreamreadEnd (const char *funcName)
 
IstreamreadEndBegin (const char *funcName)
 
char readBeginList (const char *funcName)
 
char readEndList (const char *funcName)
 
Istreamoperator() () const
 Return a non-const reference to const Istream. More...
 
- Public Member Functions inherited from IOstream
 IOstream (streamFormat format, versionNumber version, compressionType compression=UNCOMPRESSED)
 Construct setting format and version. More...
 
virtual ~IOstream ()
 Destructor. More...
 
virtual bool check (const char *operation) const
 Check IOstream status for given operation. More...
 
void fatalCheck (const char *operation) const
 Check IOstream status for given operation. More...
 
bool opened () const
 Return true if stream has been opened. More...
 
bool closed () const
 Return true if stream is closed. More...
 
bool good () const
 Return true if next operation might succeed. More...
 
bool eof () const
 Return true if end of input seen. More...
 
bool fail () const
 Return true if next operation will fail. More...
 
bool bad () const
 Return true if stream is corrupted. More...
 
 operator void * () const
 Return non-zero if the stream has not failed. More...
 
bool operator! () const
 Return true if the stream has failed. More...
 
streamFormat format () const
 Return current stream format. More...
 
streamFormat format (const streamFormat fmt)
 Set the stream format. More...
 
streamFormat format (const word &fmt)
 Set the stream format from word. More...
 
versionNumber version () const
 Return the stream version. More...
 
versionNumber version (const versionNumber ver)
 Set the stream version. More...
 
compressionType compression () const
 Return the stream compression. More...
 
compressionType compression (const compressionType cmp)
 Set the stream compression. More...
 
compressionType compression (const word &cmp)
 Set the stream compression from word. More...
 
label lineNumber () const
 Return current stream line number. More...
 
labellineNumber ()
 Return current stream line number. More...
 
label lineNumber (const label ln)
 Set the stream line number. More...
 
void setEof ()
 Set stream to have reached eof. More...
 
void setFail ()
 Set stream to have failed. More...
 
void setBad ()
 Set stream to be bad. More...
 
ios_base::fmtflags setf (const ios_base::fmtflags f)
 Set flags of stream. More...
 
ios_base::fmtflags setf (const ios_base::fmtflags f, const ios_base::fmtflags mask)
 Set flags of given field of stream. More...
 
void unsetf (const ios_base::fmtflags uf)
 Unset flags of stream. More...
 
void print (Ostream &, const int streamState) const
 Check given stream state bits. More...
 
InfoProxy< IOstreaminfo () const
 Return info proxy. More...
 
- Public Member Functions inherited from List
 List ()
 Null constructor. More...
 
 List (const label)
 Construct with given size. More...
 
 List (const label, const T &)
 Construct with given size and value for all elements. More...
 
 List (const List< T > &)
 Copy constructor. More...
 
 List (const Xfer< List< T > > &)
 Construct by transferring the parameter contents. More...
 
 List (List< T > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< T > &, const labelUList &mapAddressing)
 Construct as subset. More...
 
template<class InputIterator >
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
template<unsigned Size>
 List (const FixedList< T, Size > &)
 Construct as copy of FixedList<T, Size> More...
 
 List (const PtrList< T > &)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< T > &)
 Construct as copy of SLList<T> More...
 
 List (const UIndirectList< T > &)
 Construct as copy of UIndirectList<T> More...
 
 List (const BiIndirectList< T > &)
 Construct as copy of BiIndirectList<T> More...
 
 List (Istream &)
 Construct from Istream. More...
 
autoPtr< List< T > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
label size () const
 Return the number of elements in the UList. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void resize (const label, const T &)
 Alias for setSize(const label, const T&) More...
 
void setSize (const label)
 Reset size of List. More...
 
void setSize (const label, const T &)
 Reset size of List and value for new elements. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void append (const T &)
 Append an element at the end of the list. More...
 
void append (const UList< T > &)
 Append a List at the end of this list. More...
 
void append (const UIndirectList< T > &)
 Append a UIndirectList at the end of this list. More...
 
void transfer (List< T > &)
 Transfer the contents of the argument List into this list. More...
 
template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
void transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (SortableList< T > &)
 Transfer the contents of the argument List into this list. More...
 
Xfer< List< T > > xfer ()
 Transfer contents to the Xfer container. More...
 
TnewElmt (const label)
 Return subscript-checked element of UList. More...
 
void operator= (const UList< T > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const List< T > &)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< T > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< T > &)
 Assignment from UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< T > &)
 Assignment from BiIndirectList operator. Takes linear time. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
template<class T >
 List (const label s)
 
template<class T >
 List (const label s, const T &a)
 
template<class T >
 List (const List< T > &a)
 
template<class T >
 List (const Xfer< List< T > > &lst)
 
template<class T >
 List (List< T > &a, bool reUse)
 
template<class T >
 List (const UList< T > &a, const labelUList &map)
 
template<class T >
 List (const PtrList< T > &lst)
 
template<class T >
 List (const SLList< T > &lst)
 
template<class T >
 List (const UIndirectList< T > &lst)
 
template<class T >
 List (const BiIndirectList< T > &lst)
 
template<class T >
void transfer (List< T > &a)
 
template<class T >
void transfer (SortableList< T > &a)
 
template<class T >
 List ()
 
template<class T >
 List (Istream &is)
 

Private Attributes

fileName name_
 Name of ITstream. More...
 
label tokenIndex_
 Index of token currently being read. More...
 

Additional Inherited Members

- Public Types inherited from IOstream
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 Types inherited from List
typedef SubList< TsubList
 Declare type of subList. More...
 
- Static Public Member Functions inherited from IOstream
static streamFormat formatEnum (const word &)
 Return stream format of given format name. More...
 
static compressionType compressionEnum (const word &)
 Return compression of given compression name. More...
 
static unsigned int defaultPrecision ()
 Return the default precision. More...
 
static unsigned int defaultPrecision (unsigned int p)
 Reset the default precision (and return old precision) More...
 
- Static Public Member Functions inherited from List
static const List< T > & null ()
 Return a null List. More...
 
- Static Public Attributes inherited from IOstream
static const versionNumber originalVersion
 Original version number. More...
 
static const versionNumber currentVersion
 Current version number. More...
 
static unsigned int precision_
 Default precision. More...
 
- Protected Member Functions inherited from IOstream
void setOpened ()
 Set stream opened. More...
 
void setClosed ()
 Set stream closed. More...
 
void setState (ios_base::iostate state)
 Set stream state. More...
 
void setGood ()
 Set stream to be good. More...
 
- Protected Member Functions inherited from List
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 
- Protected Attributes inherited from IOstream
label lineNumber_
 

Detailed Description

Input token stream.

Source files

Definition at line 49 of file ITstream.H.

Constructor & Destructor Documentation

◆ ITstream() [1/3]

ITstream ( const string name,
const UList< token > &  tokens,
streamFormat  format = ASCII,
versionNumber  version = currentVersion 
)
inline

Construct from components.

Definition at line 69 of file ITstream.H.

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

Here is the call graph for this function:

◆ ITstream() [2/3]

ITstream ( const string name,
const Xfer< List< token > > &  tokens,
streamFormat  format = ASCII,
versionNumber  version = currentVersion 
)
inline

Construct from components, transferring the tokens.

Definition at line 88 of file ITstream.H.

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

Here is the call graph for this function:

◆ ITstream() [3/3]

ITstream ( const ITstream its)
inline

Construct as copy.

Definition at line 106 of file ITstream.H.

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

Here is the call graph for this function:

◆ ~ITstream()

virtual ~ITstream ( )
inlinevirtual

Destructor.

Definition at line 119 of file ITstream.H.

Member Function Documentation

◆ name() [1/2]

const fileName& name ( ) const
inlinevirtual

Return the name of the stream.

Reimplemented from IOstream.

Definition at line 128 of file ITstream.H.

References ITstream::name_.

Referenced by primitiveEntry::name().

Here is the caller graph for this function:

◆ name() [2/2]

fileName& name ( )
inlinevirtual

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

Reimplemented from IOstream.

Definition at line 134 of file ITstream.H.

References ITstream::name_.

◆ tokenIndex() [1/2]

label tokenIndex ( ) const
inline

Return the current token index.

Definition at line 140 of file ITstream.H.

References ITstream::tokenIndex_.

Referenced by primitiveEntry::append().

Here is the caller graph for this function:

◆ tokenIndex() [2/2]

label& tokenIndex ( )
inline

Return non-const access to the current token index.

Definition at line 146 of file ITstream.H.

References ITstream::tokenIndex_.

◆ nRemainingTokens()

label nRemainingTokens ( ) const
inline

Return the number of remaining tokens.

Definition at line 152 of file ITstream.H.

References List::size(), and ITstream::tokenIndex_.

Here is the call graph for this function:

◆ flags() [1/2]

ios_base::fmtflags flags ( ) const
inlinevirtual

Return flags of output stream.

Implements IOstream.

Definition at line 158 of file ITstream.H.

◆ read() [1/8]

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, FatalIOErrorInFunction, Istream::getBack(), token::lineNumber(), and token::undefinedToken.

Referenced by fieldVisualisationBase::fieldVisualisationBase().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ read() [2/8]

Foam::Istream & read ( char &  )
virtual

Read a character.

Implements Istream.

Definition at line 108 of file ITstream.C.

References NotImplemented.

◆ read() [3/8]

Foam::Istream & read ( word )
virtual

Read a word.

Implements Istream.

Definition at line 115 of file ITstream.C.

References NotImplemented.

◆ read() [4/8]

Foam::Istream & read ( string )
virtual

Implements Istream.

Definition at line 122 of file ITstream.C.

References NotImplemented.

◆ read() [5/8]

Foam::Istream & read ( label )
virtual

Read a label.

Implements Istream.

Definition at line 129 of file ITstream.C.

References NotImplemented.

◆ read() [6/8]

Foam::Istream & read ( floatScalar )
virtual

Read a floatScalar.

Implements Istream.

Definition at line 136 of file ITstream.C.

References NotImplemented.

◆ read() [7/8]

Foam::Istream & read ( doubleScalar )
virtual

Read a doubleScalar.

Implements Istream.

Definition at line 143 of file ITstream.C.

References NotImplemented.

◆ read() [8/8]

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

Read binary block.

Implements Istream.

Definition at line 150 of file ITstream.C.

References NotImplemented.

◆ rewind()

Foam::Istream & rewind ( )
virtual

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

Implements Istream.

Definition at line 157 of file ITstream.C.

References IOstream::lineNumber().

Referenced by primitiveEntry::stream().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ flags() [2/2]

ios_base::fmtflags flags ( const ios_base::fmtflags  )
inlinevirtual

Set flags of stream.

Implements IOstream.

Definition at line 197 of file ITstream.H.

◆ print()

void print ( Ostream os) const
virtual

Print description of IOstream to Ostream.

Reimplemented from IOstream.

Definition at line 31 of file ITstream.C.

References IOstream::lineNumber(), ITstream::name_, IOstream::print(), and List::size().

Here is the call graph for this function:

Field Documentation

◆ name_

fileName name_
private

Name of ITstream.

Definition at line 57 of file ITstream.H.

Referenced by ITstream::name(), ITstream::print(), and runTimePostProcessing::read().

◆ tokenIndex_

label tokenIndex_
private

Index of token currently being read.

Definition at line 60 of file ITstream.H.

Referenced by ITstream::nRemainingTokens(), and ITstream::tokenIndex().


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