ogdf::PQNodeKey< T, X, Y > Class Template Reference

The class template PQNodeKey is a derived class of class template PQBasicKey. More...

#include <ogdf/basic/pqtree/PQNodeKey.h>

Inheritance diagram for ogdf::PQNodeKey< T, X, Y >:

Public Member Functions
	PQNodeKey (X info)
virtual	~PQNodeKey ()
virtual X	userStructInfo ()
	Returns m_userStructInfo.
virtual Y	userStructInternal ()
	Returns 0.
virtual T	userStructKey ()
	Returns 0.
Public Member Functions inherited from ogdf::PQBasicKey< T, X, Y >
	PQBasicKey ()
	Constructor.
PQNode< T, X, Y > *	nodePointer ()
	The function nodePointer() returns a pointer to an element of type PQNode.
virtual std::ostream &	print (std::ostream &os)
	The function print() is a virtual function, that can be overloaded by the user in order to print out the information stored at any of the derived classes.
void	setNodePointer (PQNode< T, X, Y > *pqNode)
	The function setNodePointer() sets the private member m_nodePointer.
Public Member Functions inherited from ogdf::PQBasicKeyRoot
	PQBasicKeyRoot ()
	~PQBasicKeyRoot ()

Public Attributes
X	m_userStructInfo
	Stores the information. Has to be overloaded by the client.

Detailed Description

template<class T, class X, class Y>
class ogdf::PQNodeKey< T, X, Y >

The class template PQNodeKey is a derived class of class template PQBasicKey.

PQNodeKey is a concrete class. It is constructed to store any kind of information of nodes of the PQ-tree. It may be used for both internal nodes as well as leaves.

The information is stored in m_userStructInfo and is assigned to a unique node in the PQ-tree. This unique node can be identified with the m_nodePointer of the astract base class PQBasicKey. The maintainance of this pointer is left to the user. By keeping the responsibillity by the user, nodes with certain informations can be identified and accessed by her in constant time. This makes the adaption of algorithms fast and easy.

Definition at line 57 of file PQNodeKey.h.

Constructor & Destructor Documentation

PQNodeKey()

template<class T , class X , class Y >

ogdf::PQNodeKey< T, X, Y >::PQNodeKey ( X  info )

inlineexplicit

Definition at line 63 of file PQNodeKey.h.

~PQNodeKey()

template<class T , class X , class Y >

virtual ogdf::PQNodeKey< T, X, Y >::~PQNodeKey ( )

inlinevirtual

Definition at line 66 of file PQNodeKey.h.

Member Function Documentation

userStructInfo()

template<class T , class X , class Y >

virtual X ogdf::PQNodeKey< T, X, Y >::userStructInfo ( )

inlinevirtual

Returns m_userStructInfo.

Implements ogdf::PQBasicKey< T, X, Y >.

Definition at line 72 of file PQNodeKey.h.

userStructInternal()

template<class T , class X , class Y >

virtual Y ogdf::PQNodeKey< T, X, Y >::userStructInternal ( )

inlinevirtual

Returns 0.

Implements ogdf::PQBasicKey< T, X, Y >.

Definition at line 75 of file PQNodeKey.h.

userStructKey()

template<class T , class X , class Y >

virtual T ogdf::PQNodeKey< T, X, Y >::userStructKey ( )

inlinevirtual

Returns 0.

Implements ogdf::PQBasicKey< T, X, Y >.

Definition at line 69 of file PQNodeKey.h.

Member Data Documentation

m_userStructInfo

template<class T , class X , class Y >

X ogdf::PQNodeKey< T, X, Y >::m_userStructInfo

Stores the information. Has to be overloaded by the client.

Definition at line 60 of file PQNodeKey.h.

---

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

• include/ogdf/basic/pqtree/PQNode.h
• include/ogdf/basic/pqtree/PQNodeKey.h