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

A class for the creation of optimized pharmacophore screening databases. More...

#include <PSDScreeningDBCreator.hpp>

+ Inheritance diagram for CDPL::Pharm::PSDScreeningDBCreator:

Public Types

typedef std::shared_ptr< PSDScreeningDBCreatorSharedPointer
 
- Public Types inherited from CDPL::Pharm::ScreeningDBCreator
enum  Mode {
  CREATE,
  UPDATE,
  APPEND
}
 
typedef std::shared_ptr< ScreeningDBCreatorSharedPointer
 
typedef std::function< bool(double)> ProgressCallbackFunction
 

Public Member Functions

 PSDScreeningDBCreator ()
 
 PSDScreeningDBCreator (const std::string &name, Mode mode=CREATE, bool allow_dup_entries=true)
 Constructs a PSDScreeningDBCreator instance that will write data to the database-file specified by name in the given insert mode. More...
 
 ~PSDScreeningDBCreator ()
 Destructor. More...
 
void open (const std::string &name, Mode mode=CREATE, bool allow_dup_entries=true)
 
void close ()
 
Mode getMode () const
 
bool allowDuplicateEntries () const
 
bool process (const Chem::MolecularGraph &molgraph)
 
bool merge (const ScreeningDBAccessor &db_acc, const ProgressCallbackFunction &func)
 
const std::string & getDatabaseName () const
 
std::size_t getNumProcessed () const
 
std::size_t getNumRejected () const
 
std::size_t getNumDeleted () const
 
std::size_t getNumInserted () const
 
- Public Member Functions inherited from CDPL::Pharm::ScreeningDBCreator
virtual ~ScreeningDBCreator ()
 Virtual destructor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from CDPL::Pharm::ScreeningDBCreator
ScreeningDBCreatoroperator= (const ScreeningDBCreator &)
 

Detailed Description

A class for the creation of optimized pharmacophore screening databases.

Member Typedef Documentation

◆ SharedPointer

Constructor & Destructor Documentation

◆ PSDScreeningDBCreator() [1/2]

CDPL::Pharm::PSDScreeningDBCreator::PSDScreeningDBCreator ( )

◆ PSDScreeningDBCreator() [2/2]

CDPL::Pharm::PSDScreeningDBCreator::PSDScreeningDBCreator ( const std::string &  name,
Mode  mode = CREATE,
bool  allow_dup_entries = true 
)

Constructs a PSDScreeningDBCreator instance that will write data to the database-file specified by name in the given insert mode.

Parameters
nameThe name of the database-file.
modeSpecifies whether to (re)create the database or to update/append to existing records.
allow_dup_entriesSpecifies whether input molecules that are duplicates of already stored molecules should be discarded.

◆ ~PSDScreeningDBCreator()

CDPL::Pharm::PSDScreeningDBCreator::~PSDScreeningDBCreator ( )

Destructor.

Member Function Documentation

◆ open()

void CDPL::Pharm::PSDScreeningDBCreator::open ( const std::string &  name,
Mode  mode = CREATE,
bool  allow_dup_entries = true 
)
virtual

◆ close()

void CDPL::Pharm::PSDScreeningDBCreator::close ( )
virtual

◆ getMode()

Mode CDPL::Pharm::PSDScreeningDBCreator::getMode ( ) const
virtual

◆ allowDuplicateEntries()

bool CDPL::Pharm::PSDScreeningDBCreator::allowDuplicateEntries ( ) const
virtual

◆ process()

bool CDPL::Pharm::PSDScreeningDBCreator::process ( const Chem::MolecularGraph molgraph)
virtual

◆ merge()

bool CDPL::Pharm::PSDScreeningDBCreator::merge ( const ScreeningDBAccessor db_acc,
const ProgressCallbackFunction func 
)
virtual

◆ getDatabaseName()

const std::string& CDPL::Pharm::PSDScreeningDBCreator::getDatabaseName ( ) const
virtual

◆ getNumProcessed()

std::size_t CDPL::Pharm::PSDScreeningDBCreator::getNumProcessed ( ) const
virtual

◆ getNumRejected()

std::size_t CDPL::Pharm::PSDScreeningDBCreator::getNumRejected ( ) const
virtual

◆ getNumDeleted()

std::size_t CDPL::Pharm::PSDScreeningDBCreator::getNumDeleted ( ) const
virtual

◆ getNumInserted()

std::size_t CDPL::Pharm::PSDScreeningDBCreator::getNumInserted ( ) const
virtual

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