namesList< T > Class Template Reference

A linked-list that is searchable by the 'name()' of the items. More...

Inheritance diagram for namesList< T >:
[legend]
Collaboration diagram for namesList< T >:
[legend]

Public Types

using const_iterator = typename SLList< T >::const_iterator
 
using iterator = typename SLList< T >::iterator
 
- Public Types inherited from LList< LListBase, T >
typedef T value_type
 Type of values stored. More...
 
typedef Tpointer
 Pointer for value_type. More...
 
typedef const Tconst_pointer
 Const pointer for value_type. More...
 
typedef Treference
 Reference for value_type. More...
 
typedef const Tconst_reference
 Const reference for value_type. More...
 
typedef label size_type
 The type that can represent the container size. More...
 
typedef label difference_type
 The difference between iterators. More...
 
using base_iterator = typename LListBase::iterator
 
using const_base_iterator = typename LListBase::const_iterator
 

Public Member Functions

 namesList ()=default
 Default construct. More...
 
bool found (const word &key) const
 Return true if a list element has a name that matches key. More...
 
iterator find (const word &key)
 Find a list element has a name matching key. More...
 
List< wordfindNames (const wordRes &allow, const wordRes &deny=wordRes()) const
 Return a list of names in allow-list and not in deny-list. More...
 
- Public Member Functions inherited from LList< LListBase, T >
 LList ()=default
 Default construct. More...
 
 LList (const T &elem)
 Construct and copy add initial item. More...
 
 LList (T &&elem)
 Construct and move add initial item. More...
 
 LList (Istream &is)
 Construct from Istream. More...
 
 LList (const LList< LListBase, T > &lst)
 Copy construct. More...
 
 LList (LList< LListBase, T > &&lst)
 Move construct. More...
 
 LList (std::initializer_list< T > lst)
 Copy construct from an initializer list. More...
 
 ~LList ()
 Destructor. More...
 
reference first ()
 The first entry in the list. More...
 
const_reference first () const
 The first entry in the list (const access) More...
 
reference last ()
 The last entry in the list. More...
 
const_reference last () const
 The last entry in the list (const access) More...
 
void prepend (const T &elem)
 Add copy at front of list. More...
 
void prepend (T &&elem)
 Move construct at front of list. More...
 
void append (const T &elem)
 Add copy at back of list. More...
 
void append (T &&elem)
 Move construct at back of list. More...
 
bool eraseHead ()
 Erase the first entry. More...
 
T removeHead ()
 Remove and return first entry. More...
 
T remove (link *item)
 Remove and return element. More...
 
T remove (iterator &iter)
 Remove and return element specified by iterator. More...
 
void clear ()
 Delete contents of list. More...
 
void transfer (LList< LListBase, T > &lst)
 
void operator= (const LList< LListBase, T > &lst)
 Copy assignment. More...
 
void operator= (LList< LListBase, T > &&lst)
 Move assignment. More...
 
void operator= (std::initializer_list< T > lst)
 Copy assignment from an initializer list. More...
 
IstreamreadList (Istream &is)
 Read list from Istream. More...
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write LList with line-breaks when length exceeds shortLen. More...
 
iterator begin ()
 Iterator to first item in list with non-const access. More...
 
const_iterator cbegin () const
 Iterator to first item in list with const access. More...
 
reverse_iterator rbegin ()
 Iterator to last item in list with non-const access. More...
 
const_reverse_iterator crbegin () const
 Iterator to last item in list with const access. More...
 
const_iterator begin () const
 Iterator to first item in list with const access. More...
 
const_reverse_iterator rbegin () const
 Iterator to last item in list with const access. More...
 
const iteratorend ()
 End of list for forward iterators. More...
 
const const_iteratorcend () const
 End of list for forward iterators. More...
 
const reverse_iteratorrend ()
 End of list for reverse iterators. More...
 
const const_reverse_iteratorcrend () const
 End of list for reverse iterators. More...
 
const const_iteratorend () const
 End of list for forward iterators. More...
 
const const_reverse_iteratorrend () const
 End of list for reverse iterators. More...
 
void insert (const T &elem)
 Add copy at front of list. Same as prepend() More...
 
void insert (T &&elem)
 Move construct at front of list. Same as prepend() More...
 

Detailed Description

template<class T>
class Foam::ccm::namesList< T >

A linked-list that is searchable by the 'name()' of the items.

Definition at line 59 of file ccmSolutionTable.H.

Member Typedef Documentation

◆ const_iterator

using const_iterator = typename SLList<T>::const_iterator

Definition at line 64 of file ccmSolutionTable.H.

◆ iterator

using iterator = typename SLList<T>::iterator

Definition at line 65 of file ccmSolutionTable.H.

Constructor & Destructor Documentation

◆ namesList()

namesList ( )
default

Default construct.

Member Function Documentation

◆ found()

bool found ( const word key) const
inline

Return true if a list element has a name that matches key.

Definition at line 76 of file ccmSolutionTable.H.

References forAllConstIters, and Foam::name().

Here is the call graph for this function:

◆ find()

iterator find ( const word key)
inline

Find a list element has a name matching key.

Definition at line 91 of file ccmSolutionTable.H.

References LList< LListBase, T >::end(), forAllIters, and Foam::name().

Referenced by face::which().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ findNames()

List< word > findNames ( const wordRes allow,
const wordRes deny = wordRes() 
) const
inline

Return a list of names in allow-list and not in deny-list.

Definition at line 106 of file ccmSolutionTable.H.

References forAllConstIters, wordRes::match(), Foam::name(), and List< T >::resize().

Here is the call graph for this function:

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