 |
Chemical Data Processing Library C++ API - Version 1.4.0
|
|
Chemical Data Processing Library C++ API - Version 1.4.0
|
Declaration of functions that operate on Chem::Reaction instances. More...
#include <cstddef>#include <cstdint>#include <ctime>#include <string>#include "CDPL/Chem/APIPrefix.hpp"#include "CDPL/Chem/Molecule.hpp"#include "CDPL/Chem/MatchExpression.hpp"#include "CDPL/Chem/MatchConstraintList.hpp"#include "CDPL/Chem/FragmentList.hpp"#include "CDPL/Chem/AtomMapping.hpp"#include "CDPL/Chem/StringDataBlock.hpp"#include "CDPL/Chem/ReactionRole.hpp"#include "CDPL/Chem/AtomPropertyFlag.hpp"#include "CDPL/Chem/BondPropertyFlag.hpp"Go to the source code of this file.
Namespaces | |
| CDPL | |
| The namespace of the Chemical Data Processing Library. | |
| CDPL::Chem | |
| Contains classes and functions related to chemistry. | |
Functions | |
| CDPL_CHEM_API const std::string & | CDPL::Chem::getName (const Reaction &rxn) |
| Returns the value of the Chem::ReactionProperty::NAME property of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setName (Reaction &rxn, const std::string &name) |
| Sets the Chem::ReactionProperty::NAME property of rxn to name. More... | |
| CDPL_CHEM_API void | CDPL::Chem::clearName (Reaction &rxn) |
| Removes the Chem::ReactionProperty::NAME property from rxn. More... | |
| CDPL_CHEM_API bool | CDPL::Chem::hasName (const Reaction &rxn) |
| Tells whether rxn carries the Chem::ReactionProperty::NAME property. More... | |
| CDPL_CHEM_API std::time_t | CDPL::Chem::getTimestamp (const Reaction &rxn) |
| Returns the value of the Chem::ReactionProperty::TIMESTAMP property of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setTimestamp (Reaction &rxn, std::time_t time) |
| Sets the Chem::ReactionProperty::TIMESTAMP property of rxn to time. More... | |
| CDPL_CHEM_API void | CDPL::Chem::clearTimestamp (Reaction &rxn) |
| Removes the Chem::ReactionProperty::TIMESTAMP property from rxn. More... | |
| CDPL_CHEM_API bool | CDPL::Chem::hasTimestamp (const Reaction &rxn) |
| Tells whether rxn carries the Chem::ReactionProperty::TIMESTAMP property. More... | |
| CDPL_CHEM_API const std::string & | CDPL::Chem::getComment (const Reaction &rxn) |
| Returns the value of the Chem::ReactionProperty::COMMENT property of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setComment (Reaction &rxn, const std::string &comment) |
| Sets the Chem::ReactionProperty::COMMENT property of rxn to comment. More... | |
| CDPL_CHEM_API void | CDPL::Chem::clearComment (Reaction &rxn) |
| Removes the Chem::ReactionProperty::COMMENT property from rxn. More... | |
| CDPL_CHEM_API bool | CDPL::Chem::hasComment (const Reaction &rxn) |
| Tells whether rxn carries the Chem::ReactionProperty::COMMENT property. More... | |
| CDPL_CHEM_API const MatchExpression< Reaction >::SharedPointer & | CDPL::Chem::getMatchExpression (const Reaction &rxn) |
| Returns the value of the Chem::ReactionProperty::MATCH_EXPRESSION property of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setMatchExpression (Reaction &rxn, const MatchExpression< Reaction >::SharedPointer &expr) |
| Sets the Chem::ReactionProperty::MATCH_EXPRESSION property of rxn to expr. More... | |
| CDPL_CHEM_API void | CDPL::Chem::clearMatchExpression (Reaction &rxn) |
| Removes the Chem::ReactionProperty::MATCH_EXPRESSION property from rxn. More... | |
| CDPL_CHEM_API bool | CDPL::Chem::hasMatchExpression (const Reaction &rxn) |
| Tells whether rxn carries the Chem::ReactionProperty::MATCH_EXPRESSION property. More... | |
| CDPL_CHEM_API MatchExpression< Reaction >::SharedPointer | CDPL::Chem::generateMatchExpression (const Reaction &rxn) |
| Builds a reaction-level match expression from the constraints currently attached to rxn and returns it without modifying rxn. More... | |
| CDPL_CHEM_API MatchExpression< Reaction >::SharedPointer | CDPL::Chem::generateMatchExpression (Reaction &rxn, bool overwrite) |
| Builds and (optionally) stores the reaction-level match expression of rxn. More... | |
| CDPL_CHEM_API const MatchConstraintList::SharedPointer & | CDPL::Chem::getMatchConstraints (const Reaction &rxn) |
| Returns the value of the Chem::ReactionProperty::MATCH_CONSTRAINTS property of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setMatchConstraints (Reaction &rxn, const MatchConstraintList::SharedPointer &constr) |
| Sets the Chem::ReactionProperty::MATCH_CONSTRAINTS property of rxn to constr. More... | |
| CDPL_CHEM_API void | CDPL::Chem::clearMatchConstraints (Reaction &rxn) |
| Removes the Chem::ReactionProperty::MATCH_CONSTRAINTS property from rxn. More... | |
| CDPL_CHEM_API bool | CDPL::Chem::hasMatchConstraints (const Reaction &rxn) |
| Tells whether rxn carries the Chem::ReactionProperty::MATCH_CONSTRAINTS property. More... | |
| CDPL_CHEM_API const FragmentList::SharedPointer & | CDPL::Chem::getComponentGroups (const Reaction &rxn) |
| Returns the value of the Chem::ReactionProperty::COMPONENT_GROUPS property of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setComponentGroups (Reaction &rxn, const FragmentList::SharedPointer &comp_groups) |
| Sets the Chem::ReactionProperty::COMPONENT_GROUPS property of rxn to comp_groups. More... | |
| CDPL_CHEM_API void | CDPL::Chem::clearComponentGroups (Reaction &rxn) |
| Removes the Chem::ReactionProperty::COMPONENT_GROUPS property from rxn. More... | |
| CDPL_CHEM_API bool | CDPL::Chem::hasComponentGroups (const Reaction &rxn) |
| Tells whether rxn carries the Chem::ReactionProperty::COMPONENT_GROUPS property. More... | |
| CDPL_CHEM_API FragmentList::SharedPointer | CDPL::Chem::perceiveComponentGroups (const Reaction &rxn) |
| Perceives the component groups of rxn without modifying it. More... | |
| CDPL_CHEM_API FragmentList::SharedPointer | CDPL::Chem::perceiveComponentGroups (Reaction &rxn, bool overwrite) |
| Perceives and (optionally) stores the component groups of rxn. More... | |
| CDPL_CHEM_API const AtomMapping::SharedPointer & | CDPL::Chem::getAtomMapping (const Reaction &rxn) |
| Returns the value of the Chem::ReactionProperty::ATOM_MAPPING property of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setAtomMapping (Reaction &rxn, const AtomMapping::SharedPointer &mapping) |
| Sets the Chem::ReactionProperty::ATOM_MAPPING property of rxn to mapping. More... | |
| CDPL_CHEM_API void | CDPL::Chem::clearAtomMapping (Reaction &rxn) |
| Removes the Chem::ReactionProperty::ATOM_MAPPING property from rxn. More... | |
| CDPL_CHEM_API bool | CDPL::Chem::hasAtomMapping (const Reaction &rxn) |
| Tells whether rxn carries the Chem::ReactionProperty::ATOM_MAPPING property. More... | |
| CDPL_CHEM_API AtomMapping::SharedPointer | CDPL::Chem::perceiveAtomMapping (const Reaction &rxn) |
| Derives the reactant-to-product atom mapping from the atom mapping IDs of rxn without modifying it. More... | |
| CDPL_CHEM_API AtomMapping::SharedPointer | CDPL::Chem::perceiveAtomMapping (Reaction &rxn, bool overwrite) |
| Derives and (optionally) stores the reactant-to-product atom mapping of rxn. More... | |
| CDPL_CHEM_API bool | CDPL::Chem::generateSMILES (const Reaction &rxn, std::string &smiles, bool canonical=false, bool ord_h_deplete=true, unsigned int atom_flags=AtomPropertyFlag::DEFAULT, unsigned int bond_flags=BondPropertyFlag::DEFAULT) |
| Generates a reaction SMILES string for rxn. More... | |
| CDPL_CHEM_API std::uint64_t | CDPL::Chem::calcHashCode (const Reaction &rxn, unsigned int role_mask=ReactionRole::ALL, unsigned int atom_flags=AtomPropertyFlag::DEFAULT, unsigned int bond_flags=BondPropertyFlag::DEFAULT, bool ord_h_deplete=true) |
| Computes a 64-bit hash code for rxn taking into account the specified reaction roles and atom/bond properties. More... | |
| CDPL_CHEM_API const std::string & | CDPL::Chem::getMDLUserInitials (const Reaction &rxn) |
| Returns the value of the Chem::ReactionProperty::MDL_USER_INITIALS property of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setMDLUserInitials (Reaction &rxn, const std::string &initials) |
| Sets the Chem::ReactionProperty::MDL_USER_INITIALS property of rxn to initials. More... | |
| CDPL_CHEM_API void | CDPL::Chem::clearMDLUserInitials (Reaction &rxn) |
| Removes the Chem::ReactionProperty::MDL_USER_INITIALS property from rxn. More... | |
| CDPL_CHEM_API bool | CDPL::Chem::hasMDLUserInitials (const Reaction &rxn) |
| Tells whether rxn carries the Chem::ReactionProperty::MDL_USER_INITIALS property. More... | |
| CDPL_CHEM_API const std::string & | CDPL::Chem::getMDLProgramName (const Reaction &rxn) |
| Returns the value of the Chem::ReactionProperty::MDL_PROGRAM_NAME property of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setMDLProgramName (Reaction &rxn, const std::string &name) |
| Sets the Chem::ReactionProperty::MDL_PROGRAM_NAME property of rxn to name. More... | |
| CDPL_CHEM_API void | CDPL::Chem::clearMDLProgramName (Reaction &rxn) |
| Removes the Chem::ReactionProperty::MDL_PROGRAM_NAME property from rxn. More... | |
| CDPL_CHEM_API bool | CDPL::Chem::hasMDLProgramName (const Reaction &rxn) |
| Tells whether rxn carries the Chem::ReactionProperty::MDL_PROGRAM_NAME property. More... | |
| CDPL_CHEM_API std::size_t | CDPL::Chem::getMDLRegistryNumber (const Reaction &rxn) |
| Returns the value of the Chem::ReactionProperty::MDL_REGISTRY_NUMBER property of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setMDLRegistryNumber (Reaction &rxn, std::size_t reg_no) |
| Sets the Chem::ReactionProperty::MDL_REGISTRY_NUMBER property of rxn to reg_no. More... | |
| CDPL_CHEM_API void | CDPL::Chem::clearMDLRegistryNumber (Reaction &rxn) |
| Removes the Chem::ReactionProperty::MDL_REGISTRY_NUMBER property from rxn. More... | |
| CDPL_CHEM_API bool | CDPL::Chem::hasMDLRegistryNumber (const Reaction &rxn) |
| Tells whether rxn carries the Chem::ReactionProperty::MDL_REGISTRY_NUMBER property. More... | |
| CDPL_CHEM_API const StringDataBlock::SharedPointer & | CDPL::Chem::getReactionData (const Reaction &rxn) |
| Returns the value of the Chem::ReactionProperty::REACTION_DATA property of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setReactionData (Reaction &rxn, const StringDataBlock::SharedPointer &data) |
| Sets the Chem::ReactionProperty::REACTION_DATA property of rxn to data. More... | |
| CDPL_CHEM_API void | CDPL::Chem::clearReactionData (Reaction &rxn) |
| Removes the Chem::ReactionProperty::REACTION_DATA property from rxn. More... | |
| CDPL_CHEM_API bool | CDPL::Chem::hasReactionData (const Reaction &rxn) |
| Tells whether rxn carries the Chem::ReactionProperty::REACTION_DATA property. More... | |
| CDPL_CHEM_API const Molecule::SharedPointer & | CDPL::Chem::getMDLMoleculeRecord (const Reaction &rxn) |
| Returns the value of the Chem::ReactionProperty::MDL_MOLECULE_RECORD property of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setMDLMoleculeRecord (Reaction &rxn, const Molecule::SharedPointer &mol_rec) |
| Sets the Chem::ReactionProperty::MDL_MOLECULE_RECORD property of rxn to mol_rec. More... | |
| CDPL_CHEM_API void | CDPL::Chem::clearMDLMoleculeRecord (Reaction &rxn) |
| Removes the Chem::ReactionProperty::MDL_MOLECULE_RECORD property from rxn. More... | |
| CDPL_CHEM_API bool | CDPL::Chem::hasMDLMoleculeRecord (const Reaction &rxn) |
| Tells whether rxn carries the Chem::ReactionProperty::MDL_MOLECULE_RECORD property. More... | |
| CDPL_CHEM_API const std::string & | CDPL::Chem::getMDLInternalRegistryNumber (const Reaction &rxn) |
| Returns the value of the Chem::ReactionProperty::MDL_INTERNAL_REGISTRY_NUMBER property of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setMDLInternalRegistryNumber (Reaction &rxn, const std::string ®_no) |
| Sets the Chem::ReactionProperty::MDL_INTERNAL_REGISTRY_NUMBER property of rxn to reg_no. More... | |
| CDPL_CHEM_API void | CDPL::Chem::clearMDLInternalRegistryNumber (Reaction &rxn) |
| Removes the Chem::ReactionProperty::MDL_INTERNAL_REGISTRY_NUMBER property from rxn. More... | |
| CDPL_CHEM_API bool | CDPL::Chem::hasMDLInternalRegistryNumber (const Reaction &rxn) |
| Tells whether rxn carries the Chem::ReactionProperty::MDL_INTERNAL_REGISTRY_NUMBER property. More... | |
| CDPL_CHEM_API const std::string & | CDPL::Chem::getMDLExternalRegistryNumber (const Reaction &rxn) |
| Returns the value of the Chem::ReactionProperty::MDL_EXTERNAL_REGISTRY_NUMBER property of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setMDLExternalRegistryNumber (Reaction &rxn, const std::string ®_no) |
| Sets the Chem::ReactionProperty::MDL_EXTERNAL_REGISTRY_NUMBER property of rxn to reg_no. More... | |
| CDPL_CHEM_API void | CDPL::Chem::clearMDLExternalRegistryNumber (Reaction &rxn) |
| Removes the Chem::ReactionProperty::MDL_EXTERNAL_REGISTRY_NUMBER property from rxn. More... | |
| CDPL_CHEM_API bool | CDPL::Chem::hasMDLExternalRegistryNumber (const Reaction &rxn) |
| Tells whether rxn carries the Chem::ReactionProperty::MDL_EXTERNAL_REGISTRY_NUMBER property. More... | |
| CDPL_CHEM_API unsigned int | CDPL::Chem::getMDLRXNFileVersion (const Reaction &rxn) |
| Returns the value of the Chem::ReactionProperty::MDL_RXN_FILE_VERSION property of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setMDLRXNFileVersion (Reaction &rxn, unsigned int version) |
| Sets the Chem::ReactionProperty::MDL_RXN_FILE_VERSION property of rxn to version. More... | |
| CDPL_CHEM_API void | CDPL::Chem::clearMDLRXNFileVersion (Reaction &rxn) |
| Removes the Chem::ReactionProperty::MDL_RXN_FILE_VERSION property from rxn. More... | |
| CDPL_CHEM_API bool | CDPL::Chem::hasMDLRXNFileVersion (const Reaction &rxn) |
| Tells whether rxn carries the Chem::ReactionProperty::MDL_RXN_FILE_VERSION property. More... | |
| CDPL_CHEM_API std::size_t | CDPL::Chem::getMaxComponentGroupID (const Reaction &rxn) |
| Returns the largest component-group ID found on any of the components of rxn. More... | |
| CDPL_CHEM_API std::size_t | CDPL::Chem::getMaxAtomMappingID (const Reaction &rxn) |
| Returns the largest atom-mapping ID found on any of the atoms in rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setAtomMatchConstraints (Reaction &rxn, const MatchConstraintList::SharedPointer &constr, bool overwrite) |
| Sets the atom-level match-constraint list constr on every atom of every component of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setBondMatchConstraints (Reaction &rxn, const MatchConstraintList::SharedPointer &constr, bool overwrite) |
| Sets the bond-level match-constraint list constr on every bond of every component of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::setComponentMatchConstraints (Reaction &rxn, const MatchConstraintList::SharedPointer &constr, bool overwrite) |
| Sets the molecular graph-level match-constraint list constr on every component of rxn. More... | |
| CDPL_CHEM_API void | CDPL::Chem::generateMatchExpressions (Reaction &rxn, bool overwrite) |
| Generates and stores match expressions for the atoms, bonds, components, and rxn itself. More... | |
| CDPL_CHEM_API void | CDPL::Chem::initSubstructureSearchQuery (Reaction &rxn, bool overwrite) |
| Prepares rxn for use as a substructure search query (e.g. by pre-computing match expressions and required cached properties). More... | |
| CDPL_CHEM_API void | CDPL::Chem::initSubstructureSearchTarget (Reaction &rxn, bool overwrite) |
| Prepares rxn for use as a substructure search target (e.g. by pre-computing required cached properties). More... | |
| CDPL_CHEM_API void | CDPL::Chem::calcBasicProperties (Reaction &rxn, bool overwrite) |
| Computes the basic per-component properties (aromaticity, ring info, etc.) of every component of rxn. More... | |
Declaration of functions that operate on Chem::Reaction instances.
1.9.1