namesList< Type > Class Template Reference

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

#include <ccmSolutionTable.H>

Inheritance diagram for namesList< Type >:

Collaboration diagram for namesList< Type >:

Public Types
using	const_iterator = typename SLList<Type>::const_iterator
using	iterator = typename SLList<Type>::iterator
Public Types inherited from LList< SLListBase, T >
typedef T	value_type
	Type of values stored.
typedef T *	pointer
	Pointer for value_type.
typedef const T *	const_pointer
	Const pointer for value_type.
typedef T &	reference
	Reference for value_type.
typedef const T &	const_reference
	Const reference for value_type.
typedef label	size_type
	The type that can represent the container size.
typedef label	difference_type
	The difference between iterators.
using	base_iterator
using	const_base_iterator

Public Member Functions
	namesList ()=default
	Default construct.
bool	found (const word &key) const
	True if a list element has a name that matches key.
iterator	find (const word &key)
	Find list element by name.
List< word >	findNames (const wordRes &allow, const wordRes &deny=wordRes()) const
	Return a list of names in allow-list and not in deny-list.
Public Member Functions inherited from LList< SLListBase, T >
	LList ()=default
	Default construct.
	LList (const T &elem)
	Construct and copy add initial item.
	LList (T &&elem)
	Construct and move add initial item.
	LList (Istream &is)
	Construct from Istream.
	LList (const LList< SLListBase, T > &lst)
	Copy construct.
	LList (LList< SLListBase, T > &&lst)
	Move construct.
	LList (std::initializer_list< T > lst)
	Copy construct from an initializer list.
	~LList ()
	Destructor. Calls clear().
reference	front ()
	The first entry in the list.
const_reference	front () const
	The first entry in the list (const access).
reference	back ()
	The last entry in the list.
const_reference	back () const
	The last entry in the list (const access).
void	push_front (const T &elem)
	Add copy at front of list.
void	push_front (T &&elem)
	Move construct at front of list.
void	push_back (const T &elem)
	Add copy at back of list.
void	push_back (T &&elem)
	Move construct at back of list.
void	clear ()
	Delete contents of list.
void	pop_front (label n=1)
	Remove first element(s) from the list (deletes pointers).
T	removeHead ()
	Remove and return first entry.
T	remove (link *item)
	Remove and return element.
T	remove (iterator &iter)
	Remove and return element specified by iterator.
void	transfer (LList< SLListBase, T > &lst)
	Transfer the contents of the argument into this List and annul the argument list.
void	operator= (const LList< SLListBase, T > &lst)
	Copy assignment.
void	operator= (LList< SLListBase, T > &&lst)
	Move assignment.
void	operator= (std::initializer_list< T > lst)
	Copy assignment from an initializer list.
Istream &	readList (Istream &is)
	Read list from Istream.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write LList with line-breaks when length exceeds shortLen.
iterator	begin ()
	Iterator to first item in list with non-const access.
const_iterator	cbegin () const
	Iterator to first item in list with const access.
reverse_iterator	rbegin ()
	Iterator to last item in list with non-const access.
const_reverse_iterator	crbegin () const
	Iterator to last item in list with const access.
const_iterator	begin () const
	Iterator to first item in list with const access.
const_reverse_iterator	rbegin () const
	Iterator to last item in list with const access.
const iterator &	end ()
	End of list for forward iterators.
const const_iterator &	cend () const
	End of list for forward iterators.
const reverse_iterator &	rend ()
	End of list for reverse iterators.
const const_reverse_iterator &	crend () const
	End of list for reverse iterators.
const const_iterator &	end () const
	End of list for forward iterators.
const const_reverse_iterator &	rend () const
	End of list for reverse iterators.
reference	first ()
	The first entry in the list.
const_reference	first () const
	The first entry in the list (const access).
reference	last ()
	The last entry in the list.
const_reference	last () const
	The last entry in the list (const access).
void	prepend (const T &elem)
	Add copy at front of list.
void	prepend (T &&elem)
	Move construct at front of list.
void	append (const T &elem)
	Add copy at back of list.
void	append (T &&elem)
	Move construct at back of list.
void	insert (const T &elem)
	Add copy at front of list. Same as push_front().
void	insert (T &&elem)
	Move construct at front of list. Same as push_front().
Public Member Functions inherited from SLListBase
	SLListBase ()=default
	Default construct.
	SLListBase (const SLListBase &)=delete
	No copy construct.
void	operator= (const SLListBase &)=delete
	No copy assignment.
	~SLListBase ()=default
	Destructor.
bool	empty () const noexcept
	True if the list is empty.
label	size () const noexcept
	The number of elements in list.
link *	front ()
	Return first entry.
const link *	front () const
	Return const access to first entry.
link *	back ()
	Return last entry.
const link *	back () const
	Return const access to last entry.
void	push_front (link *item)
	Add at front of list.
void	push_back (link *item)
	Add at back of list.
link *	removeHead ()
	Remove and return first entry.
link *	remove (link *item)
link *	remove (iterator &iter)
void	clear ()
	Clear the list.
void	swap (SLListBase &lst)
	Swap the contents of list.
void	transfer (SLListBase &lst)
	Transfer the contents of the argument into this list and annul the argument list.
iterator	begin ()
	Iterator to first item in list with non-const access.
const_iterator	cbegin () const
	Iterator to first item in list with const access.
const_iterator	crbegin () const =delete
	No reverse iteration.
const iterator &	end ()
	End of list for iterators.
const const_iterator &	cend () const
	End of list for iterators.
const const_iterator &	crend () const =delete
	No reverse iteration.
link *	first ()
	Return first entry.
const link *	first () const
	Return const access to first entry.
link *	last ()
	Return last entry.
const link *	last () const
	Return const access to last entry.
void	prepend (link *item)
	Add at front of list.
void	append (link *item)
	Add at back of list.

Additional Inherited Members
Protected Member Functions inherited from SLListBase
template<class IteratorType>
IteratorType	iterator_first () const
	Return iterator to first item or end-iterator if list is empty.
template<class IteratorType>
IteratorType	iterator_last () const
	Return iterator to last item or end-iterator if list is empty.
Static Protected Member Functions inherited from SLListBase
template<class IteratorType>
static const IteratorType &	iterator_end ()
	Factory method to return an iterator end.
template<class IteratorType>
static const IteratorType &	iterator_rend ()=delete
	Factory method to return an iterator rend.

Detailed Description

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

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

Definition at line 56 of file ccmSolutionTable.H.

Member Typedef Documentation

const_iterator

template<class Type>

using const_iterator = typename SLList<Type>::const_iterator

Definition at line 62 of file ccmSolutionTable.H.

iterator

template<class Type>

using iterator = typename SLList<Type>::iterator

Definition at line 63 of file ccmSolutionTable.H.

Constructor & Destructor Documentation

namesList()

template<class Type>

namesList ( )

default

Default construct.

Member Function Documentation

found()

template<class Type>

bool found ( const word & key ) const

inline

True if a list element has a name that matches key.

Definition at line 79 of file ccmSolutionTable.H.

find()

template<class Type>

iterator find ( const word & key )

inline

Find list element by name.

Definition at line 96 of file ccmSolutionTable.H.

findNames()

template<class Type>

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 117 of file ccmSolutionTable.H.

---

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

• src/conversion/ccm/reader/ccmSolutionTable.H