A dictionary directive for including a file, expects a single string to follow. More...

Inheritance diagram for includeEntry:

Collaboration diagram for includeEntry:

Static Public Member Functions
static bool	execute (dictionary &parentDict, Istream &is)
	Include file in a sub-dict context. More...

static bool	execute (const dictionary &parentDict, primitiveEntry &entry, Istream &is)
	Include file in a primitiveEntry context. More...

Static Public Member Functions inherited from functionEntry
static bool	execute (const word &functionName, dictionary &parentDict, Istream &is)
	Execute the functionEntry in a sub-dict context. More...

static bool	execute (const word &functionName, const dictionary &parentDict, primitiveEntry &entry, Istream &is)
	Execute the functionEntry in a primitiveEntry context. More...

Static Public Member Functions inherited from entry
static bool	New (dictionary &parentDict, Istream &is, const inputMode inpMode=inputMode::GLOBAL, const int endChar=0)
	Construct from an Istream and insert into the dictionary. More...

static autoPtr< entry >	New (Istream &is)
	Construct an entry from Istream. More...

static void	resetInputMode ()
	Reset the globalInputMode to merge. More...

Static Public Member Functions inherited from LList< LListBase, T >::link
static T	remove (typename LListBase::link *node)
	Delete linked item and return the element value. More...

static constexpr T *	ptr (typename LListBase::link *node)
	Dereference LListBase::link to obtain address of stored object. More...

static constexpr const T *	ptr (const typename LListBase::link *node)
	Dereference LListBase::link to obtain address of stored object. More...

static constexpr T &	ref (typename LListBase::link *node)
	Dereference LListBase::link to obtain the stored object. More...

static constexpr const T &	ref (const typename LListBase::link *node)
	Dereference LListBase::link to obtain the stored object. More...

Static Public Member Functions inherited from ITstream
static tokenList	parse (const UList< char > &input, IOstreamOption streamOpt=IOstreamOption())

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

static tokenList	parse (const char *input, IOstreamOption streamOpt=IOstreamOption())

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)

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< token >
static const List< token > &	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...

Static Public Attributes
static bool	log
	Report to stdout which file is included. More...

Static Public Attributes inherited from entry
static int	disableFunctionEntries
	Enable or disable use of function entries and variable expansions. More...

static inputMode	globalInputMode = inputMode::MERGE
	The current global input-mode. 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...

Static Protected Member Functions
static fileName	resolveFile (const fileName &dir, const fileName &f, const dictionary &dict)
	Expand include fileName and return. More...

static bool	execute (const bool mandatory, dictionary &parentDict, Istream &is)
	Include file in a sub-dict context. More...

static bool	execute (const bool mandatory, const dictionary &parentDict, primitiveEntry &entry, Istream &is)
	Include file in a primitiveEntry context. More...

Static Protected Member Functions inherited from functionEntry
static token	readLine (const word &key, Istream &is)
	Read line and return as a string token. More...

template<class StringType >
static List< StringType >	readStringList (Istream &is)

static bool	continueReadUntilRightBrace (Istream &is, std::string &str, const bool stripComments=true)
	Slurp a string until a closing '}' is found. More...

Static Protected Member Functions inherited from entry
static void	reportReadWarning (const IOstream &, const std::string &)
	Report a read warning (on std::cerr) More...

Additional Inherited Members
Public Types inherited from entry
enum class	inputMode { MERGE , OVERWRITE , PROTECT , WARN , ERROR , GLOBAL }
	The input mode options. More...

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...

Public Types inherited from List< token >
typedef SubList< token >	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...

Public Member Functions inherited from functionEntry
	functionEntry (const word &key, const dictionary &dict, Istream &is)
	Construct from keyword, parent dictionary and Istream. More...

	declareMemberFunctionSelectionTable (bool, functionEntry, execute, dictionaryIstream,(dictionary &parentDict, Istream &is),(parentDict, is))

	declareMemberFunctionSelectionTable (bool, functionEntry, execute, primitiveEntryIstream,(const dictionary &parentDict, primitiveEntry &entry, Istream &is),(parentDict, entry, is))

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

template<class StringType >
Foam::List< StringType >	readStringList (Istream &is)

Public Member Functions inherited from primitiveEntry
	primitiveEntry (const keyType &key)
	Construct from keyword and no tokens. More...

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

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

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

	primitiveEntry (const keyType &key, const ITstream &is)
	Construct from keyword and ITstream tokens. More...

	primitiveEntry (const keyType &key, Istream &is)
	Construct from keyword and Istream. More...

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

template<class T >
	primitiveEntry (const keyType &key, const T &val)
	Construct from keyword and a value. Uses string stream serialization. More...

autoPtr< entry >	clone (const dictionary &) const
	Clone the entry. More...

virtual const fileName &	name () const
	Return the token stream name. More...

virtual fileName &	name ()
	Return token stream name for modification. More...

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

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

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

virtual bool	isStream () const noexcept
	Return true - this entry is a stream. More...

virtual ITstream &	stream () const
	Return token stream for this primitive entry. More...

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

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

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

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

void	write (Ostream &os, 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 &tok)
	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 *data, std::streamsize)
	Inherit read from ITstream. More...

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

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

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

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

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

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

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

virtual const fileName &	name () const =0
	Return the entry name. More...

virtual fileName &	name ()=0
	Return the entry name for modification. More...

virtual fileName	relativeName () const =0
	Return the entry name relative to the current case. More...

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

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

virtual bool	isStream () const noexcept
	Return true if this entry is a stream. More...

virtual ITstream &	stream () const =0
	Return token stream, if entry is a primitive entry. More...

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

virtual const dictionary *	dictPtr () const noexcept
	Return pointer to dictionary, if entry is a dictionary. More...

virtual dictionary *	dictPtr () noexcept
	Return non-const pointer to dictionary, if entry is a dictionary. More...

virtual const dictionary &	dict () const =0
	Return dictionary, if entry is a dictionary. More...

virtual dictionary &	dict ()=0
	Return non-const access to dictionary, if entry is a dictionary. More...

void	checkITstream (const ITstream &is) const

template<class T >
T	get () const

template<class T >
void	readEntry (T &val) const

template<class T , class Predicate >
T	getCheck (const Predicate &pred) const

template<class T , class Predicate >
void	readCheck (T &val, const Predicate &pred) const

virtual void	write (Ostream &os) const =0
	Write. More...

void	operator= (const entry &e)

bool	operator== (const entry &e) const

bool	operator!= (const entry &e) const

Public Member Functions inherited from LList< LListBase, T >::link
	link (const T &elem)
	Copy construct from given object. More...

	link (T &&elem)
	Move construct from given object. More...

Public Member Functions inherited from ITstream
	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 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...

	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...

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

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

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

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

const token &	peek () const
	Failsafe peek at what the next read would return,. 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...

virtual const fileName &	name () const
	Get the name of the stream. More...

virtual fileName &	name ()
	Return stream name for modification. More...

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

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

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

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

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 (floatScalar &)
	Read a floatScalar. More...

virtual Istream &	read (doubleScalar &)
	Read a doubleScalar. 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

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...

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

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

	Istream (IOstreamOption streamOpt=IOstreamOption())

	Istream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format, version (compression) 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...

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

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

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

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

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

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

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

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

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

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

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

virtual void	rewind ()=0
	Rewind the stream so that it may be read again. 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())

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

virtual const fileName &	name () const
	Return the name of the stream. More...

virtual fileName &	name ()
	Return stream name for modification. 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

template<class T = scalar>
std::enable_if< std::is_floating_point< T >::value, bool >::type	checkScalarSize () const noexcept

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...

virtual ios_base::fmtflags	flags () const =0
	Return flags of stream. 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...

virtual ios_base::fmtflags	flags (const ios_base::fmtflags f)=0
	Set flags of stream. 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...

virtual void	print (Ostream &os) const
	Print stream description to Ostream. 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

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< token >
constexpr	List () noexcept
	Default construct. More...

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

	List (const label len, const token &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 token &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, token &&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< token > &a)
	Copy construct from list. More...

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

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

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

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

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

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

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

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

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

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

	List (DynamicList< token, SizeMin > &&list)
	Move construct from DynamicList. More...

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

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

autoPtr< List< token > >	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 token &val)
	Adjust allocated size of list and set val for new elements. More...

void	resize (const label newLen)

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 token &val)
	Alias for resize() More...

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

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

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

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

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

void	transfer (List< token > &list)

void	transfer (DynamicList< token, SizeMin > &list)

token &	newElmt (const label i)

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

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

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

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

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

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

void	operator= (const token &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< token > &&list)
	Move assignment. Takes constant time. More...

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

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

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

Istream &	readList (Istream &is)

Istream &	readList (Istream &is)

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

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...

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

label	rcIndex (const label i) const noexcept

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 &	first ()
	Return the first element of the list. More...

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

T &	last ()
	Return the last element of the list. More...

const T &	last () const
	Return the last element of the list. More...

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

std::streamsize	byteSize () const

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

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	get (const label i) const

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	unset (const label i)

Istream &	readList (Istream &is)

Ostream &	writeList (Ostream &os, const label) const

const bool &	operator[] (const label i) const

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

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

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

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

Ostream &	writeList (Ostream &os, const label) const

Istream &	readList (Istream &is)

Public Attributes inherited from LList< LListBase, T >::link
T	val_
	Stored object. More...

Protected Member Functions inherited from functionEntry
	functionEntry (const functionEntry &)=delete
	No copy construct. More...

void	operator= (const functionEntry &)=delete
	No copy assignment. 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

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

void	writeEntry (Ostream &os) const

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

A dictionary directive for including a file, expects a single string to follow.

An example of the #include directive to include a file:

    #include "includeFileMustExist"

An example of the #sinclude directive to conditionally include a file when it exists.

    #sinclude "includeFileCanBeMissing"

The usual expansion of environment variables and other expansions (eg, a leading "<case>/", "<system>/", "<etc>/", ...) are retained.

See also: fileName, string::expand(), functionEntries::sincludeEntry

Source files

Definition at line 71 of file includeEntry.H.

Member Function Documentation

◆ resolveFile()

Foam::fileName resolveFile	(	const fileName &	dir,
		const fileName &	f,
		const dictionary &	dict
	)

staticprotected

Expand include fileName and return.

Definition at line 106 of file includeEntry.C.

References primitiveEntry::dict(), f(), Foam::stringOps::inplaceExpand(), and fileName::isAbsolute().

Here is the call graph for this function:

◆ execute() [1/4]

bool execute	(	const bool	mandatory,
		dictionary &	parentDict,
		Istream &	is
	)

staticprotected

Include file in a sub-dict context.

Definition at line 129 of file includeEntry.C.

References regIOobject::addWatch(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::fileHandler(), Foam::Info, IOstream::name(), Foam::nl, fileName::path(), dictionary::read(), dictionary::relativeName(), and dictionary::topDict().

Here is the call graph for this function:

◆ execute() [2/4]

bool execute	(	const bool	mandatory,
		const dictionary &	parentDict,
		primitiveEntry &	entry,
		Istream &	is
	)

staticprotected

Include file in a primitiveEntry context.

Definition at line 180 of file includeEntry.C.

References regIOobject::addWatch(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::fileHandler(), Foam::Info, IOstream::name(), Foam::nl, fileName::path(), dictionary::relativeName(), and dictionary::topDict().

Here is the call graph for this function:

◆ execute() [3/4]

bool execute	(	dictionary &	parentDict,
		Istream &	is
	)

static

Include file in a sub-dict context.

Definition at line 234 of file includeEntry.C.

References ObukhovLength::execute().

Here is the call graph for this function:

◆ execute() [4/4]

bool execute	(	const dictionary &	parentDict,
		primitiveEntry &	entry,
		Istream &	is
	)

static

Include file in a primitiveEntry context.

Definition at line 244 of file includeEntry.C.

References ObukhovLength::execute().

Here is the call graph for this function:

Member Data Documentation

◆ log

bool log

static

Report to stdout which file is included.

Definition at line 110 of file includeEntry.H.

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

src/OpenFOAM/db/dictionary/functionEntries/includeEntry/includeEntry.H
src/OpenFOAM/db/dictionary/functionEntries/includeEntry/includeEntry.C

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ resolveFile()

◆ execute() [1/4]

◆ execute() [2/4]

◆ execute() [3/4]

◆ execute() [4/4]

Member Data Documentation

◆ log