Chemical Data Processing Library C++ API - Version 1.1.1
Classes | Public Types | Public Member Functions | List of all members
CDPL::Chem::PatternAtomTyper Class Reference

PatternAtomTyper. More...

#include <PatternAtomTyper.hpp>

Classes

class  Pattern
 

Public Types

typedef std::shared_ptr< PatternAtomTyperSharedPointer
 
typedef PatternList::const_iterator ConstPatternIterator
 
typedef PatternList::iterator PatternIterator
 

Public Member Functions

 PatternAtomTyper ()
 
 PatternAtomTyper (const PatternAtomTyper &typer)
 
void addPattern (const MolecularGraph::SharedPointer &structure, std::size_t atom_label=0, std::size_t priority=0, bool all_matches=true, bool unique_matches=false)
 
void addPattern (const Pattern &ptn)
 
const PatterngetPattern (std::size_t idx) const
 
void removePattern (std::size_t idx)
 
void removePattern (const PatternIterator &ptn_it)
 
void clear ()
 
std::size_t getNumPatterns () const
 
ConstPatternIterator getPatternsBegin () const
 
ConstPatternIterator getPatternsEnd () const
 
PatternIterator getPatternsBegin ()
 
PatternIterator getPatternsEnd ()
 
ConstPatternIterator begin () const
 
ConstPatternIterator end () const
 
PatternIterator begin ()
 
PatternIterator end ()
 
bool hasAtomLabel (std::size_t idx) const
 
std::size_t getAtomLabel (std::size_t idx) const
 
std::size_t getPatternIndex (std::size_t idx) const
 
void execute (const MolecularGraph &molgraph)
 
PatternAtomTyperoperator= (const PatternAtomTyper &typer)
 

Detailed Description

PatternAtomTyper.

Member Typedef Documentation

◆ SharedPointer

◆ ConstPatternIterator

typedef PatternList::const_iterator CDPL::Chem::PatternAtomTyper::ConstPatternIterator

◆ PatternIterator

typedef PatternList::iterator CDPL::Chem::PatternAtomTyper::PatternIterator

Constructor & Destructor Documentation

◆ PatternAtomTyper() [1/2]

CDPL::Chem::PatternAtomTyper::PatternAtomTyper ( )

◆ PatternAtomTyper() [2/2]

CDPL::Chem::PatternAtomTyper::PatternAtomTyper ( const PatternAtomTyper typer)

Member Function Documentation

◆ addPattern() [1/2]

void CDPL::Chem::PatternAtomTyper::addPattern ( const MolecularGraph::SharedPointer structure,
std::size_t  atom_label = 0,
std::size_t  priority = 0,
bool  all_matches = true,
bool  unique_matches = false 
)

◆ addPattern() [2/2]

void CDPL::Chem::PatternAtomTyper::addPattern ( const Pattern ptn)

◆ getPattern()

const Pattern& CDPL::Chem::PatternAtomTyper::getPattern ( std::size_t  idx) const

◆ removePattern() [1/2]

void CDPL::Chem::PatternAtomTyper::removePattern ( std::size_t  idx)

◆ removePattern() [2/2]

void CDPL::Chem::PatternAtomTyper::removePattern ( const PatternIterator ptn_it)

◆ clear()

void CDPL::Chem::PatternAtomTyper::clear ( )

◆ getNumPatterns()

std::size_t CDPL::Chem::PatternAtomTyper::getNumPatterns ( ) const

◆ getPatternsBegin() [1/2]

ConstPatternIterator CDPL::Chem::PatternAtomTyper::getPatternsBegin ( ) const

◆ getPatternsEnd() [1/2]

ConstPatternIterator CDPL::Chem::PatternAtomTyper::getPatternsEnd ( ) const

◆ getPatternsBegin() [2/2]

PatternIterator CDPL::Chem::PatternAtomTyper::getPatternsBegin ( )

◆ getPatternsEnd() [2/2]

PatternIterator CDPL::Chem::PatternAtomTyper::getPatternsEnd ( )

◆ begin() [1/2]

ConstPatternIterator CDPL::Chem::PatternAtomTyper::begin ( ) const

◆ end() [1/2]

ConstPatternIterator CDPL::Chem::PatternAtomTyper::end ( ) const

◆ begin() [2/2]

PatternIterator CDPL::Chem::PatternAtomTyper::begin ( )

◆ end() [2/2]

PatternIterator CDPL::Chem::PatternAtomTyper::end ( )

◆ hasAtomLabel()

bool CDPL::Chem::PatternAtomTyper::hasAtomLabel ( std::size_t  idx) const

◆ getAtomLabel()

std::size_t CDPL::Chem::PatternAtomTyper::getAtomLabel ( std::size_t  idx) const

◆ getPatternIndex()

std::size_t CDPL::Chem::PatternAtomTyper::getPatternIndex ( std::size_t  idx) const

◆ execute()

void CDPL::Chem::PatternAtomTyper::execute ( const MolecularGraph molgraph)

◆ operator=()

PatternAtomTyper& CDPL::Chem::PatternAtomTyper::operator= ( const PatternAtomTyper typer)

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