An input stream of tokens. More...

Inheritance diagram for ITstream:

Collaboration diagram for ITstream:

Public Member Functions
	ITstream (const ITstream &is)
	Copy construct. More...

	ITstream (ITstream &&is)
	Move construct. More...

	ITstream (IOstreamOption streamOpt=IOstreamOption(), const string &name="input")
	Default construct. Empty stream, optionally with given name. More...

	ITstream (const Foam::zero, const string &name="input", IOstreamOption streamOpt=IOstreamOption())
	Construct empty, optionally with given name. More...

	ITstream (const UList< token > &tokens, IOstreamOption streamOpt=IOstreamOption(), const string &name="input")
	Copy construct from tokens, optionally with given name. More...

	ITstream (List< token > &&tokens, IOstreamOption streamOpt=IOstreamOption(), const string &name="input")
	Move construct from tokens, optionally with given name. More...

	ITstream (const UList< char > &input, IOstreamOption streamOpt=IOstreamOption(), const string &name="input")
	Construct token list by parsing the input character sequence. More...

	ITstream (const std::string &input, IOstreamOption streamOpt=IOstreamOption(), const string &name="input")
	Construct token list by parsing the input string. More...

	ITstream (const char *input, IOstreamOption streamOpt=IOstreamOption(), const string &name="input")
	Construct token list by parsing the input character sequence. More...

	ITstream (const string &name, const UList< token > &tokens, IOstreamOption streamOpt=IOstreamOption())
	Copy construct from tokens, with given name. More...

	ITstream (const string &name, List< token > &&tokens, IOstreamOption streamOpt=IOstreamOption())
	Move construct from tokens, with given name. More...

virtual	~ITstream ()=default
	Destructor. More...

virtual const fileName &	name () const
	The name of the input token stream. More...

virtual fileName &	name ()
	The name of the input token stream, for modification. More...

bool	hasPutback () const noexcept
	True if putback token is in use. More...

const token &	front () const
	Failsafe peek at the first token in the list. More...

const token &	back () const
	Failsafe peek at the last token in the list. More...

const token &	peek () const
	Failsafe peek at what the next read would return, including handling of any putback. More...

label	tokenIndex () const noexcept
	The current token index when reading, or the insertion point. More...

label &	tokenIndex () noexcept
	Non-const access to the current token index. More...

label	nRemainingTokens () const noexcept
	Number of tokens remaining. More...

void	seek (label pos)
	Move tokenIndex to the specified position. More...

void	skip (label n=1)
	Move tokenIndex relative to the current position. More...

void	push_back (const token &t, const bool lazy)
	Copy append a token at the current tokenIndex, incrementing the index. More...

void	push_back (token &&t, const bool lazy)
	Move append a token at the current tokenIndex, incrementing the index. More...

void	push_back (const UList< token > &newTokens, const bool lazy)
	Copy append a list of tokens at the current tokenIndex, incrementing the index. More...

void	push_back (List< token > &&newTokens, const bool lazy)
	Move append a list of tokens at the current tokenIndex, incrementing the index. More...

virtual ios_base::fmtflags	flags () const
	Get stream flags - always 0. More...

ios_base::fmtflags	flags (const ios_base::fmtflags)
	Set flags of stream - ignored. More...

virtual Istream &	read (token &tok)
	Return next token from stream. More...

virtual Istream &	read (char &)
	Read a character. More...

virtual Istream &	read (word &)
	Read a word. More...

virtual Istream &	read (string &)
	Read a string (including enclosing double-quotes) More...

virtual Istream &	read (label &)
	Read a label. More...

virtual Istream &	read (float &)
	Read a float. More...

virtual Istream &	read (double &)
	Read a double. More...

virtual Istream &	read (char *data, std::streamsize)
	Read binary block. More...

virtual Istream &	readRaw (char *data, std::streamsize count)
	Low-level raw binary read. More...

virtual bool	beginRawRead ()
	Start of low-level raw binary read. More...

virtual bool	endRawRead ()
	End of low-level raw binary read. More...

virtual void	rewind ()
	Rewind the stream so that it may be read again. More...

void	print (Ostream &os) const
	Print stream description to Ostream. More...

std::string	toString () const
	Concatenate tokens into a space-separated std::string. The resulting string may contain quote characters. More...

void	operator= (const ITstream &is)
	Copy assignment, with rewind() More...

void	operator= (const UList< token > &toks)
	Copy assignment of tokens, with rewind() More...

void	operator= (List< token > &&toks)
	Move assignment of tokens, with rewind() More...

const token &	peekFirst () const
	Same as front() More...

void	append (const token &t, const bool lazy)
	Copy append a token at the current tokenIndex, incrementing the index. More...

void	append (token &&t, const bool lazy)
	Move append a token at the current tokenIndex, incrementing the index. More...

void	append (const UList< token > &newTokens, const bool lazy)
	Copy append a list of tokens at the current tokenIndex, incrementing the index. More...

void	append (List< token > &&newTokens, const bool lazy)
	Move append a list of tokens at the current tokenIndex, incrementing the index. More...

Public Member Functions inherited from Istream
	Istream (const Istream &)=default
	Copy construct. More...

virtual	~Istream ()=default
	Destructor. More...

	Istream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option. More...

	Istream (IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format (uncompressed) More...

const token &	peekBack () const noexcept
	Examine putback token without removing it. More...

bool	peekBack (token &tok)
	Fetch putback token without removing it. More...

void	putBack (const token &tok)
	Put back a token. Only a single put back is permitted. More...

bool	getBack (token &tok)
	Get the put-back token if there is one. More...

bool	readBegin (const char *funcName)
	Begin read of data chunk, starts with '('. More...

bool	readEnd (const char *funcName)
	End read of data chunk, ends with ')'. More...

char	readBeginList (const char *funcName)
	Begin read of list data, starts with '(' or '{'. More...

char	readEndList (const char *funcName)
	End read of list data, ends with ')' or '}'. More...

Istream &	operator() () const
	Return a non-const reference to const Istream. More...

Public Member Functions inherited from IOstream
	IOstream (const IOstream &)=default
	Copy construct. More...

virtual	~IOstream ()=default
	Destructor. More...

	IOstream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option. More...

	IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format, version (compression) More...

fileName	relativeName () const
	Return the name of the stream relative to the current case. More...

virtual bool	check (const char *operation) const
	Check IOstream status for given operation. More...

bool	fatalCheck (const char *operation) const
	Check IOstream status for given operation. More...

bool	opened () const noexcept
	True if stream has been opened. More...

bool	closed () const noexcept
	True if stream is closed. More...

bool	good () const noexcept
	True if next operation might succeed. More...

bool	eof () const noexcept
	True if end of input seen. More...

bool	fail () const noexcept
	True if next operation will fail. More...

bool	bad () const noexcept
	True if stream is corrupted. More...

	operator bool () const noexcept
	Return true if the stream has not failed. More...

bool	operator! () const noexcept
	Return true if the stream has failed. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes associated with the stream. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes associated with the stream. More...

void	setLabelByteSize (unsigned nbytes) noexcept
	Set the sizeof (label) in bytes associated with the stream. More...

void	setScalarByteSize (unsigned nbytes) noexcept
	Set the sizeof (scalar) in bytes associated with the stream. More...

template<class T = label>
std::enable_if< std::is_integral< T >::value, bool >::type	checkLabelSize () const noexcept
	Check if the label byte-size associated with the stream is the same as the given type. More...

template<class T = scalar>
std::enable_if< std::is_floating_point< T >::value, bool >::type	checkScalarSize () const noexcept
	Check if the scalar byte-size associated with the stream is the same as the given type. More...

label	lineNumber () const noexcept
	Const access to the current stream line number. More...

label &	lineNumber () noexcept
	Non-const access to the current stream line number. More...

label	lineNumber (const label num) noexcept
	Set the stream line number. More...

void	setEof () noexcept
	Set stream state as reached 'eof'. More...

void	setFail () noexcept
	Set stream state as 'failed'. More...

void	setBad ()
	Set stream state 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 f)
	Unset flags of stream. More...

void	print (Ostream &os, const int streamState) const
	Print information about the stream state bits. More...

InfoProxy< IOstream >	info () const
	Return info proxy. More...

Public Member Functions inherited from IOstreamOption
constexpr	IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept
	Default construct (ASCII, UNCOMPRESSED, currentVersion) or construct with format, compression. More...

constexpr	IOstreamOption (streamFormat fmt, compressionType comp, versionNumber ver) noexcept
	Construct from components (format, compression, version) More...

constexpr	IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept
	Construct from components (format, version, compression) More...

	IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept
	Copy construct with change of format. More...

streamFormat	format () const noexcept
	Get the current stream format. More...

streamFormat	format (const streamFormat fmt) noexcept
	Set the stream format. More...

streamFormat	format (const word &formatName)
	Set the stream format from string value. More...

compressionType	compression () const noexcept
	Get the stream compression. More...

compressionType	compression (const compressionType comp) noexcept
	Set the stream compression. More...

compressionType	compression (const word &compName)
	Set the stream compression from string value. More...

versionNumber	version () const noexcept
	Get the stream version. More...

versionNumber	version (const versionNumber ver) noexcept
	Set the stream version. More...

versionNumber	version (const token &tok)
	Set the stream version from token. More...

Public Member Functions inherited from List< T >
constexpr	List () noexcept
	Default construct. More...

	List (const label len)
	Construct with given size. More...

	List (const label len, const T &val)
	Construct with given size and value for all elements. More...

	List (const label len, const Foam::zero)
	Construct with given size initializing all elements to zero. More...

	List (const Foam::one, const T &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, T &&val)
	Construct with length=1, moving the value as the only content. More...

	List (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...

	List (const List< T > &a)
	Copy construct from list. More...

	List (const UList< T > &a)
	Copy construct contents from list. More...

	List (List< T > &a, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< T > &list, const labelUList &indices)
	Copy construct subset of list. More...

template<unsigned N>
	List (const UList< T > &list, const FixedList< label, N > &indices)
	Copy construct subset of list. More...

template<unsigned N>
	List (const FixedList< T, N > &list)
	Construct as copy of FixedList<T, N> More...

	List (const PtrList< T > &list)
	Construct as copy of PtrList<T> More...

	List (const SLList< T > &list)
	Construct as copy of SLList<T> More...

template<class Addr >
	List (const IndirectListBase< T, Addr > &list)
	Construct as copy of IndirectList contents. More...

	List (std::initializer_list< T > list)
	Construct from an initializer list. More...

	List (List< T > &&list)
	Move construct from List. More...

template<int SizeMin>
	List (DynamicList< T, SizeMin > &&list)
	Move construct from DynamicList. More...

	List (SLList< T > &&list)
	Move construct from SLList. More...

	List (Istream &is)
	Construct from Istream. More...

autoPtr< List< T > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

void	clear ()
	Clear the list, i.e. set size to zero. More...

void	resize (const label len)
	Adjust allocated size of list. More...

void	resize (const label len, const T &val)
	Adjust allocated size of list and set val for new elements. More...

void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily. More...

void	setSize (const label n)
	Alias for resize() More...

void	setSize (const label n, const T &val)
	Alias for resize() More...

void	transfer (List< T > &list)
	Transfer the contents of the argument List into this list and annul the argument list. More...

template<int SizeMin>
void	transfer (DynamicList< T, SizeMin > &list)
	Transfer the contents of the argument List into this list and annul the argument list. More...

T &	newElmt (const label i)
	Return subscript-checked element of UList and resizing the list if required. More...

void	push_back (const T &val)
	Append an element at the end of the list. More...

void	push_back (T &&val)
	Move append an element at the end of the list. More...

void	push_back (const UList< T > &list)
	Append a List to the end of this list. More...

template<class Addr >
void	push_back (const IndirectListBase< T, Addr > &list)
	Append IndirectList contents at the end of this list. More...

label	push_uniq (const T &val)
	Append an element if not already in the list. More...

void	pop_back (label n=1)
	Reduce size by 1 or more elements. Can be called on an empty list. More...

void	operator= (const UList< T > &a)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< T > &list)
	Assignment operator. Takes linear time. More...

void	operator= (const SLList< T > &list)
	Assignment to SLList operator. Takes linear time. More...

template<class Addr >
void	operator= (const IndirectListBase< T, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...

template<unsigned N>
void	operator= (const FixedList< T, N > &list)
	Copy assignment from FixedList. More...

void	operator= (std::initializer_list< T > list)
	Assignment to an initializer list. More...

void	operator= (const T &val)
	Assignment of all entries to the given value. More...

void	operator= (const Foam::zero)
	Assignment of all entries to zero. More...

void	operator= (List< T > &&list)
	Move assignment. Takes constant time. More...

template<int SizeMin>
void	operator= (DynamicList< T, SizeMin > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< T > &&list)
	Move assignment. Takes constant time. More...

Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List. More...

void	shallowCopy (const UList< T > &)=delete
	No shallowCopy permitted. More...

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool. More...

void	append (const T &val)
	Append an element at the end of the list. More...

void	append (T &&val)
	Move append an element at the end of the list. More...

void	append (const UList< T > &list)
	Append a List to the end of this list. More...

template<class Addr >
void	append (const IndirectListBase< T, Addr > &list)
	Append IndirectList contents at the end of this list. More...

label	appendUniq (const T &val)
	Append an element if not already in the list. More...

template<>
Istream &	readList (Istream &is)
	Specialized list reading for character lists which always uses binary format. More...

template<>
void	resize (const label newLen)

template<>
Istream &	readList (Istream &is)

Public Member Functions inherited from UList< T >
	UList (const UList< T > &)=default
	Copy construct. More...

constexpr	UList () noexcept
	Default construct, zero-sized and nullptr. More...

	UList (T *__restrict__ v, const label len) noexcept
	Construct from components. More...

label	fcIndex (const label i) const noexcept
	The forward circular index. The next index in the list which returns to the first at the end of the list. More...

label	rcIndex (const label i) const noexcept
	The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More...

const T &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list) More...

T &	fcValue (const label i)
	Return forward circular value (ie, next value in the list) More...

const T &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list) More...

T &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list) More...

const T *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage. More...

T *	data () noexcept
	Return pointer to the underlying array serving as data storage. More...

const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,. More...

char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,. More...

T &	front ()
	Access first element of the list, position [0]. More...

const T &	front () const
	Access first element of the list. More...

T &	back ()
	Access last element of the list, position [size()-1]. More...

const T &	back () const
	Access last element of the list, position [size()-1]. More...

std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data. More...

std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More...

void	checkStart (const label start) const
	Check start is within valid range [0,size) More...

void	checkSize (const label size) const
	Check size is within valid range [0,size]. More...

void	checkRange (const label start, const label len) const
	Check that start and length define a valid range. More...

void	checkIndex (const label i) const
	Check index is within valid range [0,size) More...

bool	uniform () const
	True if all entries have identical values, and list is non-empty. More...

label	find (const T &val, label pos=0) const
	Find index of the first occurrence of the value. More...

label	rfind (const T &val, label pos=-1) const
	Find index of the last occurrence of the value. More...

bool	found (const T &val, label pos=0) const
	True if the value if found in the list. More...

void	moveFirst (const label i)
	Move element to the first position. More...

void	moveLast (const label i)
	Move element to the last position. More...

void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list. More...

void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list. More...

void	shallowCopy (const UList< T > &list)
	Copy the pointer and size held by the given UList. More...

void	deepCopy (const UList< T > &list)
	Copy elements of the given UList. Sizes must match! More...

template<class Addr >
void	deepCopy (const IndirectListBase< T, Addr > &list)
	Copy elements of the given indirect list. Sizes must match! More...

SubList< T >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking. More...

const SubList< T >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking. More...

SubList< T >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking. More...

const SubList< T >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking. More...

T &	operator[] (const label i)
	Return element of UList. More...

const T &	operator[] (const label i) const
	Return element of constant UList. More...

	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&. More...

void	operator= (const T &val)
	Assignment of all entries to the given value. More...

void	operator= (const Foam::zero)
	Assignment of all entries to zero. More...

iterator	begin () noexcept
	Return an iterator to begin traversing the UList. More...

iterator	end () noexcept
	Return an iterator to end traversing the UList. More...

const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList. More...

const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant UList. More...

reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList. More...

reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

label	size () const noexcept
	The number of elements in the UList. More...

bool	empty () const noexcept
	True if the UList is empty (ie, size() is zero) More...

void	swap (UList< T > &list)
	Swap content with another UList of the same type in constant time. More...

bool	operator== (const UList< T > &a) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< T > &a) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< T > &list) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< T > &a) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< T > &a) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< T > &a) const
	Return true if !(a < b). Takes linear time. More...

Istream &	readList (Istream &is)
	Read List contents from Istream. More...

void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword. More...

Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen. More...

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	test (const label i) const
	Test `bool` value at specified position, always false for out-of-range access. More...

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	get (const label i) const
	Return `bool` value at specified position, always false for out-of-range access. More...

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	unset (const label i)
	Unset the `bool` entry at specified position, always false for out-of-range access. More...

T &	first ()
	Access first element of the list, position [0]. More...

const T &	first () const
	Access first element of the list. More...

T &	last ()
	Access last element of the list, position [size()-1]. More...

const T &	last () const
	Access last element of the list, position [size()-1]. More...

template<>
Istream &	readList (Istream &is)
	Specialized list reading for character lists which always uses binary format. More...

template<>
Ostream &	writeList (Ostream &os, const label) const
	Specialized writeList for character lists which always uses binary format. More...

template<>
const bool &	operator[] (const label i) const

template<>
Foam::UPstream::commsStruct &	operator[] (const label procID)

template<>
const Foam::UPstream::commsStruct &	operator[] (const label procID) const

template<>
UPstream::commsStruct &	operator[] (const label procID)

template<>
const UPstream::commsStruct &	operator[] (const label procID) const

template<>
Ostream &	writeList (Ostream &os, const label) const

template<>
Istream &	readList (Istream &is)

Static Public Member Functions
static tokenList	parse (const UList< char > &input, IOstreamOption streamOpt=IOstreamOption())
	Create token list by parsing the input character sequence until no good tokens remain. More...

static tokenList	parse (const std::string &input, IOstreamOption streamOpt=IOstreamOption())
	Create token list by parsing the input string until no good tokens remain. More...

static tokenList	parse (const char *input, IOstreamOption streamOpt=IOstreamOption())
	Create token list by parsing the input character sequence until no good tokens remain. More...

Static Public Member Functions inherited from IOstream
static unsigned int	defaultPrecision () noexcept
	Return the default precision. More...

static unsigned int	defaultPrecision (unsigned int prec) noexcept
	Reset the default precision. More...

Static Public Member Functions inherited from IOstreamOption
static streamFormat	formatEnum (const word &formatName, const streamFormat deflt=streamFormat::ASCII)
	The stream format enum corresponding to the string (ascii \| binary). More...

static streamFormat	formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII)
	Failsafe construct streamFormat from optional dictionary lookup. More...

static compressionType	compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)
	The compression enum corresponding to the string. More...

static compressionType	compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED)
	Failsafe construct compressionType from optional dictionary lookup. More...

Static Public Member Functions inherited from List< T >
static const List< T > &	null ()
	Return a null List. More...

Static Public Member Functions inherited from UList< T >
static const UList< T > &	null ()
	Return a UList reference to a nullObject. More...

static constexpr label	max_size () noexcept
	The size of the largest possible UList. More...

Additional Inherited Members
Public Types inherited from IOstream
enum	streamAccess : char { CLOSED = 0, OPENED }
	Enumeration for stream open/closed state. More...

Public Types inherited from IOstreamOption
enum	streamFormat : char { ASCII = 0, BINARY }
	Data format (ascii \| binary) More...

enum	compressionType : char { UNCOMPRESSED = 0, COMPRESSED }
	Compression treatment (UNCOMPRESSED \| COMPRESSED) More...

enum	appendType : char { NON_APPEND = 0, APPEND }
	File appending (NON_APPEND \| APPEND) More...

enum	atomicType : char { NON_ATOMIC = 0, ATOMIC }
	Atomic operations (output) More...

Public Types inherited from List< T >
typedef SubList< T >	subList
	Declare type of subList. More...

Public Types inherited from UList< T >
typedef T	value_type
	The value type the list contains. More...

typedef T *	pointer
	The pointer type for non-const access to value_type items. More...

typedef const T *	const_pointer
	The pointer type for const access to value_type items. More...

typedef T &	reference
	The type used for storing into value_type objects. More...

typedef const T &	const_reference
	The type used for reading from constant value_type objects. More...

typedef T *	iterator
	Random access iterator for traversing a UList. More...

typedef const T *	const_iterator
	Random access iterator for traversing a UList. More...

typedef label	size_type
	The type to represent the size of a UList. More...

typedef label	difference_type
	The difference between iterator objects. More...

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access) More...

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access) More...

Static Public Attributes inherited from IOstream
static unsigned int	precision_
	Default precision. More...

Static Public Attributes inherited from IOstreamOption
static const Enum< streamFormat >	formatNames
	Stream format names (ascii, binary) More...

static const versionNumber	currentVersion
	The current version number (2.0) More...

Protected Member Functions inherited from Istream
bool	hasPutback () const noexcept
	True if putback token is in use. More...

Protected Member Functions inherited from IOstream
void	setOpened () noexcept
	Set stream opened. More...

void	setClosed () noexcept
	Set stream closed. More...

void	setState (std::ios_base::iostate state) noexcept
	Set stream state. More...

void	setGood () noexcept
	Set stream state to be good. More...

Protected Member Functions inherited from UList< T >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage. More...

void	size (const label n)
	Older name for setAddressableSize. More...

void	writeEntry (Ostream &os) const
	Write the UList with its compound type. More...

labelRange	validateRange (const labelRange &requestedRange) const
	Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. More...

UList< T > &	operator= (const UList< T > &)=delete
	No copy assignment (default: shallow copy) More...

template<>
void	writeEntry (Ostream &os) const
	Specialized writeEntry for character lists which always uses binary format. More...

template<>
void	writeEntry (Ostream &os) const

Protected Attributes inherited from IOstream
std::ios_base::iostate	ioState_
	Mirror of internal stream io state. More...

streamAccess	openClosed_
	The stream open/closed state. More...

unsigned char	sizeofLabel_
	The sizeof (label), possibly read from the header. More...

unsigned char	sizeofScalar_
	The sizeof (scalar), possibly read from the header. More...

label	lineNumber_
	The file line. More...

Static Protected Attributes inherited from IOstream
static fileName	staticName_
	Name for any generic stream - normally treat as readonly. More...

Detailed Description

An input stream of tokens.

Source files

Definition at line 48 of file ITstream.H.

Constructor & Destructor Documentation

◆ ITstream() [1/11]

ITstream ( const ITstream & is )

Copy construct.

Definition at line 136 of file ITstream.C.

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

Here is the call graph for this function:

◆ ITstream() [2/11]

ITstream ( ITstream && is )

Move construct.

Definition at line 148 of file ITstream.C.

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

Here is the call graph for this function:

◆ ITstream() [3/11]

ITstream	(	IOstreamOption	streamOpt = `IOstreamOption()`,
		const string &	name = `"input"`
	)

explicit

Default construct. Empty stream, optionally with given name.

Definition at line 161 of file ITstream.C.

◆ ITstream() [4/11]

ITstream	(	const Foam::zero	,
		const string &	name = `"input"`,
		IOstreamOption	streamOpt = `IOstreamOption()`
	)

explicit

Construct empty, optionally with given name.

Definition at line 177 of file ITstream.C.

◆ ITstream() [5/11]

ITstream	(	const UList< token > &	tokens,
		IOstreamOption	streamOpt = `IOstreamOption()`,
		const string &	name = `"input"`
	)

explicit

Copy construct from tokens, optionally with given name.

Definition at line 188 of file ITstream.C.

◆ ITstream() [6/11]

ITstream	(	List< token > &&	tokens,
		IOstreamOption	streamOpt = `IOstreamOption()`,
		const string &	name = `"input"`
	)

explicit

Move construct from tokens, optionally with given name.

Definition at line 205 of file ITstream.C.

◆ ITstream() [7/11]

ITstream	(	const UList< char > &	input,
		IOstreamOption	streamOpt = `IOstreamOption()`,
		const string &	name = `"input"`
	)

explicit

Construct token list by parsing the input character sequence.

Uses static parse function internally.

Definition at line 222 of file ITstream.C.

References Foam::input(), Foam::parseStream(), and ITstream::rewind().

Here is the call graph for this function:

◆ ITstream() [8/11]

ITstream	(	const std::string &	input,
		IOstreamOption	streamOpt = `IOstreamOption()`,
		const string &	name = `"input"`
	)

explicit

Construct token list by parsing the input string.

Uses static parse function internally.

Definition at line 238 of file ITstream.C.

References Foam::input(), Foam::parseStream(), and ITstream::rewind().

Here is the call graph for this function:

◆ ITstream() [9/11]

ITstream	(	const char *	input,
		IOstreamOption	streamOpt = `IOstreamOption()`,
		const string &	name = `"input"`
	)

explicit

Construct token list by parsing the input character sequence.

Uses static parse function internally.

Definition at line 254 of file ITstream.C.

References Foam::input(), Foam::parseStream(), and ITstream::rewind().

Here is the call graph for this function:

◆ ITstream() [10/11]

ITstream	(	const string &	name,
		const UList< token > &	tokens,
		IOstreamOption	streamOpt = `IOstreamOption()`
	)

inline

Copy construct from tokens, with given name.

Definition at line 192 of file ITstream.H.

◆ ITstream() [11/11]

ITstream	(	const string &	name,
		List< token > &&	tokens,
		IOstreamOption	streamOpt = `IOstreamOption()`
	)

inline

Move construct from tokens, with given name.

Definition at line 205 of file ITstream.H.

◆ ~ITstream()

virtual ~ITstream ( )

virtualdefault

Destructor.

Member Function Documentation

◆ parse() [1/3]

Foam::tokenList parse	(	const UList< char > &	input,
		IOstreamOption	streamOpt = `IOstreamOption()`
	)

static

Create token list by parsing the input character sequence until no good tokens remain.

Definition at line 58 of file ITstream.C.

References Foam::input(), and Foam::parseStream().

Referenced by dictionary::tokens().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse() [2/3]

Foam::tokenList parse	(	const std::string &	input,
		IOstreamOption	streamOpt = `IOstreamOption()`
	)

static

Create token list by parsing the input string until no good tokens remain.

Definition at line 72 of file ITstream.C.

References Foam::input(), and Foam::parseStream().

Here is the call graph for this function:

◆ parse() [3/3]

Foam::tokenList parse	(	const char *	input,
		IOstreamOption	streamOpt = `IOstreamOption()`
	)

static

Create token list by parsing the input character sequence until no good tokens remain.

Definition at line 86 of file ITstream.C.

References Foam::input(), and Foam::parseStream().

Here is the call graph for this function:

◆ name() [1/2]

virtual const fileName& name ( ) const

inlinevirtual

The name of the input token stream.

Reimplemented from IOstream.

Reimplemented in primitiveEntry.

Definition at line 261 of file ITstream.H.

Referenced by primitiveEntry::name(), and primitiveEntry::primitiveEntry().

Here is the caller graph for this function:

◆ name() [2/2]

virtual fileName& name ( )

inlinevirtual

The name of the input token stream, for modification.

Reimplemented in primitiveEntry.

Definition at line 266 of file ITstream.H.

◆ hasPutback()

bool hasPutback ( ) const

inlinenoexcept

True if putback token is in use.

Definition at line 274 of file ITstream.H.

References Istream::hasPutback().

Here is the call graph for this function:

◆ front()

const token& front ( ) const

inline

Failsafe peek at the first token in the list.

Returns: undefinedToken if the list is empty.

Definition at line 284 of file ITstream.H.

Referenced by ITstream::peekFirst().

Here is the caller graph for this function:

◆ back()

const token& back ( ) const

inline

Failsafe peek at the last token in the list.

Returns: undefinedToken if the list is empty.

Definition at line 291 of file ITstream.H.

References UList< T >::size().

Here is the call graph for this function:

◆ peek()

const Foam::token & peek ( ) const

Failsafe peek at what the next read would return, including handling of any putback.

Returns: undefinedToken if list is exhausted

Definition at line 316 of file ITstream.C.

References Istream::hasPutback(), and Istream::peekBack().

Referenced by Constant< Type >::Constant(), Polynomial< Type >::Polynomial(), Foam::readScaling(), and Table< Type >::Table().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tokenIndex() [1/2]

label tokenIndex ( ) const

inlinenoexcept

The current token index when reading, or the insertion point.

Definition at line 304 of file ITstream.H.

◆ tokenIndex() [2/2]

label& tokenIndex ( )

inlinenoexcept

Non-const access to the current token index.

Definition at line 309 of file ITstream.H.

◆ nRemainingTokens()

label nRemainingTokens ( ) const

inlinenoexcept

Number of tokens remaining.

Definition at line 314 of file ITstream.H.

References UList< T >::size().

Referenced by entry::checkITstream(), and dictionary::checkITstream().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ seek()

void seek ( label pos )

Move tokenIndex to the specified position.

Using seek(0) is identical to rewind. Using seek(-1) moves to the end.

Definition at line 328 of file ITstream.C.

References UList< T >::first(), UList< T >::last(), Foam::pos(), and UList< T >::size().

Here is the call graph for this function:

◆ skip()

void skip ( label n = 1 )

Move tokenIndex relative to the current position.

Will not overrun the beginning or end positions.

Use skip(2) to move forward two tokens. Use skip(-2) to move backward two tokens.

Definition at line 375 of file ITstream.C.

References n, and UList< T >::size().

Referenced by Constant< Type >::Constant(), Polynomial< Type >::Polynomial(), and Table< Type >::Table().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ push_back() [1/4]

void push_back	(	const token &	t,
		const bool	lazy
	)

Copy append a token at the current tokenIndex, incrementing the index.

Definition at line 531 of file ITstream.C.

Referenced by ITstream::append().

Here is the caller graph for this function:

◆ push_back() [2/4]

void push_back	(	token &&	t,
		const bool	lazy
	)

Move append a token at the current tokenIndex, incrementing the index.

Definition at line 541 of file ITstream.C.

◆ push_back() [3/4]

void push_back	(	const UList< token > &	newTokens,
		const bool	lazy
	)

Copy append a list of tokens at the current tokenIndex, incrementing the index.

Parameters

newTokens	the list of tokens to copy append
lazy	leaves any excess capacity for further appends. The caller will be responsible for resizing later.

Definition at line 551 of file ITstream.C.

References UList< T >::size().

Here is the call graph for this function:

◆ push_back() [4/4]

void push_back	(	List< token > &&	newTokens,
		const bool	lazy
	)

Move append a list of tokens at the current tokenIndex, incrementing the index.

Parameters

newTokens	the list of tokens to move append
lazy	leaves any excess capacity for further appends. The caller will be responsible for resizing later.

Definition at line 564 of file ITstream.C.

◆ flags() [1/2]

virtual ios_base::fmtflags flags ( ) const

inlinevirtual

Get stream flags - always 0.

Implements IOstream.

Definition at line 380 of file ITstream.H.

◆ flags() [2/2]

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

inlinevirtual

Set flags of stream - ignored.

Implements IOstream.

Definition at line 388 of file ITstream.H.

◆ read() [1/8]

Foam::Istream & read ( token & tok )

virtual

Return next token from stream.

Implements Istream.

Definition at line 417 of file ITstream.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Istream::getBack(), UList< T >::last(), token::lineNumber(), token::reset(), and UList< T >::size().

Here is the call graph for this function:

◆ read() [2/8]

Foam::Istream & read ( char & )

virtual

Read a character.

Implements Istream.

Definition at line 469 of file ITstream.C.

References NotImplemented.

◆ read() [3/8]

Foam::Istream & read ( word & )

virtual

Read a word.

Implements Istream.

Definition at line 476 of file ITstream.C.

References NotImplemented.

◆ read() [4/8]

Foam::Istream & read ( string & )

virtual

Read a string (including enclosing double-quotes)

Implements Istream.

Definition at line 483 of file ITstream.C.

References NotImplemented.

◆ read() [5/8]

Foam::Istream & read ( label & )

virtual

Read a label.

Implements Istream.

Definition at line 490 of file ITstream.C.

References NotImplemented.

◆ read() [6/8]

Foam::Istream & read ( float & )

virtual

Read a float.

Implements Istream.

Definition at line 497 of file ITstream.C.

References NotImplemented.

◆ read() [7/8]

Foam::Istream & read ( double & )

virtual

Read a double.

Implements Istream.

Definition at line 504 of file ITstream.C.

References NotImplemented.

◆ read() [8/8]

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

virtual

Read binary block.

Note: Not implemented

Implements Istream.

Definition at line 518 of file ITstream.C.

References NotImplemented.

◆ readRaw()

Foam::Istream & readRaw	(	char *	data,
		std::streamsize	count
	)

virtual

Low-level raw binary read.

Note: Not implemented

Implements Istream.

Definition at line 511 of file ITstream.C.

References NotImplemented.

◆ beginRawRead()

virtual bool beginRawRead ( )

inlinevirtual

Start of low-level raw binary read.

Implements Istream.

Definition at line 446 of file ITstream.H.

◆ endRawRead()

virtual bool endRawRead ( )

inlinevirtual

End of low-level raw binary read.

Implements Istream.

Definition at line 454 of file ITstream.H.

◆ rewind()

void rewind ( )

virtual

Rewind the stream so that it may be read again.

Implements Istream.

Definition at line 525 of file ITstream.C.

Referenced by Foam::exprTools::getList(), ITstream::ITstream(), simpleObjectRegistry::setNamedValue(), and primitiveEntry::stream().

Here is the caller graph for this function:

◆ print()

void print ( Ostream & os ) const

virtual

Print stream description to Ostream.

Reimplemented from IOstream.

Definition at line 271 of file ITstream.C.

References UList< T >::empty(), UList< T >::first(), UList< T >::last(), os(), and IOstream::print().

Here is the call graph for this function:

◆ toString()

std::string toString ( ) const

Concatenate tokens into a space-separated std::string. The resulting string may contain quote characters.

Definition at line 296 of file ITstream.C.

References StringStreamAllocator< StreamType >::str().

Referenced by expressionEntry::inplaceExpand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [1/3]

void operator= ( const ITstream & is )

Copy assignment, with rewind()

Definition at line 581 of file ITstream.C.

References List< T >::operator=().

Here is the call graph for this function:

◆ operator=() [2/3]

void operator= ( const UList< token > & toks )

Copy assignment of tokens, with rewind()

Definition at line 594 of file ITstream.C.

References List< T >::operator=().

Here is the call graph for this function:

◆ operator=() [3/3]

void operator= ( List< token > && toks )

Move assignment of tokens, with rewind()

Definition at line 601 of file ITstream.C.

References List< T >::operator=().

Here is the call graph for this function:

◆ peekFirst()

const token& peekFirst ( ) const

inline

Same as front()

Definition at line 539 of file ITstream.H.

References ITstream::front().

Here is the call graph for this function:

◆ append() [1/4]

void append	(	const token &	t,
		const bool	lazy
	)

inline

Copy append a token at the current tokenIndex, incrementing the index.

Definition at line 545 of file ITstream.H.

References ITstream::push_back().

Here is the call graph for this function:

◆ append() [2/4]

void append	(	token &&	t,
		const bool	lazy
	)

inline

Move append a token at the current tokenIndex, incrementing the index.

Definition at line 554 of file ITstream.H.

References ITstream::push_back().

Here is the call graph for this function:

◆ append() [3/4]

void append	(	const UList< token > &	newTokens,
		const bool	lazy
	)

inline

Copy append a list of tokens at the current tokenIndex, incrementing the index.

Parameters

newTokens	the list of tokens to copy append
lazy	leaves any excess capacity for further appends. The caller will be responsible for resizing later.

Definition at line 568 of file ITstream.H.

References ITstream::push_back().

Here is the call graph for this function:

◆ append() [4/4]

void append	(	List< token > &&	newTokens,
		const bool	lazy
	)

inline

Move append a list of tokens at the current tokenIndex, incrementing the index.

Parameters

newTokens	the list of tokens to move append
lazy	leaves any excess capacity for further appends. The caller will be responsible for resizing later.

Definition at line 582 of file ITstream.H.

References ITstream::push_back().

Here is the call graph for this function:

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ITstream() [1/11]

◆ ITstream() [2/11]

◆ ITstream() [3/11]

◆ ITstream() [4/11]

◆ ITstream() [5/11]

◆ ITstream() [6/11]

◆ ITstream() [7/11]

◆ ITstream() [8/11]

◆ ITstream() [9/11]

◆ ITstream() [10/11]

◆ ITstream() [11/11]

◆ ~ITstream()

Member Function Documentation

◆ parse() [1/3]

◆ parse() [2/3]

◆ parse() [3/3]

◆ name() [1/2]

◆ name() [2/2]

◆ hasPutback()

◆ front()

◆ back()

◆ peek()

◆ tokenIndex() [1/2]

◆ tokenIndex() [2/2]

◆ nRemainingTokens()

◆ seek()

◆ skip()

◆ push_back() [1/4]

◆ push_back() [2/4]

◆ push_back() [3/4]

◆ push_back() [4/4]

◆ flags() [1/2]

◆ flags() [2/2]

◆ read() [1/8]

◆ read() [2/8]

◆ read() [3/8]

◆ read() [4/8]

◆ read() [5/8]

◆ read() [6/8]

◆ read() [7/8]

◆ read() [8/8]

◆ readRaw()

◆ beginRawRead()

◆ endRawRead()

◆ rewind()

◆ print()

◆ toString()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ peekFirst()

◆ append() [1/4]

◆ append() [2/4]

◆ append() [3/4]

◆ append() [4/4]