alib::containers::detail::StringTreeBase< TAllocator, T, TNodeHandler, TRecycling >::NodeKey Struct Reference

Description:

template<typename TAllocator, typename T, typename TNodeHandler, Recycling TRecycling>
struct alib::containers::detail::StringTreeBase< TAllocator, T, TNodeHandler, TRecycling >::NodeKey

The unique key to any element stored in this container. By being a (second) base type for of type Node, any node includes this key.

Definition at line 53 of file stringtreebase.inl.

Inheritance diagram for alib::containers::detail::StringTreeBase< TAllocator, T, TNodeHandler, TRecycling >::NodeKey:

Collaboration diagram for alib::containers::detail::StringTreeBase< TAllocator, T, TNodeHandler, TRecycling >::NodeKey:

Inner Type Index:
struct	EqualTo
	Equality functor for nodes in field nodeTable. More...
struct	Hash
	Hash functor for nodes hashed in field nodeTable. More...
union	NodeNameUnion
struct	ValueDescriptor
	ValueDescriptor for hash table nodeTable. More...

Public Field Index:
NodeNameUnion	name
NodeBase *	parent

Public Method Index:
	NodeKey (NodeBase *pParent, const NameType &pName)

Field Details:

name

template<typename TAllocator, typename T, typename TNodeHandler, Recycling TRecycling>

NodeNameUnion alib::containers::detail::StringTreeBase< TAllocator, T, TNodeHandler, TRecycling >::NodeKey::name

A string object containing the pointer to this node's name. Node names constitute path strings and, together with the pointer to their parent, form the key of the hash set found with field nodeTable.
Node names must not contain the separator character and must not equal to "." or "..".

The name of the root node is nulled.

Definition at line 84 of file stringtreebase.inl.

parent

template<typename TAllocator, typename T, typename TNodeHandler, Recycling TRecycling>

NodeBase* alib::containers::detail::StringTreeBase< TAllocator, T, TNodeHandler, TRecycling >::NodeKey::parent

The parent node. A value of nullptr indicates that this is the root node of the tree, which is always existing.

Definition at line 57 of file stringtreebase.inl.

Constructor(s) / Destructor Details:

NodeKey()

template<typename TAllocator, typename T, typename TNodeHandler, Recycling TRecycling>

alib::containers::detail::StringTreeBase< TAllocator, T, TNodeHandler, TRecycling >::NodeKey::NodeKey ( NodeBase * pParent, const NameType & pName )

inline

Constructor

Parameters

pParent	Parent node to search a child for.
pName	Child name to search

Definition at line 89 of file stringtreebase.inl.

---

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

• stringtreebase.inl