NAME
Graphs -
Classes
struct tlp::edge
class edge
struct tlp::Face
class face
class tlp::Graph
Interface for a graph.
struct tlp::node
class node
class tlp::GraphObserver
Observer for Graph.
class tlp::ObservableGraph
Observable object for graph.
class tlp::PropertyObserver
Observer for Property.
class tlp::ObservableProperty
Observable object for Property.
Functions
tlp::Graph::Graph ()
virtual tlp::Graph::~Graph ()
virtual void tlp::Graph::clear ()=0
virtual Graph * tlp::Graph::addSubGraph (BooleanProperty
*selection=0)=0
virtual void tlp::Graph::delSubGraph (Graph *)=0
virtual void tlp::Graph::delAllSubGraphs (Graph *)=0
virtual Graph * tlp::Graph::getSuperGraph () const =0
Graph * tlp::Graph::getFather () const
virtual Graph * tlp::Graph::getRoot () const =0
virtual void tlp::Graph::setSuperGraph (Graph *)=0
void tlp::Graph::setFather (Graph *sg)
virtual Iterator< Graph * > * tlp::Graph::getSubGraphs () const =0
virtual node tlp::Graph::addNode ()=0
virtual void tlp::Graph::addNode (const node)=0
virtual void tlp::Graph::delNode (const node)=0
virtual void tlp::Graph::delAllNode (const node)=0
virtual edge tlp::Graph::addEdge (const node, const node)=0
virtual void tlp::Graph::addEdge (const edge)=0
virtual void tlp::Graph::delEdge (const edge)=0
virtual void tlp::Graph::delAllEdge (const edge)=0
virtual void tlp::Graph::setEdgeOrder (const node, const std::vector<
edge > &)=0
virtual void tlp::Graph::swapEdgeOrder (const node, const edge, const
edge)=0
virtual void tlp::Graph::reverse (const edge)=0
virtual node tlp::Graph::getOneNode () const =0
Return an existing node of the graph.
virtual Iterator< node > * tlp::Graph::getNodes () const =0
Return an iterator on the nodes.
virtual node tlp::Graph::getInNode (const node, unsigned int) const =0
Return the ith successor of a node.
virtual Iterator< node > * tlp::Graph::getInNodes (const node) const =0
Return an iterator on the predecessors of a node.
virtual node tlp::Graph::getOutNode (const node, unsigned int) const =0
Return the ith predecessor of a node.
virtual Iterator< node > * tlp::Graph::getOutNodes (const node) const
=0
Return an iterator on the successors of a node.
virtual Iterator< node > * tlp::Graph::getInOutNodes (const node) const
=0
Return an iterator on the neighbours of a node.
virtual Graph * tlp::Graph::getNodeMetaInfo (const node) const =0
Returns the underlying graph of a meta node.
virtual Iterator< edge > * tlp::Graph::getEdges () const =0
Return an iterator on the edges.
virtual edge tlp::Graph::getOneEdge () const =0
Return an existing edge of the graph.
virtual Iterator< edge > * tlp::Graph::getOutEdges (const node) const
=0
Return an iterator on the out-edges of a node.
virtual Iterator< edge > * tlp::Graph::getInOutEdges (const node) const
=0
Return an iterator on the in-out-edges of a node.
virtual Iterator< edge > * tlp::Graph::getInEdges (const node) const =0
Return an iterator on the in--edges of a node.
virtual Iterator< edge > * tlp::Graph::getEdgeMetaInfo (const edge)
const =0
Return an iterator on the underlying edges of a meta edge.
int tlp::Graph::getId () const
Return the graphs id, this id is unique.
virtual unsigned int tlp::Graph::numberOfNodes () const =0
Return the number of nodes in the graph.
virtual unsigned int tlp::Graph::numberOfEdges () const =0
Return the number of edges in the graph.
virtual unsigned int tlp::Graph::deg (const node) const =0
Return degree of a node.
virtual unsigned int tlp::Graph::indeg (const node) const =0
Return indegree of a node.
virtual unsigned int tlp::Graph::outdeg (const node) const =0
Return outdegree of a node.
virtual node tlp::Graph::source (const edge) const =0
Return the source of the edge.
virtual node tlp::Graph::target (const edge) const =0
Return the target of the edge.
virtual node tlp::Graph::opposite (const edge, const node) const =0
Return the opposite node for s in the edge e.
virtual bool tlp::Graph::isElement (const node) const =0
Return true if the node is element of the graph.
virtual bool tlp::Graph::isMetaNode (const node) const =0
Return true if the node is a meta node.
virtual bool tlp::Graph::isElement (const edge) const =0
Return true if the edge is element of the graph.
virtual bool tlp::Graph::isMetaEdge (const edge) const =0
Return true if the edge is a meta edge.
virtual edge tlp::Graph::existEdge (const node, const node) const =0
virtual DataSet & tlp::Graph::getAttributes ()=0
Return graph attributes.
template<typename ATTRIBUTETYPE > bool tlp::Graph::getAttribute (const
std::string &name, ATTRIBUTETYPE &value)
template<typename ATTRIBUTETYPE > ATTRIBUTETYPE
tlp::Graph::getAttribute (const std::string &name)
deprecated version of the previous method
template<typename ATTRIBUTETYPE > void tlp::Graph::setAttribute (const
std::string &name, const ATTRIBUTETYPE &value)
Set an attribute of the graph.
void tlp::Graph::removeAttribute (const std::string &name)
remove an existing attribute
bool tlp::Graph::attributeExist (const std::string &name)
return if the attribute exist
virtual void tlp::Graph::addLocalProperty (const std::string &name,
PropertyInterface *prop)=0
template<typename Proxytype > Proxytype * tlp::Graph::getLocalProperty
(const std::string &name)
template<typename Proxytype > bool tlp::Graph::computeProperty (const
std::string &algorithm, Proxytype result, std::string &msg,
PluginProgress *progress=0, DataSet *data=0)
template<typename Proxytype > Proxytype * tlp::Graph::getProperty
(const std::string &name)
virtual bool tlp::Graph::existProperty (const std::string &name)=0
virtual bool tlp::Graph::existLocalProperty (const std::string &name)=0
virtual void tlp::Graph::delLocalProperty (const std::string &name)=0
virtual Iterator< std::string > * tlp::Graph::getLocalProperties ()=0
virtual Iterator< std::string > * tlp::Graph::getInheritedProperties
()=0
virtual Iterator< std::string > * tlp::Graph::getProperties ()=0
virtual void tlp::Graph::push ()=0
virtual void tlp::Graph::pop ()=0
virtual void tlp::Graph::unpop ()=0
virtual bool tlp::Graph::canPop ()=0
virtual bool tlp::Graph::canUnpop ()=0
virtual node tlp::Graph::restoreNode (node)=0
virtual edge tlp::Graph::restoreEdge (edge, node source, node target)=0
virtual void tlp::Graph::removeNode (const node)=0
virtual void tlp::Graph::removeEdge (const edge, const node=node())=0
virtual void tlp::Graph::removeSubGraph (Graph *)=0
virtual void tlp::Graph::clearSubGraphs ()=0
virtual void tlp::Graph::restoreSubGraph (Graph *, bool
restoreSubGraphs=false)=0
virtual void tlp::Graph::setSubGraphToKeep (Graph *)=0
Detailed Description
Authors: David Auber, Patrick Mary, Morgan Mathiaut from the LaBRI
Visualization Team Email : auber@tulip-software.org Last modification :
13/03/2009 This program is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.
Function Documentation
virtual void tlp::Graph::addEdge (const edge) [pure virtual, inherited]
Add an existing edge in the graph. this edge is also added in all the
super-graph of the graph to maintain the sub-graph relation between
graphs. Warning, the edge must be element of the graph hierarchy, thus
it must be element of the root graph. Warning : One can’t add an
existing edge to the root graph
virtual edge tlp::Graph::addEdge (const node, const node) [pure virtual,
inherited] Add a new edge in the graph and return it. This edge is also
added in all the super-graph of the graph to maintain the sub-graph
relation between graphs. If the second parameter is true the ordering
of edges will be preserved.
virtual void tlp::Graph::addLocalProperty (const std::string & name,
PropertyInterface * prop) [pure virtual, inherited] add a property to
the graph Be aware that the PropertyInterface will now belong to the
graph object; and so it will be deleted automatically. Using of delete
on that property will cause a segmentation violation (use
delLocalProperty instead).
virtual void tlp::Graph::addNode (const node) [pure virtual, inherited]
Add an existing node in the graph. this node is also added in all the
graph ancestors to maintain the sub_graph relation between graphs.
Warning, the node must be element of the graph hierarchy, thus it must
be element of the root graph.
virtual node tlp::Graph::addNode () [pure virtual, inherited] Add a new
node in the graph and return it. This node is also added in all the
graph ancestors to maintain the sub_graph relation between graphs.
virtual Graph* tlp::Graph::addSubGraph (BooleanProperty * selection = 0)
[pure virtual, inherited] Create and return a new SubGraph of the graph
The elements of the new SubGraph is those selected in the selection if
there is no selection an empty SubGraph is return.
bool tlp::Graph::attributeExist (const std::string & name) [inline,
inherited]
return if the attribute exist
virtual bool tlp::Graph::canPop () [pure virtual, inherited]
virtual bool tlp::Graph::canUnpop () [pure virtual, inherited]
virtual void tlp::Graph::clear () [pure virtual, inherited] Remove all
nodes, edges and subgraphs of the supergraph
virtual void tlp::Graph::clearSubGraphs () [protected, pure virtual,
inherited]
template<typename Proxytype > bool tlp::Graph::computeProperty (const
std::string & algorithm, Proxytype result, std::string & msg,
PluginProgress * progress = 0, DataSet * data = 0) [inline, inherited]
Compute a property on this graph using an external algorithm (plug-in)
The result is stored in result, Warning all information in result will
be deleted If the function return false error message are stored in
msg. One can give a PluginProgress to the algortihm in order to have
feed back or to stop the algorithm during its computation. One can give
parameter to the algorithm using the DataSet. In some cases algorithms
can use this DataSet in order to give as result external information
(not stored in result).
virtual unsigned int tlp::Graph::deg (const node) const [pure virtual,
inherited]
Return degree of a node.
virtual void tlp::Graph::delAllEdge (const edge) [pure virtual, inherited]
Delete an edge in all the hierarchy of graphs. The ordering of edges
around the node is preserved.
virtual void tlp::Graph::delAllNode (const node) [pure virtual, inherited]
Delete a node in all the hierarchy of graphs.
virtual void tlp::Graph::delAllSubGraphs (Graph *) [pure virtual,
inherited] Del the SubGraph of the graph and all its SubGraphs.
virtual void tlp::Graph::delEdge (const edge) [pure virtual, inherited]
Delete an edge in the graph. this edge is also removed in all the sub-
graph of the graph to maintain the sub-graph relation between graphs.
The ordering of edges is preserved.
virtual void tlp::Graph::delLocalProperty (const std::string & name) [pure
virtual, inherited] Remove a property from the graph
virtual void tlp::Graph::delNode (const node) [pure virtual, inherited]
Delete a node in the graph. this node is also removed in all the sub-
graph of the graph to maintain the sub-graph relation between graphs.
Warning : One can’t add an existing node to the root graph
virtual void tlp::Graph::delSubGraph (Graph *) [pure virtual, inherited]
Del a SubGraph of this graph. The SubGraph’s SubGraphs become SubGraphs
of the graph.
virtual edge tlp::Graph::existEdge (const node, const node) const [pure
virtual, inherited] Returns the edge if it exists an edge between two
node sens of the edge is not taken into account) If no edge is found
return an invalid edge.
virtual bool tlp::Graph::existLocalProperty (const std::string & name)
[pure virtual, inherited] Returns true if a property of that name
exists is in the graph
virtual bool tlp::Graph::existProperty (const std::string & name) [pure
virtual, inherited] Return true if a property of that name exists in
the graph or in an ancestor
template<typename ATTRIBUTETYPE > ATTRIBUTETYPE tlp::Graph::getAttribute
(const std::string & name) [inline, inherited]
deprecated version of the previous method
template<typename ATTRIBUTETYPE > bool tlp::Graph::getAttribute (const
std::string & name, ATTRIBUTETYPE & value) [inline, inherited] Get an
attribute of the graph; returns true if a value was found false if not
virtual DataSet& tlp::Graph::getAttributes () [pure virtual, inherited]
Return graph attributes.
virtual Iterator<edge>* tlp::Graph::getEdgeMetaInfo (const edge) const
[pure virtual, inherited]
Return an iterator on the underlying edges of a meta edge.
virtual Iterator<edge>* tlp::Graph::getEdges () const [pure virtual,
inherited]
Return an iterator on the edges.
Graph* tlp::Graph::getFather () const [inline, inherited] Deprecated
function, use getSuperGraph() instead.
int tlp::Graph::getId () const [inline, inherited]
Return the graph’s id, this id is unique.
virtual Iterator<edge>* tlp::Graph::getInEdges (const node) const [pure
virtual, inherited]
Return an iterator on the in--edges of a node.
virtual Iterator<std::string>* tlp::Graph::getInheritedProperties () [pure
virtual, inherited] Returns an iterator on the inherited properties
virtual node tlp::Graph::getInNode (const node, unsigned int) const [pure
virtual, inherited]
Return the ith successor of a node.
virtual Iterator<node>* tlp::Graph::getInNodes (const node) const [pure
virtual, inherited]
Return an iterator on the predecessors of a node.
virtual Iterator<edge>* tlp::Graph::getInOutEdges (const node) const [pure
virtual, inherited]
Return an iterator on the in-out-edges of a node.
virtual Iterator<node>* tlp::Graph::getInOutNodes (const node) const [pure
virtual, inherited]
Return an iterator on the neighbours of a node.
virtual Iterator<std::string>* tlp::Graph::getLocalProperties () [pure
virtual, inherited] Returns an iterator on the local properties
template<typename Proxytype > Proxytype* tlp::Graph::getLocalProperty
(const std::string & name) [inline, inherited] Returns a pointer to a
PropertyInterface which is in the pool. The real type of the
PropertyInterface is tested with the template parameter. If the
PropertyInterface is not in the pool, a new one is created and
returned. Using of delete on that property will cause a segmentation
violation (use delLocalProperty instead).
virtual Graph* tlp::Graph::getNodeMetaInfo (const node) const [pure
virtual, inherited]
Returns the underlying graph of a meta node.
virtual Iterator<node>* tlp::Graph::getNodes () const [pure virtual,
inherited]
Return an iterator on the nodes.
virtual edge tlp::Graph::getOneEdge () const [pure virtual, inherited]
Return an existing edge of the graph.
virtual node tlp::Graph::getOneNode () const [pure virtual, inherited]
Return an existing node of the graph.
virtual Iterator<edge>* tlp::Graph::getOutEdges (const node) const [pure
virtual, inherited]
Return an iterator on the out-edges of a node.
virtual node tlp::Graph::getOutNode (const node, unsigned int) const [pure
virtual, inherited]
Return the ith predecessor of a node.
virtual Iterator<node>* tlp::Graph::getOutNodes (const node) const [pure
virtual, inherited]
Return an iterator on the successors of a node.
virtual Iterator<std::string>* tlp::Graph::getProperties () [pure virtual,
inherited] Returns an iterator on all the properties
template<typename Proxytype > Proxytype* tlp::Graph::getProperty (const
std::string & name) [inline, inherited] Returns a pointer to a
PropertyInterface which is in the pool or in the pool of an ascendant
The real type of the PropertyInterface is tested with the template
parameter. If the PropertyInterface is not the pool it creates a new
one and return it. Using of delete on that property will cause a
segmentation violation (use delLocalProperty instead).
virtual Graph* tlp::Graph::getRoot () const [pure virtual, inherited]
Returns the root graph of the graph hierarchy
virtual Iterator<Graph *>* tlp::Graph::getSubGraphs () const [pure virtual,
inherited] Returns an iterator on all the SubGraphs of the graph
virtual Graph* tlp::Graph::getSuperGraph () const [pure virtual, inherited]
Returns the parent of the graph, if it has no parent (is the root
graph), it returns itself.
tlp::Graph::Graph () [inherited]
virtual unsigned int tlp::Graph::indeg (const node) const [pure virtual,
inherited]
Return indegree of a node.
virtual bool tlp::Graph::isElement (const edge) const [pure virtual,
inherited]
Return true if the edge is element of the graph.
virtual bool tlp::Graph::isElement (const node) const [pure virtual,
inherited]
Return true if the node is element of the graph.
virtual bool tlp::Graph::isMetaEdge (const edge) const [pure virtual,
inherited]
Return true if the edge is a meta edge.
virtual bool tlp::Graph::isMetaNode (const node) const [pure virtual,
inherited]
Return true if the node is a meta node.
virtual unsigned int tlp::Graph::numberOfEdges () const [pure virtual,
inherited]
Return the number of edges in the graph.
virtual unsigned int tlp::Graph::numberOfNodes () const [pure virtual,
inherited]
Return the number of nodes in the graph.
virtual node tlp::Graph::opposite (const edge, const node) const [pure
virtual, inherited]
Return the opposite node for s in the edge e.
virtual unsigned int tlp::Graph::outdeg (const node) const [pure virtual,
inherited]
Return outdegree of a node.
virtual void tlp::Graph::pop () [pure virtual, inherited]
virtual void tlp::Graph::push () [pure virtual, inherited]
void tlp::Graph::removeAttribute (const std::string & name) [inline,
inherited]
remove an existing attribute
virtual void tlp::Graph::removeEdge (const edge, const node = node())
[protected, pure virtual, inherited]
virtual void tlp::Graph::removeNode (const node) [protected, pure virtual,
inherited]
virtual void tlp::Graph::removeSubGraph (Graph *) [protected, pure virtual,
inherited]
virtual edge tlp::Graph::restoreEdge (edge, node source, node target)
[protected, pure virtual, inherited]
virtual node tlp::Graph::restoreNode (node) [protected, pure virtual,
inherited]
virtual void tlp::Graph::restoreSubGraph (Graph *, bool restoreSubGraphs =
false) [protected, pure virtual, inherited]
virtual void tlp::Graph::reverse (const edge) [pure virtual, inherited]
Reverse the direction of an edge, the source becomes the target and the
target. becomes the source. Warning : The ordering is global to the
entire graph hierarchy. Thus, by changing The ordering of a graph you
change the ordering of the hierarchy.
template<typename ATTRIBUTETYPE > void tlp::Graph::setAttribute (const
std::string & name, const ATTRIBUTETYPE & value) [inline, inherited]
Set an attribute of the graph.
virtual void tlp::Graph::setEdgeOrder (const node, const std::vector< edge
> &) [pure virtual, inherited] Set the order of the edges around a
node. This operation ensure that adjacent edges of a node will be
odered and consecutive as they are in the vector given in parameter.
void tlp::Graph::setFather (Graph * sg) [inline, inherited] Deprecated
function, use setSuperGraph() instead.
virtual void tlp::Graph::setSubGraphToKeep (Graph *) [protected, pure
virtual, inherited]
virtual void tlp::Graph::setSuperGraph (Graph *) [pure virtual, inherited]
Set the parent of a graph (use very carefully) Standard user should
never use this function.
virtual node tlp::Graph::source (const edge) const [pure virtual,
inherited]
Return the source of the edge.
virtual void tlp::Graph::swapEdgeOrder (const node, const edge, const
edge) [pure virtual, inherited] Swap two edges in the adjacent list of
a node.
virtual node tlp::Graph::target (const edge) const [pure virtual,
inherited]
Return the target of the edge.
virtual void tlp::Graph::unpop () [pure virtual, inherited]
virtual tlp::Graph::~Graph () [virtual, inherited]
Author
Generated automatically by Doxygen for Tulip Graph Library from the
source code.