A keyword and a list of tokens is a 'primitiveEntry'. An primitiveEntry can be read, written and printed, and the types and values of its tokens analysed. More...

Inheritance diagram for primitiveEntry:

[legend]

Collaboration diagram for primitiveEntry:

[legend]

Public Member Functions
	primitiveEntry (const keyType &, Istream &)
	Construct from keyword and a Istream. More...

	primitiveEntry (const keyType &, const dictionary &parentDict, Istream &)
	Construct from keyword, parent dictionary and Istream. More...

	primitiveEntry (const keyType &, const ITstream &)
	Construct from keyword and a ITstream. More...

	primitiveEntry (const keyType &, const token &)
	Construct from keyword and a single token. More...

	primitiveEntry (const keyType &, const UList< token > &)
	Construct from keyword and a list of tokens. More...

	primitiveEntry (const keyType &, const Xfer< List< token > > &)
	Construct from keyword and by transferring a list of tokens. More...

template<class T >
	primitiveEntry (const keyType &, const T &)
	Construct from keyword and a T. More...

autoPtr< entry >	clone (const dictionary &) const
	Construct on freestore as copy with reference to the. More...

const fileName &	name () const
	Return the dictionary name. More...

fileName &	name ()
	Return the dictionary name. More...

label	startLineNumber () const
	Return line number of first token in dictionary. More...

label	endLineNumber () const
	Return line number of last token in dictionary. More...

bool	isStream () const
	Return true because this entry is a stream. More...

ITstream &	stream () const
	Return token stream if this entry is a primitive entry. More...

const dictionary &	dict () const
	This entry is not a dictionary,. More...

dictionary &	dict ()
	This entry is not a dictionary,. More...

virtual bool	read (const dictionary &, Istream &)
	Read tokens from the given stream. More...

void	write (Ostream &) const
	Write. More...

void	write (Ostream &, const bool contentsOnly) const
	Write, optionally with contents only (no keyword, etc) More...

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

virtual Istream &	read (token &)
	Inherit read from ITstream. More...

virtual Istream &	read (char &)
	Inherit read from ITstream. More...

virtual Istream &	read (word &)
	Inherit read from ITstream. More...

virtual Istream &	read (string &)
	Inherit read from ITstream. More...

virtual Istream &	read (label &)
	Inherit read from ITstream. More...

virtual Istream &	read (floatScalar &)
	Inherit read from ITstream. More...

virtual Istream &	read (doubleScalar &)
	Inherit read from ITstream. More...

virtual Istream &	read (char *, std::streamsize)
	Inherit read from ITstream. More...

Public Member Functions inherited from entry
	entry (const keyType &)
	Construct from keyword. More...

	entry (const entry &)
	Construct as copy. More...

virtual autoPtr< entry >	clone () const
	Construct on freestore as copy. More...

virtual	~entry ()
	Destructor. More...

const keyType &	keyword () const
	Return keyword. More...

keyType &	keyword ()
	Return non-const access to keyword. More...

virtual bool	isDict () const
	Return true if this entry is a dictionary. More...

void	operator= (const entry &)

bool	operator== (const entry &) const

bool	operator!= (const entry &) const

Public Member Functions inherited from ITstream
	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 fileName &	name () const
	Return the name of the stream. More...

fileName &	name ()
	Return non-const access to the name of the stream. More...

label	tokenIndex () const
	Return the current token index. More...

label &	tokenIndex ()
	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 Istream &	read (token &)
	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 &)

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

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

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

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

virtual Istream &	rewind ()
	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...

Istream &	readBegin (const char *funcName)

Istream &	readEnd (const char *funcName)

Istream &	readEndBegin (const char *funcName)

char	readBeginList (const char *funcName)

char	readEndList (const char *funcName)

Istream &	operator() () 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...

label &	lineNumber ()
	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< IOstream >	info () 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...

T &	newElmt (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 Member Functions
void	append (const UList< token > &)
	Append the given tokens starting at the current tokenIndex. More...

void	append (const token &currToken, const dictionary &, Istream &)
	Append the given token to this entry. More...

bool	expandVariable (const string &, const dictionary &)
	Expand the given variable (keyword starts with $) More...

bool	expandFunction (const word &, const dictionary &, Istream &)
	Expand the given function (keyword starts with #) More...

void	readEntry (const dictionary &, Istream &)
	Read the complete entry from the given stream. 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< T >	subList
	Declare type of subList. More...

Static Public Member Functions inherited from entry
static bool	New (dictionary &parentDict, Istream &)
	Construct from Istream and insert into dictionary. More...

static autoPtr< entry >	New (Istream &is)
	Construct on freestore from Istream and return. 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 entry
static int	disableFunctionEntries

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

A keyword and a list of tokens is a 'primitiveEntry'. An primitiveEntry can be read, written and printed, and the types and values of its tokens analysed.

A primitiveEntry is a high-level building block for data description. It is a front-end for the token parser. A list of entries can be used as a set of keyword syntax elements, for example.

Source files

Definition at line 62 of file primitiveEntry.H.

Constructor & Destructor Documentation

◆ primitiveEntry() [1/7]

primitiveEntry	(	const keyType &	key,
		Istream &	is
	)

Construct from keyword and a Istream.

Definition at line 216 of file primitiveEntryIO.C.

References dictionary::null, and primitiveEntry::readEntry().

Referenced by primitiveEntry::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ primitiveEntry() [2/7]

primitiveEntry	(	const keyType &	key,
		const dictionary &	parentDict,
		Istream &	is
	)

Construct from keyword, parent dictionary and Istream.

Definition at line 197 of file primitiveEntryIO.C.

References dict.

◆ primitiveEntry() [3/7]

primitiveEntry	(	const keyType &	key,
		const ITstream &	is
	)

Construct from keyword and a ITstream.

Definition at line 109 of file primitiveEntry.C.

References entry::keyword(), and primitiveEntry::name().

Here is the call graph for this function:

◆ primitiveEntry() [4/7]

primitiveEntry	(	const keyType &	key,
		const token &	t
	)

Construct from keyword and a single token.

Definition at line 118 of file primitiveEntry.C.

◆ primitiveEntry() [5/7]

primitiveEntry	(	const keyType &	key,
		const UList< token > &	tokens
	)

Construct from keyword and a list of tokens.

Definition at line 126 of file primitiveEntry.C.

◆ primitiveEntry() [6/7]

primitiveEntry	(	const keyType &	key,
		const Xfer< List< token > > &	tokens
	)

Construct from keyword and by transferring a list of tokens.

Definition at line 137 of file primitiveEntry.C.

◆ primitiveEntry() [7/7]

primitiveEntry	(	const keyType &	key,
		const T &	t
	)

Construct from keyword and a T.

Definition at line 32 of file primitiveEntryTemplates.C.

References token::END_STATEMENT, dictionary::null, primitiveEntry::readEntry(), and OStringStream::str().

Here is the call graph for this function:

Member Function Documentation

◆ append() [1/2]

void append ( const UList< token > & varTokens )

private

Append the given tokens starting at the current tokenIndex.

Definition at line 33 of file primitiveEntry.C.

References forAll, List::newElmt(), and ITstream::tokenIndex().

Referenced by primitiveEntry::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ append() [2/2]

void append	(	const token &	currToken,
		const dictionary &	dict,
		Istream &	is
	)

private

Append the given token to this entry.

Definition at line 35 of file primitiveEntryIO.C.

References dict, token::isVariable(), token::isWord(), token::stringToken(), w(), and token::wordToken().

Here is the call graph for this function:

◆ expandVariable()

bool expandVariable	(	const string &	w,
		const dictionary &	dict
	)

private

Expand the given variable (keyword starts with $)

Definition at line 43 of file primitiveEntry.C.

References token::BEGIN_BLOCK, dict, entry::dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::getEnv(), Foam::stringOps::inplaceExpand(), entry::isDict(), dictionary::lookupScopedEntryPtr(), s(), entry::stream(), dictionary::toc(), dictionary::tokens(), and w().

Here is the call graph for this function:

◆ expandFunction()

bool expandFunction	(	const word &	keyword,
		const dictionary &	parentDict,
		Istream &	is
	)

private

Expand the given function (keyword starts with #)

Definition at line 84 of file primitiveEntryIO.C.

◆ readEntry()

void readEntry	(	const dictionary &	dict,
		Istream &	is
	)

private

Read the complete entry from the given stream.

Definition at line 167 of file primitiveEntryIO.C.

References dict, IOstream::lineNumber(), Foam::read(), SafeFatalIOErrorInFunction, and setSize().

Referenced by primitiveEntry::primitiveEntry().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clone()

autoPtr<entry> clone ( const dictionary & parentDict ) const

inlinevirtual

Construct on freestore as copy with reference to the.

dictionary the copy belongs to

Implements entry.

Definition at line 121 of file primitiveEntry.H.

References primitiveEntry::primitiveEntry().

Here is the call graph for this function:

◆ name() [1/2]

const fileName& name ( ) const

inlinevirtual

Return the dictionary name.

Implements entry.

Definition at line 133 of file primitiveEntry.H.

References ITstream::name().

Referenced by primitiveEntry::primitiveEntry().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ name() [2/2]

fileName& name ( )

inlinevirtual

Return the dictionary name.

Implements entry.

Definition at line 139 of file primitiveEntry.H.

References ITstream::name().

Here is the call graph for this function:

◆ startLineNumber()

Foam::label startLineNumber ( ) const

virtual

Return line number of first token in dictionary.

Implements entry.

Definition at line 149 of file primitiveEntry.C.

◆ endLineNumber()

Foam::label endLineNumber ( ) const

virtual

Return line number of last token in dictionary.

Implements entry.

Definition at line 164 of file primitiveEntry.C.

◆ isStream()

bool isStream ( ) const

inlinevirtual

Return true because this entry is a stream.

Reimplemented from entry.

Definition at line 151 of file primitiveEntry.H.

◆ stream()

Foam::ITstream & stream ( ) const

virtual

Return token stream if this entry is a primitive entry.

Implements entry.

Definition at line 179 of file primitiveEntry.C.

References ITstream::rewind().

Here is the call graph for this function:

◆ dict() [1/2]

Foam::dictionary & dict ( ) const

virtual

This entry is not a dictionary,.

calling this function generates a FatalError

Implements entry.

Definition at line 187 of file primitiveEntry.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and dictionary::null.

Referenced by primitiveEntry::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dict() [2/2]

dictionary& dict ( )

virtual

This entry is not a dictionary,.

calling this function generates a FatalError

Implements entry.

◆ read() [1/9]

bool read	(	const dictionary &	dict,
		Istream &	is
	)

virtual

Read tokens from the given stream.

Definition at line 95 of file primitiveEntryIO.C.

References primitiveEntry::append(), IOstream::bad(), token::BEGIN_BLOCK, token::BEGIN_LIST, primitiveEntry::dict(), token::END_BLOCK, token::END_LIST, token::END_STATEMENT, IOstream::fatalCheck(), token::good(), and Istream::read().

Referenced by calcEntry::execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write() [1/2]

void write ( Ostream & os ) const

virtual

Write.

Implements entry.

Definition at line 267 of file primitiveEntryIO.C.

References write().

Here is the call graph for this function:

◆ write() [2/2]

void write	(	Ostream &	os,
		const bool	contentsOnly
	)		const

Write, optionally with contents only (no keyword, etc)

Definition at line 233 of file primitiveEntryIO.C.

References token::END_STATEMENT, Foam::endl(), token::SPACE, token::type(), token::VERBATIMSTRING, Ostream::write(), and Ostream::writeKeyword().

Here is the call graph for this function:

◆ info()

InfoProxy<primitiveEntry> info ( ) const

inline

Return info proxy.

Used to print token information to a stream

Definition at line 178 of file primitiveEntry.H.

◆ read() [2/9]

Foam::Istream & read

Inherit read from ITstream.

Definition at line 56 of file ITstream.C.

◆ read() [3/9]

Foam::Istream & read

Inherit read from ITstream.

Definition at line 108 of file ITstream.C.

◆ read() [4/9]

Foam::Istream & read

Inherit read from ITstream.

Definition at line 115 of file ITstream.C.

◆ read() [5/9]

Foam::Istream & read

Inherit read from ITstream.

Definition at line 122 of file ITstream.C.

◆ read() [6/9]

Foam::Istream & read

Inherit read from ITstream.

Definition at line 129 of file ITstream.C.

◆ read() [7/9]

Foam::Istream & read

Inherit read from ITstream.

Definition at line 136 of file ITstream.C.

◆ read() [8/9]

Foam::Istream & read

Inherit read from ITstream.

Definition at line 143 of file ITstream.C.

◆ read() [9/9]

Foam::Istream & read

Inherit read from ITstream.

Definition at line 150 of file ITstream.C.

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

src/OpenFOAM/db/dictionary/primitiveEntry/primitiveEntry.H
src/OpenFOAM/db/dictionary/primitiveEntry/primitiveEntry.C
src/OpenFOAM/db/dictionary/primitiveEntry/primitiveEntryIO.C
src/OpenFOAM/db/dictionary/primitiveEntry/primitiveEntryTemplates.C

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ primitiveEntry() [1/7]

◆ primitiveEntry() [2/7]

◆ primitiveEntry() [3/7]

◆ primitiveEntry() [4/7]

◆ primitiveEntry() [5/7]

◆ primitiveEntry() [6/7]

◆ primitiveEntry() [7/7]

Member Function Documentation

◆ append() [1/2]

◆ append() [2/2]

◆ expandVariable()

◆ expandFunction()

◆ readEntry()

◆ clone()

◆ name() [1/2]

◆ name() [2/2]

◆ startLineNumber()

◆ endLineNumber()

◆ isStream()

◆ stream()

◆ dict() [1/2]

◆ dict() [2/2]

◆ read() [1/9]

◆ write() [1/2]

◆ write() [2/2]

◆ info()

◆ read() [2/9]

◆ read() [3/9]

◆ read() [4/9]

◆ read() [5/9]

◆ read() [6/9]

◆ read() [7/9]

◆ read() [8/9]

◆ read() [9/9]