# OpenGraph DrawingFramework

v.2012.07

ogdf::EdgeElement Class Reference

Class for the representation of edges. More...

#include <ogdf/basic/Graph_d.h>

Inheritance diagram for ogdf::EdgeElement:

List of all members.

## Public Member Functions

Returns the corresponding adjacancy entry at source node.
Returns the corresponding adjacancy entry at target node.
node commonNode (edge e) const
Returns the common node of the edge and e. Returns NULL if the two edges are not adjacent.
int index () const
Returns the index of the edge.
bool isIncident (node v) const
Returns true iff v is incident to the edge.
bool isSelfLoop () const
node opposite (node v) const
Returns the adjacent node different from v.
edge pred () const
Returns the predecessor in the list of all edges.
node source () const
Returns the source node of the edge.
edge succ () const
Returns the successor in the list of all edges.
node target () const
Returns the target node of the edge.

## Private Member Functions

Constructs an edge element (src,tgt).
EdgeElement (node src, node tgt, int id)
Constructs an edge element (src,tgt).

## Private Attributes

Corresponding adjacancy entry at source node.
Corresponding adjacancy entry at target node.
int m_id
node m_src
The source node of the edge.
node m_tgt
The target node of the edge.

## Friends

class Graph
class GraphList< EdgeElement >

## Detailed Description

Class for the representation of edges.

Definition at line 524 of file Graph_d.h.

## Constructor & Destructor Documentation

inlineprivate

Constructs an edge element (src,tgt).

Parameters:
 src is the source node of the edge. tgt is the target node of the edge. adjSrc is the corresponding adjacency entry at source node. adjTgt is the corresponding adjacency entry at target node. id is the index of the edge.

Definition at line 542 of file Graph_d.h.

 ogdf::EdgeElement::EdgeElement ( node src, node tgt, int id )
inlineprivate

Constructs an edge element (src,tgt).

Parameters:
 src is the source node of the edge. tgt is the target node of the edge. id is the index of the edge.

Definition at line 551 of file Graph_d.h.

## Member Function Documentation

inline

Returns the corresponding adjacancy entry at source node.

Definition at line 563 of file Graph_d.h.

inline

Returns the corresponding adjacancy entry at target node.

Definition at line 565 of file Graph_d.h.

 node ogdf::EdgeElement::commonNode ( edge e ) const
inline

Returns the common node of the edge and e. Returns NULL if the two edges are not adjacent.

Definition at line 586 of file Graph_d.h.

 int ogdf::EdgeElement::index ( ) const
inline

Returns the index of the edge.

Definition at line 556 of file Graph_d.h.

 bool ogdf::EdgeElement::isIncident ( node v ) const
inline

Returns true iff v is incident to the edge.

Definition at line 583 of file Graph_d.h.

 bool ogdf::EdgeElement::isSelfLoop ( ) const
inline

Definition at line 570 of file Graph_d.h.

 node ogdf::EdgeElement::opposite ( node v ) const
inline

Returns the adjacent node different from v.

Definition at line 568 of file Graph_d.h.

 edge ogdf::EdgeElement::pred ( ) const
inline

Returns the predecessor in the list of all edges.

Definition at line 575 of file Graph_d.h.

 node ogdf::EdgeElement::source ( ) const
inline

Returns the source node of the edge.

Definition at line 558 of file Graph_d.h.

 edge ogdf::EdgeElement::succ ( ) const
inline

Returns the successor in the list of all edges.

Definition at line 573 of file Graph_d.h.

 node ogdf::EdgeElement::target ( ) const
inline

Returns the target node of the edge.

Definition at line 560 of file Graph_d.h.

## Friends And Related Function Documentation

 friend class Graph
friend

Reimplemented from ogdf::GraphElement.

Definition at line 525 of file Graph_d.h.

 friend class GraphList< EdgeElement >
friend

Definition at line 526 of file Graph_d.h.

## Member Data Documentation

private

Corresponding adjacancy entry at source node.

Definition at line 530 of file Graph_d.h.

private

Corresponding adjacancy entry at target node.

Definition at line 531 of file Graph_d.h.

 int ogdf::EdgeElement::m_id
private

Definition at line 532 of file Graph_d.h.

 node ogdf::EdgeElement::m_src
private

The source node of the edge.

Definition at line 528 of file Graph_d.h.

 node ogdf::EdgeElement::m_tgt
private

The target node of the edge.

Definition at line 529 of file Graph_d.h.

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