A tree node. More...

#include <tree.hpp>

Inheritance diagram for psynth::base::tree_node< Node, Key, Traits, ThreadingPolicy >:

Public Types
typedef std::unique_ptr< Node >	node_ptr
	Pointer to the node type.
typedef ptr_iterator < map_iterator< Key, node_ptr > >	iterator
	Iterator to check the childs of this node.
typedef ptr_const_iterator < map_const_iterator< Key, std::unique_ptr< Node > > >	const_iterator
	Iterator to check the childs of this node, const version.
typedef Traits	traits
	Traits being used in this instanciation.
Public Member Functions
	tree_node ()
	Constuctor.
	~tree_node ()
	Destructor.
iterator	begin ()
	Returns an iterator to the first child of this node.
const_iterator	begin () const
	Returns an iterator to the first child of this node.
iterator	end ()
	Returns an iterator to the end of this node childs.
const_iterator	end () const
	Returns an iterator to the end of this node childs.
const Node *	parent () const
	Returns a pointer to the parent of this node or `null` if this is a root node.
Node *	parent ()
	Returns a pointer to the parent of this node or `null` if this is a root node.
const Key &	name () const
	Returns the name of this node.
iterator	find_child (const Key &name)
	Returns an iterator to a child given by its key or end () otherwise.
const_iterator	find_child (const Key &name) const
	Returns an iterator to a child given by its key or end () otherwise.
node_ptr	detach (const Key &name)
	Detaches a node from the tree.
iterator	remove_child (const Key &name)
	Deletes a child of this node.
bool	attach (const Key &name, node_ptr node)
	Attaches a node to a tree.
node_ptr	detach (iterator iter)
	Detaches a node from the tree.
Key	path_name () const
	Returns the path of this node from the root to the node.
iterator	remove_child (iterator iter)
	Deletes a child of this node.
void	clear_childs ()
	Removes all childs.
Node &	child (const Key &name)
	Returns a reference to the child of this node mathing a name.
Node &	existing_child (const Key &name)
	Returns a reference to the child of this node mathing a name, throwing an exception if the node does not exist.
const Node &	existing_child (const Key &name) const
	Returns a reference to the child of this node mathing a name, throwing an exception if the node does not exist.
Node &	path (const Key &name)
	Returns a reference to the child matching a path.
Node &	existing_path (const Key &name)
	Returns a reference to the child matching a path, an exception is thrown if the path does not exist.
const Node &	existing_path (const Key &name) const
	Returns a reference to the child matching a path, an exception is thrown if the path does not exist.
Protected Member Functions
virtual void	on_new_child (Node &node)
virtual void	on_remove_child (Node &node)
virtual void	on_init ()
virtual void	on_uninit ()

Detailed Description

template<class Node, class Key = std::string, class Traits = tree_node_traits<Key>, class ThreadingPolicy = PSYNTH_DEFAULT_THREADING <Node>>
class psynth::base::tree_node< Node, Key, Traits, ThreadingPolicy >

A tree node.

This class in intended to be used by inheriting from it, so you directly gain a tree interface for a composite type. You should pass it the derived class as type parameter.

Note that the void sequence is a valid name, so the key string "..." denotes the node "" -> "" -> "" -> "".

Parameters:

Node	The type of the class that is inheriting from us.
Key	They type of the class that identifies tree nodes. It must be some kind of compound type and in the current implementation it must have std::string semantics.
Traits	Additional information about the key type that is used to compose the paths.
ThreadingPolicy	Wether you want your tree type to be thread-safe. Note that to avoid problems when creating mix-ins tree_node won't inherit from ThreadingPolicy but it will expect you to do so (it uses Node::lock).

Todo:

Fix copy operations.

Fix string operations to be more generic.

Add value_type and other container typedefs.