Graph: Generic attributed relational graphs


Edge Class Referenceabstract

The abstract base class for all types of edges; edges are created and managed by Graphs. More...

#include <graph/graph/edge.h>

Inheritance diagram for Edge:
Collaboration diagram for Edge:

Public Member Functions

Property querying methods
virtual bool isDirected () const =0
 Is this edge directed? More...
 
virtual bool isUndirected () const =0
 Is this edge undirected? More...
 
Iterators iterate on the vertices
iterator begin ()
 Get the beginning of the vertex collection of the graph. More...
 
iterator end ()
 Get the end of the vertex collection of the graph. More...
 
const_iterator begin () const
 Get the beginning of the vertex collection of the graph. More...
 
const_iterator end () const
 Get the end of the vertex collection of the graph. More...
 
reverse_iterator rbegin ()
 Get the beginning of the reversed vertex collection of the graph. More...
 
reverse_iterator rend ()
 Get the end of the reversed vertex collection of the graph. More...
 
const_reverse_iterator rbegin () const
 Get the beginning of the reversed vertex collection of the graph. More...
 
const_reverse_iterator rend () const
 Get the end of the reversed vertex collection of the graph. More...
 
- Public Member Functions inherited from GraphObject
virtual ~GraphObject ()
 
- Public Member Functions inherited from carto::SyntaxedObject< class >
 SyntaxedObject (const std::string &s)
 
 SyntaxedObject (const SyntaxedObject &x)
 

Friends

class Graph
 export private method addVertices More...
 

Associated types

typedef VSet::value_type value_type
 
typedef VSet::pointer pointer
 
typedef VSet::reference reference
 
typedef VSet::const_reference const_reference
 
typedef VSet::iterator iterator
 
typedef VSet::const_iterator const_iterator
 
typedef VSet::reverse_iterator reverse_iterator
 
typedef
VSet::const_reverse_iterator 
const_reverse_iterator
 

Constructors, destructor

virtual ~Edge ()
 
More...
 
 Edge (std::string s)
 The programmer should not call the constructor. More...
 
 Edge (const Edge &x)
 The programmer should not call the copy constructor. More...
 
virtual EdgecloneEdge () const =0
 The programmer should not clone. More...
 

Vertex handling

bool hasVertex (const Vertex *vertex) const
 Does this edge contain a given vertex? More...
 
size_t verticesSize () const
 number of vertices More...
 

Additional Inherited Members

- Public Types inherited from carto::SyntaxedObject< class >
typedef
internal::SyntaxedObjectSwitch
< T, SUPERSUBCLASS(Interface,
T)>::ContentType 
ContentType
 
- Protected Member Functions inherited from GraphObject
 GraphObject (const std::string &s)
 The programmer should not call the constructor of an abstract base class. More...
 
 GraphObject (const GraphObject &x)
 

Detailed Description

The abstract base class for all types of edges; edges are created and managed by Graphs.

Edge is the abstract base class for all types of edges, directed (D) or undirected (U). An Edge should contain at least one Vertex object. When the last vertex is removed from an edge, the edge is deleted by its graph owner.
See Graph for Edge creation.

Definition at line 68 of file edge.h.

Member Typedef Documentation

Definition at line 101 of file edge.h.

Definition at line 97 of file edge.h.

Definition at line 99 of file edge.h.

Definition at line 93 of file edge.h.

Definition at line 95 of file edge.h.

Definition at line 103 of file edge.h.

Definition at line 91 of file edge.h.

Constructor & Destructor Documentation

virtual Edge::~Edge ( )
virtual

Edge::Edge ( std::string  s)
protected

The programmer should not call the constructor.

Parameters
ssyntactic attribute
See also
Graph for creating edges
Edge::Edge ( const Edge x)
protected

The programmer should not call the copy constructor.

Parameters
xedge to clone
See also
Graph for creating edges

Member Function Documentation

Edge::iterator Edge::begin ( )
inline

Get the beginning of the vertex collection of the graph.

Returns
an iterator pointing to the beginning of the vertex collection

Definition at line 301 of file edge.h.

References carto::block< T, N >::begin().

Edge::const_iterator Edge::begin ( ) const
inline

Get the beginning of the vertex collection of the graph.

Returns
a const_iterator pointing to the beginning of the vertex collection

Definition at line 317 of file edge.h.

References carto::block< T, N >::begin().

virtual Edge* Edge::cloneEdge ( ) const
protectedpure virtual

The programmer should not clone.

Returns
a copy of this edge
See also
Graph for creating edges

Implemented in DEdge, and UEdge.

Edge::iterator Edge::end ( )
inline

Get the end of the vertex collection of the graph.

Returns
an iterator pointing to the end of the vertex collection

Definition at line 309 of file edge.h.

References carto::block< T, N >::end().

Edge::const_iterator Edge::end ( ) const
inline

Get the end of the vertex collection of the graph.

Returns
a const_iterator pointing to the end of the vertex collection

Definition at line 325 of file edge.h.

References carto::block< T, N >::end().

bool Edge::hasVertex ( const Vertex vertex) const
inline

Does this edge contain a given vertex?

Parameters
vertexpointer to the vertex to check
Returns
true if the edge contains this vertex

Definition at line 293 of file edge.h.

virtual bool Edge::isDirected ( ) const
pure virtual

Is this edge directed?

Implemented in DEdge, and UEdge.

virtual bool Edge::isUndirected ( ) const
pure virtual

Is this edge undirected?

Implemented in DEdge, and UEdge.

Edge::reverse_iterator Edge::rbegin ( )
inline

Get the beginning of the reversed vertex collection of the graph.

Returns
a reverse_iterator pointing to the beginning of the reversed vertex collection

Definition at line 333 of file edge.h.

References carto::block< T, N >::rbegin().

Edge::const_reverse_iterator Edge::rbegin ( ) const
inline

Get the beginning of the reversed vertex collection of the graph.

Returns
a const_reverse_iterator pointing to the beginning of the reversed vertex collection

Definition at line 349 of file edge.h.

References carto::block< T, N >::rbegin().

Edge::reverse_iterator Edge::rend ( )
inline

Get the end of the reversed vertex collection of the graph.

Returns
a reverse_iterator pointing to the end of the reversed vertex collection

Definition at line 341 of file edge.h.

References carto::block< T, N >::rend().

Edge::const_reverse_iterator Edge::rend ( ) const
inline

Get the end of the reversed vertex collection of the graph.

Returns
a const_reverse_iterator pointing to the end of the reversed vertex collection

Definition at line 357 of file edge.h.

References carto::block< T, N >::rend().

size_t Edge::verticesSize ( ) const

number of vertices

Friends And Related Function Documentation

friend class Graph
friend

export private method addVertices

Definition at line 239 of file edge.h.


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