micro_os_plus::utils::double_list_links Class Reference

A class for the core of a doubly linked list (pointers to neighbours). More...

#include <micro-os-plus/utils/lists.h>

Inheritance diagram for micro_os_plus::utils::double_list_links:

Public Types
using	is_statically_allocated = std::false_type
	Type indicating that the links node is not statically allocated.

Public Member Functions
constexpr	double_list_links ()
	Construct a list node (initialise the pointers).
constexpr	~double_list_links ()
	Destruct the node.
constexpr void	initialize (void)
	Initialise the node links.
void	initialize_once (void)
	Initialize the list only at first run.
void	link_next (double_list_links_base *node)
	Link the new node as next.
void	link_previous (double_list_links_base *node)
	Link the new node as previous.
bool	linked (void) const
	Check if the node is linked to a double list.
constexpr double_list_links_base *	next (void) const
	Get the link to the next node.
constexpr double_list_links_base *	previous (void) const
	Get the link to the previous node.
bool	uninitialized (void) const
	Check if the node is uninitialised.
void	unlink (void)
	Remove this node from the list.

Protected Attributes
double_list_links_base *	next_
	Pointer to the next node.
double_list_links_base *	previous_
	Pointer to the previous node.

Detailed Description

A class for the core of a doubly linked list (pointers to neighbours).

The pair of pointers to the next and previous list elements and the methods to access the pointers are inherited from the base class.

The constructor initialises the pointers to an empty list (both pointers point to the node).

Definition at line 229 of file lists.h.

Member Typedef Documentation

is_statically_allocated

using micro_os_plus::utils::double_list_links::is_statically_allocated = std::false_type

Type indicating that the links node is not statically allocated.

Definition at line 236 of file lists.h.

Constructor & Destructor Documentation

double_list_links()

micro_os_plus::utils::double_list_links::double_list_links ( )

constexpr

Construct a list node (initialise the pointers).

Definition at line 150 of file inlines.h.

~double_list_links()

micro_os_plus::utils::double_list_links::~double_list_links ( )

constexpr

Destruct the node.

Definition at line 157 of file inlines.h.

Member Function Documentation

initialize()

void micro_os_plus::utils::double_list_links_base::initialize ( void )

constexprinherited

Initialise the node links.

Parameters

None.

Returns

Nothing.

Set both pointers to point to this node.

This is the definition of an unlinked node.

Note

After unlinking the node from a list, it must be returned to this state.

Definition at line 78 of file inlines.h.

initialize_once()

void micro_os_plus::utils::double_list_links_base::initialize_once ( void )

inherited

Initialize the list only at first run.

Parameters

None.

Returns

Nothing.

If the statically allocated list is still in the initial uninitialised state (with both pointers nullptr), initialise the list to the empty state, with both pointers pointing to itself.

For non-statically initialised lists, this method is ineffective, since the node is always initialised at construct time.

Note

This method must be manually called for statically allocated list before inserting elements, or performing any other operations.

Definition at line 72 of file lists.cpp.

link_next()

void micro_os_plus::utils::double_list_links_base::link_next ( double_list_links_base * node )

inherited

Link the new node as next.

Parameters

None.

Returns

Nothing.

Insert the new node between the next pointer and the node pointed by it.

Used by lists to link new nodes to the list head.

Definition at line 88 of file lists.cpp.

link_previous()

void micro_os_plus::utils::double_list_links_base::link_previous ( double_list_links_base * node )

inherited

Link the new node as previous.

Parameters

None.

Returns

Nothing.

Insert the new node between the previous pointer and the node pointed by it.

Used by lists to link new nodes to the list tail.

Definition at line 112 of file lists.cpp.

linked()

bool micro_os_plus::utils::double_list_links_base::linked ( void ) const

inherited

Check if the node is linked to a double list.

Return values

true	The node is linked with both pointers.
false	The node is not linked.

To be linked, both pointers must point to different nodes than itself (double list requirement).

Definition at line 160 of file lists.cpp.

next()

double_list_links_base * micro_os_plus::utils::double_list_links_base::next ( void ) const

constexprinherited

Get the link to the next node.

Return values

Pointer

to the next node.

Definition at line 91 of file inlines.h.

previous()

double_list_links_base * micro_os_plus::utils::double_list_links_base::previous ( void ) const

constexprinherited

Get the link to the previous node.

Return values

Pointer

to the previous node.

Definition at line 97 of file inlines.h.

uninitialized()

bool micro_os_plus::utils::double_list_links_base::uninitialized ( void ) const

inherited

Check if the node is uninitialised.

Parameters

None.

Return values

true	The links are not initialised.
false	The links are initialised.

An uninitialized node is a node with the pointers set to nullptr.

Only statically allocated nodes in the initial state are uninitialized. Regular nodes are always initialised.

Definition at line 45 of file lists.cpp.

unlink()

void micro_os_plus::utils::double_list_links_base::unlink ( void )

inherited

Remove this node from the list.

Returns

Nothing.

Update both neighbours to point to each other, practically removing the node from the list.

The node is returned to the initial state (empty), with both pointers pointing to itself.

Definition at line 137 of file lists.cpp.

Member Data Documentation

next_

double_list_links_base* micro_os_plus::utils::double_list_links_base::next_

protectedinherited

Pointer to the next node.

Definition at line 210 of file lists.h.

previous_

double_list_links_base* micro_os_plus::utils::double_list_links_base::previous_

protectedinherited

Pointer to the previous node.

Definition at line 205 of file lists.h.

---

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

• lists.h
• inlines.h