A rudimentary list of pointers used for PtrList, UPtrList, etc. This class is considered implementation detail and should not normally be used other than by OpenFOAM container classes. More...

Inheritance diagram for PtrListDetail< T >:

[legend]

Collaboration diagram for PtrListDetail< T >:

[legend]

Public Member Functions
constexpr	PtrListDetail () noexcept
	Default construct. More...

	PtrListDetail (const label len)
	Construct with specified size, each element initialized to nullptr. More...

	PtrListDetail (const UList< T * > &list)
	Copy a list of pointers. More...

	PtrListDetail (const PtrListDetail< T > &list)
	Copy construct (shallow copies addresses) More...

	PtrListDetail (PtrListDetail< T > &&list)
	Move construct. More...

	PtrListDetail (PtrListDetail< T > &list, bool reuse)
	Copy or move (reuse) construct as specified. More...

label	count () const
	Return the count of non-nullptr entries. More...

label	findNull () const
	Locate the first null entry, -1 if there are not any. More...

void	setNull ()
	Assign all pointers to nullptr, without deleting. More...

void	free ()
	Delete the allocated entries, but retain the list size. More...

template<class... Args>
PtrListDetail< T >	clone (Args &&... args) const
	Make a copy by cloning each of the list pointers. More...

void	resize (const label newLen)
	Reset size of list. More...

void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage. More...

Ostream &	write (Ostream &os, const bool trimNull=false) const
	Write output, optionally silently trimming nullptrs. More...

void	operator= (const PtrListDetail< T > &list)
	Copy assignment (shallow copies addresses) More...

void	operator= (PtrListDetail< T > &&list)
	Move assignment. More...

void	setSize (const label)=delete

void	setSize (const label, const T &)=delete

void	setSize (const label, const T *)=delete

void	resize_nocopy (const label)=delete

template<class... Args>
Foam::Detail::PtrListDetail< T >	clone (Args &&... args) const

Public Member Functions inherited from List< T * >
constexpr	List () noexcept
	Default construct. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	List (SortableList< T * > &&list)
	Move construct from SortableList. More...

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

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

autoPtr< List< T * > >	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 T * &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 T * &val)
	Alias for resize() More...

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

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

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

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

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

void	transfer (List< T * > &list)

void	transfer (DynamicList< T *, SizeMin > &list)

void	transfer (SortableList< T * > &list)

T * &	newElmt (const label i)

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

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

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

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

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

void	operator= (std::initializer_list< T * > list)
	Assignment to an initializer list. 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...

void	operator= (List< T * > &&list)
	Move assignment. Takes constant time. More...

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

void	operator= (SortableList< T * > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< T * > &&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< T * > &)=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...

Additional Inherited Members
Public Types inherited from List< T * >
typedef SubList< T * >	subList
	Declare type of subList. More...

Static Public Member Functions inherited from List< T * >
static const List< T * > &	null ()
	Return a null List. More...

Detailed Description

template<class T>
class Foam::Detail::PtrListDetail< T >

A rudimentary list of pointers used for PtrList, UPtrList, etc. This class is considered implementation detail and should not normally be used other than by OpenFOAM container classes.

It stores a list of pointers, but makes leaves memory management to the caller or sub-class. The free() method can be used explicitly as required.

Source files

Definition at line 61 of file PtrListDetail.H.

Constructor & Destructor Documentation

◆ PtrListDetail() [1/6]

constexpr PtrListDetail ( )

inlineconstexprnoexcept

Default construct.

Definition at line 31 of file PtrListDetailI.H.

◆ PtrListDetail() [2/6]

PtrListDetail ( const label len )

inlineexplicit

Construct with specified size, each element initialized to nullptr.

Definition at line 38 of file PtrListDetailI.H.

◆ PtrListDetail() [3/6]

PtrListDetail ( const UList< T * > & list )

inlineexplicit

Copy a list of pointers.

The caller is responsible for memory management.

Definition at line 46 of file PtrListDetailI.H.

◆ PtrListDetail() [4/6]

PtrListDetail ( const PtrListDetail< T > & list )

inline

Copy construct (shallow copies addresses)

Definition at line 56 of file PtrListDetailI.H.

◆ PtrListDetail() [5/6]

PtrListDetail ( PtrListDetail< T > && list )

inline

Move construct.

Definition at line 66 of file PtrListDetailI.H.

◆ PtrListDetail() [6/6]

PtrListDetail	(	PtrListDetail< T > &	list,
		bool	reuse
	)

inline

Copy or move (reuse) construct as specified.

Definition at line 76 of file PtrListDetailI.H.

Member Function Documentation

◆ count()

Foam::label count ( ) const

Return the count of non-nullptr entries.

Definition at line 34 of file PtrListDetail.C.

◆ findNull()

Foam::label findNull ( ) const

Locate the first null entry, -1 if there are not any.

Definition at line 51 of file PtrListDetail.C.

Referenced by UPtrList< const Foam::UList >::reorder(), and UPtrList< const Foam::UList >::sortOrder().

Here is the caller graph for this function:

◆ setNull()

void setNull ( )

Assign all pointers to nullptr, without deleting.

Definition at line 70 of file PtrListDetail.C.

◆ free()

void free ( )

Delete the allocated entries, but retain the list size.

Definition at line 83 of file PtrListDetail.C.

◆ clone() [1/2]

PtrListDetail<T> clone ( Args &&... args ) const

Make a copy by cloning each of the list pointers.

Referenced by PtrListDetail< const Foam::UList >::clone().

Here is the caller graph for this function:

◆ resize()

void resize ( const label newLen )

inline

Reset size of list.

New entries are initialized to nullptr.

Definition at line 98 of file PtrListDetailI.H.

◆ setAddressableSize()

void setAddressableSize ( const label n )

inlinenoexcept

Set addressed size to be inconsistent with allocated storage.

Use with care

Definition at line 89 of file PtrListDetailI.H.

◆ write()

Foam::Ostream & write	(	Ostream &	os,
		const bool	trimNull = `false`
	)		const

Write output, optionally silently trimming nullptrs.

Definition at line 36 of file PtrListDetailIO.C.

◆ operator=() [1/2]

void operator= ( const PtrListDetail< T > & list )

inline

Copy assignment (shallow copies addresses)

Definition at line 116 of file PtrListDetailI.H.

◆ operator=() [2/2]

void operator= ( PtrListDetail< T > && list )

inline

Move assignment.

Definition at line 126 of file PtrListDetailI.H.

◆ setSize() [1/3]

void setSize ( const label )

delete

◆ setSize() [2/3]

void setSize	(	const	label,
		const T &
	)

delete

◆ setSize() [3/3]

void setSize	(	const	label,
		const T *
	)

delete

◆ resize_nocopy()

void resize_nocopy ( const label )

delete

◆ clone() [2/2]

Foam::Detail::PtrListDetail<T> clone ( Args &&... args ) const

Definition at line 105 of file PtrListDetail.C.

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

src/OpenFOAM/containers/PtrLists/PtrListDetail/PtrListDetail.H
src/OpenFOAM/containers/PtrLists/PtrListDetail/PtrListDetail.C
src/OpenFOAM/containers/PtrLists/PtrListDetail/PtrListDetailI.H
src/OpenFOAM/containers/PtrLists/PtrListDetail/PtrListDetailIO.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class T> class Foam::Detail::PtrListDetail< T >

Constructor & Destructor Documentation

◆ PtrListDetail() [1/6]

◆ PtrListDetail() [2/6]

◆ PtrListDetail() [3/6]

◆ PtrListDetail() [4/6]

◆ PtrListDetail() [5/6]

◆ PtrListDetail() [6/6]

Member Function Documentation

◆ count()

◆ findNull()

◆ setNull()

◆ free()

◆ clone() [1/2]

◆ resize()

◆ setAddressableSize()

◆ write()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setSize() [1/3]

◆ setSize() [2/3]

◆ setSize() [3/3]

◆ resize_nocopy()

◆ clone() [2/2]

template<class T>
class Foam::Detail::PtrListDetail< T >