sgm::RingReporter Class Reference

Interface to report found rings. More...

#include <RingReporter.hh>

Inheritance diagram for sgm::RingReporter:

Public Types
typedef std::list< size_t >	RingList
	type of a list of node indices that form a ring More...
typedef std::set< size_t >	RingNodes
	type of a set of node indices that form a ring More...

Public Member Functions
virtual void	reportRing (const Graph_Interface &graph, const RingList &ringList)=0
	RingReporter ()
	construction More...
virtual	~RingReporter ()
	destruction More...

Static Public Member Functions
static RingNodes	toRing (const Graph_Interface &graph, const RingList &ringList)

Detailed Description

    Abstract class that describes the interface to report rings in graphs.
    Thus the interface is used by sgm::RingPerception to report found
    rings.

Author

Martin Mann - 2010 - http://www.bioinf.uni-freiburg.de/~mmann/

Definition at line 20 of file RingReporter.hh.

Member Typedef Documentation

typedef std::list<size_t> sgm::RingReporter::RingList

Definition at line 27 of file RingReporter.hh.

typedef std::set<size_t> sgm::RingReporter::RingNodes

Definition at line 25 of file RingReporter.hh.

Constructor & Destructor Documentation

sgm::RingReporter::RingReporter

(

)

virtual sgm::RingReporter::~RingReporter ( )

virtual

Member Function Documentation

virtual void sgm::RingReporter::reportRing ( const Graph_Interface &  graph, const RingList &  ringList  )

pure virtual

Is called to report a ring.

Parameters

graph	the graph that contains the ring
ringList	the ring to report

Implemented in ggl::chem::MoleculeDecomposition, ggl::chem::AromaticityPerception, sgm::RP_Hanser96::LoopBondReporter, and sgm::GraphScaffold::RR_Annotation.

static RingNodes sgm::RingReporter::toRing ( const Graph_Interface &  graph, const RingList &  ringList  )

static

Utility class that converts a RingList, i.e. a list of nodes when traversing a ring within a graph, into the set of nodes that form the ring.

Parameters

graph	the graph that contains the ring
ringList	the ring list to convert

Returns

the list of nodes traversing the ring

---

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

• src/sgm/RingReporter.hh