fLiMgPTMF_c Class Reference

#include <dol/framework/f_list_mg_ptmf.hpp>

Inheritance diagram for fLiMgPTMF_c:

Description

A base list made of fLiNdPrio_c nodes, with a reference to a process function.

Note

Unofficial name.

Definition at line 12 of file f_list_mg_ptmf.hpp.

Public Member Functions
	fLiMgPTMF_c (int(fBase_c::*procFunc)())
	Constructs a new list.
bool	addNode (fLiNdPrio_c *node)
	Adds a node to the list, according to its priority.
bool	walkPack ()
	Calls the process function on each base in the list.
fLiNdPrio_c *	getFirst () const
fLiNdPrio_c *	getLast () const
Public Member Functions inherited from fLiMgBa_c
int	countNodeByProfName (ProfileName profName) const
	Counts the number of bases using the given profile name.
const fLiNdBa_c *	searchNodeByID (fBaseID_e id) const
	Searches for a base with the given ID.
fLiNdBa_c *	getFirst () const
fLiNdBa_c *	getLast () const
Public Member Functions inherited from cListMg_c
	cListMg_c ()
	Constructs a new list container.
bool	insertAfter (cListNd_c *node, cListNd_c *prevNode)
	Inserts a node after the given previous node.
bool	remove (cListNd_c *node)
	Removes a node from the list.
bool	append (cListNd_c *node)
	Adds a node to the end of the list.
bool	prepend (cListNd_c *node)
	Adds a node to the beginning of the list.
cListNd_c *	getFirst () const
cListNd_c *	getLast () const

Private Attributes
int(fBase_c::*	mpProcFunc )()
	The process function for the list.

Additional Inherited Members
Protected Attributes inherited from cListMg_c
cListNd_c *	mpFirst
	The first node in the list.
cListNd_c *	mpLast
	The last node in the list.

Constructor & Destructor Documentation

fLiMgPTMF_c()

fLiMgPTMF_c::fLiMgPTMF_c ( int(fBase_c::*)()  procFunc )

inline

Constructs a new list.

Parameters

procFunc

The process function, or nullptr.

Definition at line 17 of file f_list_mg_ptmf.hpp.

Member Function Documentation

addNode()

bool fLiMgPTMF_c::addNode

(

fLiNdPrio_c *

node

)

Adds a node to the list, according to its priority.

Parameters

node	The node to insert.

Returns

If the operation was successful.

Definition at line 6 of file f_list.cpp.

walkPack()

bool fLiMgPTMF_c::walkPack

(

)

Calls the process function on each base in the list.

Returns

Always returns true.

Definition at line 31 of file f_list.cpp.

getFirst()

fLiNdPrio_c * fLiMgPTMF_c::getFirst ( ) const

inline

Definition at line 31 of file f_list_mg_ptmf.hpp.

getLast()

fLiNdPrio_c * fLiMgPTMF_c::getLast ( ) const

inline

Definition at line 35 of file f_list_mg_ptmf.hpp.

Member Data Documentation

mpProcFunc

int(fBase_c::* fLiMgPTMF_c::mpProcFunc) ()

private

The process function for the list.

Definition at line 40 of file f_list_mg_ptmf.hpp.