RDKit
Open-source cheminformatics and machine learning.
Loading...
Searching...
No Matches
RDKit::v1::MolSupplier Class Reference

#include <MolSupplier.v1API.h>

Inheritance diagram for RDKit::v1::MolSupplier:
RDKit::v1::ForwardSDMolSupplier RDKit::v1::SmilesMolSupplier RDKit::v1::TDTMolSupplier RDKit::v1::SDMolSupplier

Public Member Functions

 MolSupplier ()
 
virtual ~MolSupplier ()
 
void init ()
 
void reset ()
 
bool atEnd ()
 
ROMolnext ()
 
virtual void close ()
 

Protected Attributes

std::unique_ptr< v2::FileParsers::MolSupplierdp_supplier
 

Detailed Description

Here are a couple of ways one can interact with MolSuppliers:

1) Lazy (ForwardIterator): while(!supplier.atEnd()){ ROMol *mol = supplier.next(); if(mol){ do something; } } 2) Random Access: for(int i=0;i<supplier.length();i++){ ROMol *mol = supplier[i]; if(mol){ do something; } }

Definition at line 36 of file MolSupplier.v1API.h.

Constructor & Destructor Documentation

◆ MolSupplier()

RDKit::v1::MolSupplier::MolSupplier ( )
inline

Definition at line 39 of file MolSupplier.v1API.h.

◆ ~MolSupplier()

virtual RDKit::v1::MolSupplier::~MolSupplier ( )
inlinevirtual

Definition at line 40 of file MolSupplier.v1API.h.

Member Function Documentation

◆ atEnd()

bool RDKit::v1::MolSupplier::atEnd ( )
inline

Definition at line 52 of file MolSupplier.v1API.h.

◆ close()

virtual void RDKit::v1::MolSupplier::close ( )
inlinevirtual

Definition at line 63 of file MolSupplier.v1API.h.

◆ init()

void RDKit::v1::MolSupplier::init ( )
inline

Definition at line 41 of file MolSupplier.v1API.h.

◆ next()

ROMol * RDKit::v1::MolSupplier::next ( )
inline

Definition at line 58 of file MolSupplier.v1API.h.

References PRECONDITION.

◆ reset()

void RDKit::v1::MolSupplier::reset ( )
inline

Definition at line 46 of file MolSupplier.v1API.h.

Member Data Documentation

◆ dp_supplier

std::unique_ptr<v2::FileParsers::MolSupplier> RDKit::v1::MolSupplier::dp_supplier
protected

Definition at line 78 of file MolSupplier.v1API.h.


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