dictionaryContent Class Reference

A wrapper for dictionary content, without operators that could affect inheritance patterns. More...

#include <dictionaryContent.H>

Public Member Functions
	dictionaryContent ()=default
	Default construct.
	dictionaryContent (const dictionaryContent &)=default
	Copy construct.
	dictionaryContent (dictionaryContent &&)=default
	Move construct.
	dictionaryContent (const dictionary &dict)
	Copy construct from dictionary.
	dictionaryContent (dictionary &&dict)
	Move construct from dictionary.
virtual	~dictionaryContent ()=default
	Destructor.
const dictionary &	dict () const noexcept
	Read-access to the content.
void	dict (const dictionary &dict)
	Copy assign new content.
void	dict (dictionary &&dict)
	Move assign new content.
void	operator= (const dictionaryContent &)=delete
	No copy assignment.
void	operator= (dictionaryContent &&)=delete
	No move assignment.

Static Public Member Functions
static dictionary	copyDict (const dictionary &input, const wordList &allow=wordList(), const wordList &deny=wordList())
	Copy construct a dictionary, filtered by simple allow/deny lists.
static dictionary	copyDict (const dictionary &input, const wordRes &allow, const wordRes &deny=wordRes())
	Copy construct a dictionary, filtered by a combination of allow/deny lists.

Detailed Description

A wrapper for dictionary content, without operators that could affect inheritance patterns.

Definition at line 44 of file dictionaryContent.H.

Constructor & Destructor Documentation

dictionaryContent() [1/5]

dictionaryContent ( )

default

Default construct.

Referenced by dictionaryContent(), dictionaryContent(), operator=(), and operator=().

Here is the caller graph for this function:

dictionaryContent() [2/5]

dictionaryContent ( const dictionaryContent & )

default

Copy construct.

References dictionaryContent().

Here is the call graph for this function:

dictionaryContent() [3/5]

dictionaryContent ( dictionaryContent && )

default

Move construct.

References dictionaryContent().

Here is the call graph for this function:

dictionaryContent() [4/5]

dictionaryContent ( const dictionary & dict )

inlineexplicit

Copy construct from dictionary.

Definition at line 75 of file dictionaryContent.H.

References dict().

Here is the call graph for this function:

dictionaryContent() [5/5]

dictionaryContent ( dictionary && dict )

inlineexplicit

Move construct from dictionary.

Definition at line 83 of file dictionaryContent.H.

References dict().

Here is the call graph for this function:

~dictionaryContent()

virtual ~dictionaryContent ( )

virtualdefault

Destructor.

Member Function Documentation

copyDict() [1/2]

Foam::dictionary copyDict ( const dictionary & input, const wordList & allow = wordList(), const wordList & deny = wordList() )

static

Copy construct a dictionary, filtered by simple allow/deny lists.

An empty 'allow' list accepts everything not in the 'deny' list.

Returns

filtered dictionary copy

Definition at line 70 of file dictionaryContent.C.

References Foam::copyFilteredDict(), dictionary, UList< T >::empty(), and UList< T >::found().

Here is the call graph for this function:

copyDict() [2/2]

Foam::dictionary copyDict ( const dictionary & input, const wordRes & allow, const wordRes & deny = wordRes() )

static

Copy construct a dictionary, filtered by a combination of allow/deny lists.

An empty 'allow' list accepts everything not in the 'deny' list. A literal match has higher priority over a regex match.

*    input:  ( abc apple wall wall1 wall2 )
*    allow:  ( abc def "wall.*" )
*    deny:   ( "[ab].*" wall )
* 
*    result: (abc wall1 wall2)
* 

Returns

filtered dictionary copy

Definition at line 105 of file dictionaryContent.C.

References Foam::copyFilteredDict(), dictionary, UList< T >::empty(), wordRe::LITERAL, wordRes::match(), wordRes::matched(), and wordRe::REGEX.

Here is the call graph for this function:

dict() [1/3]

const dictionary & dict ( ) const

inlinenoexcept

Read-access to the content.

Definition at line 142 of file dictionaryContent.H.

References Foam::noexcept.

Referenced by dict(), dict(), dictionaryContent(), and dictionaryContent().

Here is the caller graph for this function:

dict() [2/3]

void dict ( const dictionary & dict )

inline

Copy assign new content.

Definition at line 150 of file dictionaryContent.H.

References dict().

Here is the call graph for this function:

dict() [3/3]

void dict ( dictionary && dict )

inline

Move assign new content.

Definition at line 158 of file dictionaryContent.H.

References dict().

Here is the call graph for this function:

operator=() [1/2]

void operator= ( const dictionaryContent & )

delete

No copy assignment.

References dictionaryContent().

Here is the call graph for this function:

operator=() [2/2]

void operator= ( dictionaryContent && )

delete

No move assignment.

References dictionaryContent().

Here is the call graph for this function:

---

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

• src/OpenFOAM/db/dictionary/dictionaryContent/dictionaryContent.H
• src/OpenFOAM/db/dictionary/dictionaryContent/dictionaryContent.C