Public Member Functions | Static Public Member Functions | List of all members
dictionaryContent Class Reference

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

Public Member Functions

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

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

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.

◆ dictionaryContent() [2/5]

dictionaryContent ( const dictionaryContent &  )
default

Copy construct.

◆ dictionaryContent() [3/5]

dictionaryContent ( dictionaryContent &&  )
default

Move construct.

◆ dictionaryContent() [4/5]

dictionaryContent ( const dictionary &  dict)
inlineexplicit

Copy construct from dictionary.

Definition at line 75 of file dictionaryContent.H.

◆ dictionaryContent() [5/5]

dictionaryContent ( dictionary &&  dict)
inlineexplicit

Move construct from dictionary.

Definition at line 83 of file dictionaryContent.H.

◆ ~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 71 of file dictionaryContent.C.

References Foam::copyFilteredDict(), UList< T >::empty(), UList< T >::found(), Foam::input(), and Foam::glTF::key().

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 106 of file dictionaryContent.C.

References Foam::copyFilteredDict(), UList< T >::empty(), Foam::input(), Foam::glTF::key(), wordRes::match(), and wordRes::matched().

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.

Referenced by dictionaryContent::dict(), codedFunctionObject::redirectFunctionObject(), codedFixedValueFvPatchField< Type >::redirectPatchField(), codedFixedValuePointPatchField< Type >::redirectPatchField(), and codedMixedFvPatchField< Type >::redirectPatchField().

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 dictionaryContent::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 dictionaryContent::dict().

Here is the call graph for this function:

◆ operator=() [1/2]

void operator= ( const dictionaryContent &  )
delete

No copy assignment.

◆ operator=() [2/2]

void operator= ( dictionaryContent &&  )
delete

No move assignment.

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