spk::InherenceWithPriorityObject< TType > Class Template Reference

InherenceObject variant that keeps children sorted by priority. More...

#include <spk_inherence_with_priority_object.hpp>

Inheritance diagram for spk::InherenceWithPriorityObject< TType >:

Collaboration diagram for spk::InherenceWithPriorityObject< TType >:

Public Types
using	Priority = std::size_t
	Priority value type used for sorting.

Public Member Functions
	InherenceWithPriorityObject ()
	Builds a priority-aware inherence object.
void	addChild (TType *p_child) override
	Adds a child and re-sorts by priority.
void	setPriority (const Priority &p_priority)
	Sets this node's priority and refreshes parent ordering.
const Priority &	priority () const
	Returns the current priority value.
Public Member Functions inherited from spk::InherenceObject< TType >
virtual void	removeChild (TType *p_child)
	Removes a child from this node.
TType *	parent () const
	Returns the parent pointer.
virtual std::vector< TType * > &	children ()
	Returns the children vector.
virtual const std::vector< TType * > &	children () const
	Returns the children vector.
void	clearChildren ()
	Clears the children list and resets each child's parent pointer.

Protected Member Functions
void	_sortChildByPriority ()
	Sorts children by descending priority.
void	_notifyParentPriorityChanged ()
	Notifies the parent that this node's priority changed.

Detailed Description

template<typename TType>
class spk::InherenceWithPriorityObject< TType >

InherenceObject variant that keeps children sorted by priority.

Template Parameters

TType

Derived type inheriting from InherenceWithPriorityObject.

See also

InherenceObject

struct Widget : spk::InherenceWithPriorityObject<Widget> {};
Widget parent;
Widget child;
child.setPriority(10);
parent.addChild(&child);

Member Function Documentation

addChild()

template<typename TType>

void spk::InherenceWithPriorityObject< TType >::addChild ( TType * p_child )

inlineoverridevirtual

Adds a child and re-sorts by priority.

Parameters

p_child

Child pointer to add.

Reimplemented from spk::InherenceObject< TType >.

Here is the call graph for this function:

priority()

template<typename TType>

const Priority & spk::InherenceWithPriorityObject< TType >::priority ( ) const

inline

Returns the current priority value.

Returns

Priority value.

setPriority()

template<typename TType>

void spk::InherenceWithPriorityObject< TType >::setPriority ( const Priority & p_priority )

inline

Sets this node's priority and refreshes parent ordering.

Parameters

p_priority

New priority value.

Here is the call graph for this function:

---

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

• includes/structure/design_pattern/spk_inherence_with_priority_object.hpp