Generated on Wed Apr 29 2015 11:51:41 for GGL-4.1.2 by doxygen 1.8.3.1
Public Member Functions
ggl::chem::MoleculeDecomposition::DecompositionReporter Class Referenceabstract

#include <MoleculeDecomposition.hh>

Public Member Functions

 DecompositionReporter ()
 construction More...
 
virtual void reportComponent (const MoleculeComponent &component, const size_t matchCount, const size_t matchID)=0
 
virtual void reportInteraction (const std::string &interactionDescription, const size_t matchCount)=0
 
virtual void reportMatchComplete (const bool matchComplete)=0
 
virtual void reportMatchGraph (const sgm::Graph_Interface &graph)=0
 
virtual void reportPolyPhosphate (const size_t numOfMiddlePhosphates, const size_t matchID)=0
 
virtual void reportSmallMolecule (const MoleculeComponent &smallMolecule)=0
 
virtual ~DecompositionReporter ()
 destruction More...
 

Detailed Description

Abstract class to report matched molecule components and accordingly the labeled match-graph.

Definition at line 45 of file MoleculeDecomposition.hh.

Constructor & Destructor Documentation

ggl::chem::MoleculeDecomposition::DecompositionReporter::DecompositionReporter ( )
inline

Definition at line 48 of file MoleculeDecomposition.hh.

virtual ggl::chem::MoleculeDecomposition::DecompositionReporter::~DecompositionReporter ( )
inlinevirtual

Definition at line 50 of file MoleculeDecomposition.hh.

Member Function Documentation

virtual void ggl::chem::MoleculeDecomposition::DecompositionReporter::reportComponent ( const MoleculeComponent &  component,
const size_t  matchCount,
const size_t  matchID 
)
pure virtual

Reports a component that was matched and its according ID in the final match graph

Parameters
componentthe component that was matched
matchCountthe number of matches found
matchIDthe ID of the component in the final match graph
virtual void ggl::chem::MoleculeDecomposition::DecompositionReporter::reportInteraction ( const std::string &  interactionDescription,
const size_t  matchCount 
)
pure virtual

Reports an interaction pattern that was matched

Parameters
interactionDescriptionthe interaction that was matched
matchCountthe number of matches found
virtual void ggl::chem::MoleculeDecomposition::DecompositionReporter::reportMatchComplete ( const bool  matchComplete)
pure virtual

Reports whether or not the complete graph (all nodes) were successfully mapped or not.

Parameters
matchCompletetrue, if all nodes have been mapped; false otherwise.
virtual void ggl::chem::MoleculeDecomposition::DecompositionReporter::reportMatchGraph ( const sgm::Graph_Interface &  graph)
pure virtual

Reports the final match graph where each matched component ID is given as class information of the matched nodes.

Parameters
graphthe matched graph
virtual void ggl::chem::MoleculeDecomposition::DecompositionReporter::reportPolyPhosphate ( const size_t  numOfMiddlePhosphates,
const size_t  matchID 
)
pure virtual

Reports the matching of a polyphosphate chain. Only the number and match ID of the middle phosphates is given. The end phosphate is reported as independent component.

Parameters
numOfMiddlePhosphatesthe number of middle phosphate matches found
matchIDthe ID of the component in the final match graph
virtual void ggl::chem::MoleculeDecomposition::DecompositionReporter::reportSmallMolecule ( const MoleculeComponent &  smallMolecule)
pure virtual

Reports the matching of a full small molecule.

Parameters
smallMoleculethe small molecule matched
The documentation for this class was generated from the following file: