Open
Graph Drawing
Framework

 v.2012.05
 

ogdf::EmbedIndicator Class Reference

#include <ogdf/internal/planarity/EmbedIndicator.h>

Inheritance diagram for ogdf::EmbedIndicator:
ogdf::PQNode< edge, indInfo *, bool > ogdf::PQNodeRoot

List of all members.

Public Member Functions

 EmbedIndicator (int count, PQNodeKey< edge, indInfo *, bool > *infoPtr)
virtual ~EmbedIndicator ()
PQNodeType type () const
 Returns the variable m_type in the derived class PQLeaf and PQInternalNode.
void type (PQNodeType)
 Sets the variable m_type in the derived class PQLeaf and PQInternalNode.
int status () const
 Returns the variable m_status in the derived class PQLeaf and PQInternalNode.
void status (int)
 Sets the variable m_status in the derived class PQLeaf and PQInternalNode.
int mark () const
void mark (int)
 mark() sets the variable m_mark in the derived class PQLeaf and PQInternalNode.
PQLeafKey< edge, indInfo
*, bool > * 
getKey () const
bool setKey (PQLeafKey< edge, indInfo *, bool > *pointerToKey)
 Sets a specified pointer variable in a derived class to the specified adress of pointerToKey that is of type PQLeafKey.
PQInternalKey< edge, indInfo
*, bool > * 
getInternal () const
bool setInternal (PQInternalKey< edge, indInfo *, bool > *pointerToInternal)

Detailed Description

Definition at line 65 of file EmbedIndicator.h.


Constructor & Destructor Documentation

ogdf::EmbedIndicator::EmbedIndicator ( int  count,
PQNodeKey< edge, indInfo *, bool > *  infoPtr 
) [inline]

Definition at line 69 of file EmbedIndicator.h.

virtual ogdf::EmbedIndicator::~EmbedIndicator ( ) [inline, virtual]

Definition at line 72 of file EmbedIndicator.h.


Member Function Documentation

PQInternalKey<edge,indInfo*,bool>* ogdf::EmbedIndicator::getInternal ( ) const [inline, virtual]

getInternal() returns a pointer to the PQInternalKey information of a node, in case that the node is supposed to have PQInternalKey information, such as elements of the derived class template PQInternalNode. The internal information is of type PQInternalKey.

Implements ogdf::PQNode< edge, indInfo *, bool >.

Definition at line 95 of file EmbedIndicator.h.

PQLeafKey<edge,indInfo*,bool>* ogdf::EmbedIndicator::getKey ( ) const [inline, virtual]

getKey() returns a pointer to the PQLeafKeyof a node, in case that the node is supposed to have a key, such as elements of the derived class template PQLeaf. The key contains information and is of type PQLeafKey.

Implements ogdf::PQNode< edge, indInfo *, bool >.

Definition at line 89 of file EmbedIndicator.h.

int ogdf::EmbedIndicator::mark ( ) const [inline, virtual]

mark() returns the variable m_mark in the derived class PQLeaf and PQInternalNode. In a derived class this function has to return the designation used in the first pass of Booth and Luekers algorithm called Bubble(). A node then is either marked BLOCKED, UNBLOCKED or QUEUED (see PQNode).

Implements ogdf::PQNode< edge, indInfo *, bool >.

Definition at line 85 of file EmbedIndicator.h.

void ogdf::EmbedIndicator::mark ( int  ) [inline, virtual]

mark() sets the variable m_mark in the derived class PQLeaf and PQInternalNode.

Implements ogdf::PQNode< edge, indInfo *, bool >.

Definition at line 87 of file EmbedIndicator.h.

bool ogdf::EmbedIndicator::setInternal ( PQInternalKey< edge, indInfo *, bool > *  pointerToInternal) [inline, virtual]

Implements ogdf::PQNode< edge, indInfo *, bool >.

Definition at line 97 of file EmbedIndicator.h.

bool ogdf::EmbedIndicator::setKey ( PQLeafKey< edge, indInfo *, bool > *  pointerToKey) [inline, virtual]

Sets a specified pointer variable in a derived class to the specified adress of pointerToKey that is of type PQLeafKey.

If a derived class, such as PQInternalNode, is not supposed to store informations of type PQLeafKey, setKey() ignores the informations as long as pointerToKey = 0. The return value then is 1. In case that pointerToKey != 0, the return value is 0.

If a derived class, such as PQLeaf is supposed to store informations of type PQLeafKey, pointerToKey has to be instantiated by the client. The function setKey() does not instantiate the corresponding variable in the derived class. The return value is always 1 unless pointerKey was equal to 0.

Implements ogdf::PQNode< edge, indInfo *, bool >.

Definition at line 91 of file EmbedIndicator.h.

int ogdf::EmbedIndicator::status ( ) const [inline, virtual]

Returns the variable m_status in the derived class PQLeaf and PQInternalNode.

Its objective is to manage status of a node in the PQ-tree. A status is any kind of information of the current situation in the frontier of a node (the frontier of a node are all descendant leaves of the node). A status is anything such as EMPTY, FULL or PARTIAL (see PQNode). Since there might be more than those three possibilities, (e.g. in computing planar subgraphs this function probably has to be overloaded by the client.

Implements ogdf::PQNode< edge, indInfo *, bool >.

Definition at line 81 of file EmbedIndicator.h.

void ogdf::EmbedIndicator::status ( int  ) [inline, virtual]

Sets the variable m_status in the derived class PQLeaf and PQInternalNode.

Implements ogdf::PQNode< edge, indInfo *, bool >.

Definition at line 83 of file EmbedIndicator.h.

PQNodeType ogdf::EmbedIndicator::type ( ) const [inline, virtual]

Returns the variable m_type in the derived class PQLeaf and PQInternalNode.

Its objective it to manage the type of a node. node the current node is. The type of a node in the class template PQTree is either PNode, QNode or leaf (see PQNode). There may be of course more types such as sequence indicators.

Observe that the derived class template PQLeaf does not have a variable m_type, since it obviously is of type leaf.

Implements ogdf::PQNode< edge, indInfo *, bool >.

Definition at line 77 of file EmbedIndicator.h.

void ogdf::EmbedIndicator::type ( PQNodeType  ) [inline, virtual]

Sets the variable m_type in the derived class PQLeaf and PQInternalNode.

Implements ogdf::PQNode< edge, indInfo *, bool >.

Definition at line 79 of file EmbedIndicator.h.


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