Chemical Data Processing Library C++ API - Version 1.4.0
Public Member Functions | List of all members
CDPL::Pharm::XBondDonorFeatureGenerator Class Reference

Pharm::FeatureGenerator implementation that perceives halogen-bond donor features by matching a built-in set of SMARTS-like substructure patterns. More...

#include <XBondDonorFeatureGenerator.hpp>

+ Inheritance diagram for CDPL::Pharm::XBondDonorFeatureGenerator:

Public Member Functions

 XBondDonorFeatureGenerator ()
 Constructs the XBondDonorFeatureGenerator instance. More...
 
 XBondDonorFeatureGenerator (const Chem::MolecularGraph &molgraph, Pharmacophore &pharm)
 Perceives the halogen bond donor features of the molecular graph molgraph and adds them to the pharmacophore pharm. More...
 
- Public Member Functions inherited from CDPL::Pharm::PatternBasedFeatureGenerator
 PatternBasedFeatureGenerator ()
 Constructs the PatternBasedFeatureGenerator instance. More...
 
 PatternBasedFeatureGenerator (const PatternBasedFeatureGenerator &gen)
 Constructs a copy of the PatternBasedFeatureGenerator instance gen. More...
 
virtual ~PatternBasedFeatureGenerator ()
 Virtual destructor. More...
 
void addIncludePattern (const Chem::MolecularGraph::SharedPointer &molgraph, unsigned int type, double tol, unsigned int geom, double length=1.0)
 Appends a new feature substructure include pattern to the current set of patterns. More...
 
void addExcludePattern (const Chem::MolecularGraph::SharedPointer &molgraph)
 Appends a new feature substructure exclude pattern to the current set of patterns. More...
 
void clearIncludePatterns ()
 Clears the current set of include patterns. More...
 
void clearExcludePatterns ()
 Clears the current set of exclude patterns. More...
 
void generate (const Chem::MolecularGraph &molgraph, Pharmacophore &pharm)
 Perceives pharmacophore features according to the specified include/exclude patterns and adds them to the pharmacophore pharm. More...
 
PatternBasedFeatureGeneratoroperator= (const PatternBasedFeatureGenerator &gen)
 Replaces the current set include/exclude patterns by the patterns in the PatternBasedFeatureGenerator instance gen. More...
 
FeatureGenerator::SharedPointer clone () const
 Creates a deep copy of the PatternBasedFeatureGenerator instance. More...
 
- Public Member Functions inherited from CDPL::Pharm::FeatureGenerator
 FeatureGenerator ()
 Constructs the FeatureGenerator instance. More...
 
virtual ~FeatureGenerator ()
 Virtual destructor. More...
 
virtual void setAtom3DCoordinatesFunction (const Chem::Atom3DCoordinatesFunction &func)
 Specifies a function for the retrieval of atom 3D-coordinates. More...
 
const Chem::Atom3DCoordinatesFunctiongetAtom3DCoordinatesFunction () const
 Returns the function that was registered for the retrieval of atom 3D-coordinates. More...
 

Additional Inherited Members

- Public Types inherited from CDPL::Pharm::PatternBasedFeatureGenerator
enum  PatternAtomLabelFlag {
  FEATURE_ATOM_FLAG = 0x01 ,
  POS_REF_ATOM_FLAG = 0x02 ,
  GEOM_REF_ATOM1_FLAG = 0x04 ,
  GEOM_REF_ATOM2_FLAG = 0x08
}
 Role-flags assigned (via the atom-mapping-ID property) to atoms of feature substructure patterns added through addIncludePattern(). The flags are bit-OR-combinable so that a single pattern atom can act in several roles simultaneously. More...
 
typedef std::shared_ptr< PatternBasedFeatureGeneratorSharedPointer
 A reference-counted smart pointer [SHPTR] for dynamically allocated PatternBasedFeatureGenerator instances. More...
 
- Public Types inherited from CDPL::Pharm::FeatureGenerator
typedef std::shared_ptr< FeatureGeneratorSharedPointer
 A reference-counted smart pointer [SHPTR] for dynamically allocated FeatureGenerator instances. More...
 
- Protected Types inherited from CDPL::Pharm::PatternBasedFeatureGenerator
typedef std::vector< const Chem::Atom * > AtomList
 
- Protected Member Functions inherited from CDPL::Pharm::PatternBasedFeatureGenerator
double calcVecFeatureOrientation (const AtomList &, const AtomList &, Math::Vector3D &) const
 
bool calcPlaneFeatureOrientation (const AtomList &, Math::Vector3D &, Math::Vector3D &)
 
bool calcCentroid (const AtomList &, Math::Vector3D &) const
 
virtual void addNonPatternFeatures (const Chem::MolecularGraph &molgraph, Pharmacophore &pharm)
 
bool isContainedInIncMatchList (const Util::BitSet &) const
 
bool isContainedInExMatchList (const Util::BitSet &) const
 
- Protected Member Functions inherited from CDPL::Pharm::FeatureGenerator
 FeatureGenerator (const FeatureGenerator &gen)
 Constructs a copy of the FeatureGenerator instance gen. More...
 
FeatureGeneratoroperator= (const FeatureGenerator &gen)
 Copy assignment operator. More...
 

Detailed Description

Pharm::FeatureGenerator implementation that perceives halogen-bond donor features by matching a built-in set of SMARTS-like substructure patterns.

Constructor & Destructor Documentation

◆ XBondDonorFeatureGenerator() [1/2]

CDPL::Pharm::XBondDonorFeatureGenerator::XBondDonorFeatureGenerator ( )

Constructs the XBondDonorFeatureGenerator instance.

◆ XBondDonorFeatureGenerator() [2/2]

CDPL::Pharm::XBondDonorFeatureGenerator::XBondDonorFeatureGenerator ( const Chem::MolecularGraph molgraph,
Pharmacophore pharm 
)

Perceives the halogen bond donor features of the molecular graph molgraph and adds them to the pharmacophore pharm.

Parameters
molgraphThe molecular graph for which to perceive the features.
pharmThe output pharmacophore where to add the generated features.

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