DLListBase::link Struct Reference

The structure for a doubly-linked storage node. More...

#include <DLListBase.H>

Inheritance diagram for DLListBase::link:

Collaboration diagram for DLListBase::link:

Public Member Functions
	link () noexcept=default
	Default construct.
bool	registered () const noexcept
	Node registered (linked) in a list?
void	deregister () noexcept
	Deregister the node (after removal).

Public Attributes
link *	prev_ = nullptr
	Pointer to prev entry in list.
link *	next_ = nullptr
	Pointer to next entry in list.

Detailed Description

The structure for a doubly-linked storage node.

Definition at line 64 of file DLListBase.H.

Constructor & Destructor Documentation

link()

link ( )

defaultnoexcept

Default construct.

References Foam::noexcept.

Referenced by entry::entry(), and entry::entry().

Here is the caller graph for this function:

Member Function Documentation

registered()

bool registered ( ) const

inlinenoexcept

Node registered (linked) in a list?

Definition at line 84 of file DLListBase.H.

References next_, Foam::noexcept, prev_, and registered().

Referenced by registered().

Here is the call graph for this function:

Here is the caller graph for this function:

deregister()

void deregister ( )

inlinenoexcept

Deregister the node (after removal).

Definition at line 89 of file DLListBase.H.

References next_, Foam::noexcept, and prev_.

Referenced by DLListBase::remove(), DLListBase::removeHead(), and DLListBase::replace().

Here is the caller graph for this function:

Member Data Documentation

prev_

link* prev_ = nullptr

Pointer to prev entry in list.

Definition at line 69 of file DLListBase.H.

Referenced by deregister(), DLListBase::push_back(), DLListBase::push_front(), registered(), DLListBase::remove(), DLListBase::replace(), DLListBase::swapDown(), and DLListBase::swapUp().

next_

link* next_ = nullptr

Pointer to next entry in list.

Definition at line 74 of file DLListBase.H.

Referenced by deregister(), DLListBase::push_back(), DLListBase::push_front(), registered(), DLListBase::remove(), DLListBase::removeHead(), DLListBase::replace(), DLListBase::swapDown(), and DLListBase::swapUp().

---

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

• src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBase.H