sgm::GraphScaffold::RR_Annotation Class Reference

#include <GraphScaffold.hh>

Inheritance diagram for sgm::GraphScaffold::RR_Annotation:

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)
	RR_Annotation (ScaffoldAnnotation &annotation, RingReporter *nextReporter=NULL)
virtual	~RR_Annotation ()

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

Protected Attributes
ScaffoldAnnotation &	annotation
	the annotation to update with ring information More...
RingReporter *	nextReporter
	the next reporter to forward the ring information to if not NULL More...

Detailed Description

Ring reporter that stores ring annotations and forwards the reporting to another ring reporter if given.

Definition at line 116 of file GraphScaffold.hh.

Member Typedef Documentation

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

inherited

Definition at line 27 of file RingReporter.hh.

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

inherited

Definition at line 25 of file RingReporter.hh.

Constructor & Destructor Documentation

sgm::GraphScaffold::RR_Annotation::RR_Annotation ( ScaffoldAnnotation &  annotation, RingReporter *  nextReporter = NULL  )

inline

Constructions

Parameters

annotation	the annotation to update with ring information
nextReporter	the next reporter to forward the ring information to if not NULL

Definition at line 133 of file GraphScaffold.hh.

virtual sgm::GraphScaffold::RR_Annotation::~RR_Annotation ( )

inlinevirtual

Definition at line 140 of file GraphScaffold.hh.

Member Function Documentation

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

virtual

Nodes of the reported ring are accordingly annotated and the ring information is forwarded to the next ring reporter

Parameters

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

Implements sgm::RingReporter.

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

staticinherited

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

Field Documentation

ScaffoldAnnotation& sgm::GraphScaffold::RR_Annotation::annotation

protected

Definition at line 121 of file GraphScaffold.hh.

RingReporter* sgm::GraphScaffold::RR_Annotation::nextReporter

protected

Definition at line 123 of file GraphScaffold.hh.

---

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

• src/sgm/GraphScaffold.hh