PtrListDetail< T > Class Template Reference

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
 Construct null. More...
 
 PtrListDetail (const label len)
 Construct with specified size, each element initialized to nullptr. 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 free ()
 Delete the allocated entries, but retain the list size. More...
 
template<class... Args>
PtrListDetail< Tclone (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)
 Override size to be inconsistent with allocated storage. More...
 
Ostreamwrite (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
 
template<class... Args>
Foam::Detail::PtrListDetail< Tclone (Args &&... args) const
 
- Public Member Functions inherited from List< T * >
constexpr List () noexcept
 Null constructor. 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 zero)
 Construct with given size initializing all elements to zero. More...
 
 List (const one, const T * &val)
 Construct with length=1, copying the value as the only content. More...
 
 List (const one, T * &&val)
 Construct with length=1, moving the value as the only content. More...
 
 List (const one, const 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 (InputIterator begIter, InputIterator endIter)
 Construct given begin/end iterators. 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 resize (const label newSize)
 Adjust allocated size of list. More...
 
void resize (const label newSize, const T * &val)
 Adjust allocated size of list and set val for new elements. More...
 
void resize (const label newSize)
 
void setSize (const label newSize)
 Alias for resize(const label) More...
 
void setSize (const label newSize, const T * &val)
 Alias for resize(const label, const T&) More...
 
void clear ()
 Clear the list, i.e. set size to zero. 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...
 
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 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...
 
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.

Source files

Definition at line 61 of file PtrListDetail.H.

Constructor & Destructor Documentation

◆ PtrListDetail() [1/5]

constexpr PtrListDetail ( )
inlineconstexprnoexcept

Construct null.

Definition at line 31 of file PtrListDetailI.H.

◆ PtrListDetail() [2/5]

PtrListDetail ( const label  len)
inline

Construct with specified size, each element initialized to nullptr.

Definition at line 38 of file PtrListDetailI.H.

◆ PtrListDetail() [3/5]

PtrListDetail ( const PtrListDetail< T > &  list)
inline

Copy construct (shallow copies addresses)

Definition at line 46 of file PtrListDetailI.H.

◆ PtrListDetail() [4/5]

PtrListDetail ( PtrListDetail< T > &&  list)
inline

Move construct.

Definition at line 56 of file PtrListDetailI.H.

◆ PtrListDetail() [5/5]

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

Copy or move (reuse) construct as specified.

Definition at line 66 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< Foam::diameterModels::velocityGroup >::reorder(), and UPtrList< Foam::diameterModels::velocityGroup >::sortOrder().

Here is the caller graph for this function:

◆ free()

void free ( )

Delete the allocated entries, but retain the list size.

Definition at line 70 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< Foam::diameterModels::velocityGroup >::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 85 of file PtrListDetailI.H.

◆ setAddressableSize()

void setAddressableSize ( const label  n)
inline

Override size to be inconsistent with allocated storage.

Use with care

Definition at line 78 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 103 of file PtrListDetailI.H.

◆ operator=() [2/2]

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

Move assignment.

Definition at line 113 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

◆ clone() [2/2]

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

Definition at line 92 of file PtrListDetail.C.


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