tree structure data management class More...

#include <TreeNode.h>

Public Member Functions
	TreeNode ()
	constructor

	TreeNode (T &elm)
	constructor

virtual	~TreeNode ()
	destructor

T &	getElement ()
	gets the element that the node has

void	setElement (T &elm)
	sets the element that the node has

TreeNode *	getParentNode ()
	gets parent node More...

unsigned int	getNumberOfChildren ()
	gets the number of child nodes More...

TreeNode *	getChild (int index)
	get child node More...

void	clearChildren ()
	remove all child nodes

TreeNode *	addChild ()
	create child node More...

TreeNode *	addChild (T &elm)
	create child node More...

void	sortChildren (boost::function< bool(TreeNode< T > &, TreeNode< T > &) > lessFun)
	sort child nodes More...

Protected Member Functions
	TreeNode (TreeNode< T > *parent)
	constructor More...

	TreeNode (TreeNode< T > *parent, T &elm)
	constructor More...

Protected Attributes
T	m_element

std::vector< TreeNode< T > * >	m_children

TreeNode< T > *	m_parent

Detailed Description

template<typename T>
class kome::core::TreeNode< T >

tree structure data management class

Definition at line 29 of file TreeNode.h.

Constructor & Destructor Documentation

template<typename T>

kome::core::TreeNode< T >::TreeNode ( TreeNode< T > * parent )

inlineprotected

constructor

Parameters

[in] parent parent node

Definition at line 176 of file TreeNode.h.

                                             : m_element() {
                 m_parent = parent;
             }

template<typename T>

kome::core::TreeNode< T >::TreeNode	(	TreeNode< T > *	parent,
		T &	elm
	)

inlineprotected

constructor

Parameters

[in]	parent	parent node
[in]	elm	the element that the node has

Definition at line 186 of file TreeNode.h.

                                                     : m_element( elm ) {
                 m_parent = parent;
             }

Member Function Documentation

template<typename T>

TreeNode * kome::core::TreeNode< T >::addChild ( )

inline

create child node

Returns: the child node created

Definition at line 120 of file TreeNode.h.

                                 {
                 TreeNode<T>* child = new TreeNode<T>();
                 m_children.push_back( child );
                 return child;
             }

template<typename T>

TreeNode * kome::core::TreeNode< T >::addChild ( T & elm )

inline

create child node

Parameters

[in] elm the element that child node has

Returns: the child node created

Definition at line 132 of file TreeNode.h.

                                         {
                 TreeNode<T>* child = new TreeNode<T>( elm );
                 m_children.push_back( child );
                 return child;
             }

template<typename T>

TreeNode * kome::core::TreeNode< T >::getChild ( int index )

inline

get child node

Parameters

[in] index child index

Returns: child node ( If there is no child node that has index specified, this method returns NULL )

Definition at line 95 of file TreeNode.h.

                                             {
                 // check parameter
                 if( index < 0 || index > m_children.size() ) {
                     return NULL;
                 }
 
                 return m_children[index];
             }

template<typename T>

unsigned int kome::core::TreeNode< T >::getNumberOfChildren ( )

inline

gets the number of child nodes

Returns: the number of child nodes

Definition at line 85 of file TreeNode.h.

                                               {
                 return m_children.size();
             }

template<typename T>

TreeNode * kome::core::TreeNode< T >::getParentNode ( )

inline

gets parent node

Returns: parent node. ( If this node has no parent, this method returns NULL )

Definition at line 76 of file TreeNode.h.

                                      {
                 return m_parent;
             }

template<typename T>

void kome::core::TreeNode< T >::sortChildren ( boost::function< bool(TreeNode< T > &, TreeNode< T > &) > lessFun )

inline

sort child nodes

Parameters

[in] lessFun the function to compare. This function has two Properties. The first parameter is the node to compare. The second parameter is the node to be compared. If the node specified by the first parameter sorts before the node specified by second parameter, this function returns true

Definition at line 147 of file TreeNode.h.

                                                                                               {
                 // check member
                 if( m_children.size() == 0 ) {
                     return;
                 }
 
                 // sort ( This method is called recursively. )
                 for( unsigned int i = 0; i < m_children.size(); i++ ) {
                     m_children[i]->sortChildre( lessFun );
                 }
 
                 std::sort( m_children.begin(), m_children.end(), lessFun );
             }

Member Data Documentation

template<typename T>

std::vector< TreeNode<T>* > kome::core::TreeNode< T >::m_children

protected

the array of child nodes

Definition at line 166 of file TreeNode.h.

template<typename T>

T kome::core::TreeNode< T >::m_element

protected

the element that the node has

Definition at line 163 of file TreeNode.h.

template<typename T>

TreeNode<T>* kome::core::TreeNode< T >::m_parent

protected

the parent node

Definition at line 169 of file TreeNode.h.

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

CoreToolkits/TreeNode.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<typename T> class kome::core::TreeNode< T >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T>
class kome::core::TreeNode< T >