os::utils::double_list Class Reference

Circular double linked list of nodes. More...

#include <cmsis-plus/utils/lists.h>

Inherits os::utils::static_double_list.

Inherited by os::rtos::internal::clock_timestamps_list, os::rtos::internal::thread_children_list, and os::rtos::internal::waiting_threads_list.

Public Member Functions
Constructors & Destructor
	double_list ()
	Construct a list. More...
	~double_list ()
	Destruct the list. More...
Public Member Functions
bool	uninitialized (void) const
	Check if the list is unitialised. More...
void	clear (void)
	Clear the list. More...
bool	empty (void) const
	Check if the list is empty. More...
volatile static_double_list_links *	head (void) const
	Get the list head. More...
volatile static_double_list_links *	tail (void) const
	Get the list tail. More...

Protected Member Functions
Private Member Functions
void	insert_after (static_double_list_links &node, static_double_list_links *after)
	Insert a new node after existing node. More...

Protected Attributes
Private Member Variables
static_double_list_links	head_
	A list node used to point to head and tail. More...

Detailed Description

Circular double linked list of nodes.

Definition at line 500 of file lists.h.

Constructor & Destructor Documentation

double_list()

os::utils::double_list::double_list

(

)

Construct a list.

The initial list status is empty.

Definition at line 147 of file lists.cpp.

~double_list()

os::utils::double_list::~double_list

(

)

Destruct the list.

There must be no nodes in the list.

Definition at line 160 of file lists.cpp.

Member Function Documentation

clear()

void os::utils::static_double_list::clear ( void  )

inherited

Clear the list.

Parameters

None.

Returns

Nothing.

Initialise the mandatory node with links to itself.

Definition at line 108 of file lists.cpp.

empty()

bool os::utils::static_double_list::empty ( void  ) const

inlineinherited

Check if the list is empty.

Parameters

None.

Return values

true	The list has no nodes.
false	The list has at least one node.

Definition at line 1032 of file lists.h.

head()

volatile static_double_list_links * os::utils::static_double_list::head ( void  ) const

inlineinherited

Get the list head.

Parameters

None.

Returns

Pointer to head node.

Definition at line 1039 of file lists.h.

insert_after()

void os::utils::static_double_list::insert_after ( static_double_list_links &  node, static_double_list_links *  after  )

protectedinherited

Insert a new node after existing node.

Parameters

node	Reference to node to insert.
after	Reference to existing node.

Returns

Nothing.

Definition at line 115 of file lists.cpp.

tail()

volatile static_double_list_links * os::utils::static_double_list::tail ( void  ) const

inlineinherited

Get the list tail.

Parameters

None.

Returns

Pointer to tail node.

Definition at line 1045 of file lists.h.

uninitialized()

bool os::utils::static_double_list::uninitialized ( void  ) const

inlineinherited

Check if the list is unitialised.

Parameters

None.

Return values

true	The list was not initialised.
false	The list was initialised.

Definition at line 1025 of file lists.h.

Member Data Documentation

head_

static_double_list_links os::utils::static_double_list::head_

protectedinherited

A list node used to point to head and tail.

To simplify processing, the list always has a node.

Definition at line 486 of file lists.h.

---

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

• include/cmsis-plus/utils/lists.h
• src/utils/lists.cpp