Kicking it Olde Sküül! Burgerlib on Github Follow Olde Sküül on Twitter Burgerbecky on LinkedIn Burgerbecky on LinkedIn
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Burger::ForwardLink Class Reference

Singly linked list pointer. More...

Collaboration diagram for Burger::ForwardLink:
Collaboration graph
[legend]

Public Member Functions

 ForwardLink () noexcept
 Constructor with nullptr.
 
 ForwardLink (ForwardLink *pNext) noexcept
 Constructor with a supplied next pointer.
 
void clear (void) noexcept
 Set the pointer to nullptr.
 
ForwardLinkget_next (void) const noexcept
 Get the pointer to the next entry in the linked list.
 
void set_next (ForwardLink *pNext) noexcept
 Set the pointer to pNext.
 

Private Member Functions

 ForwardLink (const ForwardLink &)=delete
 
ForwardLinkoperator= (const ForwardLink &)=delete
 
 ForwardLink (ForwardLink &&)=delete
 
ForwardLinkoperator= (ForwardLink &&)=delete
 

Private Attributes

ForwardLinkm_pNext
 Pointer to the next object in the singly linked list.
 

Detailed Description

Singly linked list pointer.


For classes that maintain singly linked lists, this class holds a single pointer to the next entry in the list or nullptr to denote the end of the list. For classes that work with circular lists, there will be no nullptr to the last entry

See also
LastInFirstOut or MPLastInFirstOut

Constructor & Destructor Documentation

◆ ForwardLink() [1/4]

Burger::ForwardLink::ForwardLink ( const ForwardLink & )
privatedelete

◆ ForwardLink() [2/4]

Burger::ForwardLink::ForwardLink ( ForwardLink && )
privatedelete

◆ ForwardLink() [3/4]

Burger::ForwardLink::ForwardLink ( )
inlinenoexcept

Constructor with nullptr.


Default constructor that sets the next pointer to nullptr

See also
ForwardLink(ForwardLink*)

◆ ForwardLink() [4/4]

Burger::ForwardLink::ForwardLink ( ForwardLink * pNext)
inlinenoexcept

Constructor with a supplied next pointer.


Default constructor that sets the next pointer to pNext

Parameters
pNextPointer to the ForwardLink that follows this class instance in the linked list
See also
ForwardLink()

Member Function Documentation

◆ clear()

void Burger::ForwardLink::clear ( void )
inlinenoexcept

Set the pointer to nullptr.


See also
set_next(ForwardLink *)

◆ get_next()

void Burger::ForwardLink::get_next ( void ) const
inlinenoexcept

Get the pointer to the next entry in the linked list.


Returns
Pointer to the next entry in the linked list
See also
set_next(ForwardLink *)

◆ operator=() [1/2]

ForwardLink & Burger::ForwardLink::operator= ( const ForwardLink & )
privatedelete

◆ operator=() [2/2]

ForwardLink & Burger::ForwardLink::operator= ( ForwardLink && )
privatedelete

◆ set_next()

void Burger::ForwardLink::set_next ( ForwardLink * pNext)
inlinenoexcept

Set the pointer to pNext.


Parameters
pNextPointer to the ForwardLink that follows this class instance in the linked list
See also
get_next(void) const or clear(void)

Member Data Documentation

◆ m_pNext

ForwardLink* Burger::ForwardLink::m_pNext
private

Pointer to the next object in the singly linked list.