ogdf::FaceElement Class Reference

Faces in a combinatorial embedding. More...

#include <ogdf/basic/CombinatorialEmbedding.h>

Inheritance diagram for ogdf::FaceElement:

List of all members.

Public Member Functions
adjEntry	firstAdj () const
	Returns the first adjacency element in the face.
int	index () const
	Returns the index of the face.
adjEntry	nextFaceEdge (adjEntry adj) const
	Returns the successor of adj in the list of all adjacency elements in the face.
face	pred () const
	Returns the predecessor in the list of all faces.
int	size () const
	Returns the size of the face, i.e., the number of edges in the face.
face	succ () const
	Returns the successor in the list of all faces.

Private Member Functions
	FaceElement (adjEntry adjFirst, int id)
	Creates a face with given first adjacency element adjFirst and face index id.

Private Attributes
adjEntry	m_adjFirst
	The first adjacency element in the face.
int	m_id
	The index of the face.
int	m_size
	The size of the face.

Friends
class	CombinatorialEmbedding
class	ConstCombinatorialEmbedding
class	GraphList< FaceElement >

---

Detailed Description

Faces in a combinatorial embedding.

Definition at line 65 of file CombinatorialEmbedding.h.

---

Constructor & Destructor Documentation

ogdf::FaceElement::FaceElement ( adjEntry  adjFirst, int  id  )

inlineprivate

Creates a face with given first adjacency element adjFirst and face index id.

Definition at line 87 of file CombinatorialEmbedding.h.

---

Member Function Documentation

adjEntry ogdf::FaceElement::firstAdj ( ) const

inline

Returns the first adjacency element in the face.

Definition at line 96 of file CombinatorialEmbedding.h.

int ogdf::FaceElement::index ( ) const

inline

Returns the index of the face.

Definition at line 93 of file CombinatorialEmbedding.h.

adjEntry ogdf::FaceElement::nextFaceEdge ( adjEntry  adj ) const

inline

Returns the successor of adj in the list of all adjacency elements in the face.

Definition at line 108 of file CombinatorialEmbedding.h.

face ogdf::FaceElement::pred ( ) const

inline

Returns the predecessor in the list of all faces.

Definition at line 105 of file CombinatorialEmbedding.h.

int ogdf::FaceElement::size ( ) const

inline

Returns the size of the face, i.e., the number of edges in the face.

Definition at line 99 of file CombinatorialEmbedding.h.

face ogdf::FaceElement::succ ( ) const

inline

Returns the successor in the list of all faces.

Definition at line 102 of file CombinatorialEmbedding.h.

---

Friends And Related Function Documentation

friend class CombinatorialEmbedding

friend

Definition at line 68 of file CombinatorialEmbedding.h.

friend class ConstCombinatorialEmbedding

friend

Definition at line 67 of file CombinatorialEmbedding.h.

friend class GraphList< FaceElement >

friend

Definition at line 69 of file CombinatorialEmbedding.h.

---

Member Data Documentation

adjEntry ogdf::FaceElement::m_adjFirst

private

The first adjacency element in the face.

Definition at line 71 of file CombinatorialEmbedding.h.

int ogdf::FaceElement::m_id

private

The index of the face.

Definition at line 72 of file CombinatorialEmbedding.h.

int ogdf::FaceElement::m_size

private

The size of the face.

Definition at line 73 of file CombinatorialEmbedding.h.

---

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

• ogdf/basic/CombinatorialEmbedding.h