Rosetta
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::drug_design::ReactionMultiTransform Class Reference

#include <ReactionMultiTransform.hh>

Inheritance diagram for protocols::drug_design::ReactionMultiTransform:
Inheritance graph
[legend]

Public Member Functions

 ReactionMultiTransform ()
 
void apply (core::chemical::MutableResidueType &) override
 Modify the passed ResidueType. More...
 
bool has_additional_output () const override
 Are there alternate ResidueTypes which are availible from the last time we called apply? (That is, will get_addtional_output() return non-null?) More...
 
core::chemical::MutableResidueTypeOP get_additional_output () override
 Get additional generated ResidueTypes, if any. More...
 
core::chemical::VDVDMapping get_mapping () const override
 Get the vertex mapping that was used for the last apply() or get_additional_output() This is a mapping FROM the vds in the BEFORE MutableResidueType TO the vds in the AFTER MutableResidueType. The base class implementation defaults to an identity mapping. More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &datacache) override
 Initialize any data members of this instance from an input tag and a DataMap object. More...
 
void add_reaction (::RDKit::ChemicalReactionOP rxn, core::Real weight) override
 Add a reaction to the list of reactions to use. Reaction should be written in the synthetic direction with a single reactant and product. More...
 
- Public Member Functions inherited from protocols::drug_design::ReactionChemistry
 ReactionChemistry (std::string const &type)
 
virtual void reaction_file (std::string filename, bool append=false)
 The file which contains the reactions which to use. More...
 
void prefilter_reactions (utility::vector1< ::RDKit::ROMolOP > const &reactants, bool exclude_first=true)
 Filter reaction list for those compatible with the given reactants. More...
 
- Public Member Functions inherited from protocols::chemistries::Chemistry
 Chemistry (std::string const &name)
 
virtual void apply (core::chemical::MutableResidueType &restype, core::pose::Pose const &)
 Modify the passed ResidueType, context sensitive. More...
 
- Public Member Functions inherited from core::chemical::modifications::ChemistryBase
 ChemistryBase (std::string const &name)
 
std::string name () const
 Return the name of this Chemistry object. More...
 
ChemistryStatus get_last_status () const
 What was the status of the last call to apply()/get_additional_output() More...
 
void set_last_status (ChemistryStatus setting)
 Set the status of the chemistry object. More...
 

Static Public Member Functions

static std::string class_name ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 

Private Attributes

::RDKit::RWMolOP rdmol_
 The converted input (needed for correspondance mapping of products) More...
 
core::chemical::VDIndexMapping input_map_
 The mapping of input VD to rdmol_ index (needed for correspondance mapping of products) More...
 
core::chemical::MutableResidueTypeOP ref_restype_
 A copy of the input residue type to apply(), for use in converting the output. More...
 
utility::vector1< ::RDKit::RWMolOPproducts_
 The products generated by the last call to apply() More...
 
core::Size last_product_
 The last product returned by apply()/get_additional_output() More...
 
core::chemical::VDVDMapping mapping_
 The main Input->Output mapping for ResidueTypes. More...
 

Additional Inherited Members

- Protected Member Functions inherited from protocols::drug_design::ReactionChemistry
void filter_reactions (::RDKit::ROMol const &rdmol, utility::vector1< ::RDKit::ChemicalReactionOP > &rxns, numeric::random::WeightedSampler &rxn_sampler) const
 Filter the reactions to just the ones which can be applied to rdmol If the reactions are multi-component, is assumed that the rdmol (derived from input residue passed to apply()) will be passed as the first reactant to the reaction. More...
 
bool cleanup_product (::RDKit::RWMol &prod) const
 attempt to clean up the product of an RDKit reaction Modifies the RWMol in place - if modification unsuccessful, it will return true. More...
 
utility::vector1< std::pair< ::RDKit::ChemicalReactionOP, core::Real > > const & get_reactions () const
 

Constructor & Destructor Documentation

◆ ReactionMultiTransform()

protocols::drug_design::ReactionMultiTransform::ReactionMultiTransform ( )

Member Function Documentation

◆ add_reaction()

void protocols::drug_design::ReactionMultiTransform::add_reaction ( ::RDKit::ChemicalReactionOP  rxn,
core::Real  weight 
)
overridevirtual

Add a reaction to the list of reactions to use. Reaction should be written in the synthetic direction with a single reactant and product.

Reimplemented from protocols::drug_design::ReactionChemistry.

References protocols::drug_design::ReactionChemistry::add_reaction(), and protocols::drug_design::TR().

◆ apply()

void protocols::drug_design::ReactionMultiTransform::apply ( core::chemical::MutableResidueType )
overridevirtual

◆ class_name()

std::string protocols::drug_design::ReactionMultiTransform::class_name ( )
static

◆ get_additional_output()

core::chemical::MutableResidueTypeOP protocols::drug_design::ReactionMultiTransform::get_additional_output ( )
overridevirtual

◆ get_mapping()

core::chemical::VDVDMapping protocols::drug_design::ReactionMultiTransform::get_mapping ( ) const
overridevirtual

Get the vertex mapping that was used for the last apply() or get_additional_output() This is a mapping FROM the vds in the BEFORE MutableResidueType TO the vds in the AFTER MutableResidueType. The base class implementation defaults to an identity mapping.

Get the vertex mapping that was used for the last apply() The base class implementation defaults to an identity mapping.

Implements protocols::drug_design::ReactionChemistry.

References mapping_.

◆ has_additional_output()

bool protocols::drug_design::ReactionMultiTransform::has_additional_output ( ) const
overridevirtual

Are there alternate ResidueTypes which are availible from the last time we called apply? (That is, will get_addtional_output() return non-null?)

Reimplemented from core::chemical::modifications::ChemistryBase.

References last_product_, and products_.

Referenced by get_additional_output().

◆ parse_my_tag()

void protocols::drug_design::ReactionMultiTransform::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap datacache 
)
overridevirtual

Initialize any data members of this instance from an input tag and a DataMap object.

Implements protocols::drug_design::ReactionChemistry.

References protocols::drug_design::ReactionChemistry::reaction_file().

◆ provide_xml_schema()

void protocols::drug_design::ReactionMultiTransform::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static

Member Data Documentation

◆ input_map_

core::chemical::VDIndexMapping protocols::drug_design::ReactionMultiTransform::input_map_
private

The mapping of input VD to rdmol_ index (needed for correspondance mapping of products)

Internal implementation detail - do not expose

Referenced by apply(), and get_additional_output().

◆ last_product_

core::Size protocols::drug_design::ReactionMultiTransform::last_product_
private

The last product returned by apply()/get_additional_output()

Referenced by apply(), get_additional_output(), and has_additional_output().

◆ mapping_

core::chemical::VDVDMapping protocols::drug_design::ReactionMultiTransform::mapping_
private

The main Input->Output mapping for ResidueTypes.

Referenced by apply(), get_additional_output(), and get_mapping().

◆ products_

utility::vector1< ::RDKit::RWMolOP > protocols::drug_design::ReactionMultiTransform::products_
private

The products generated by the last call to apply()

Referenced by apply(), get_additional_output(), and has_additional_output().

◆ rdmol_

::RDKit::RWMolOP protocols::drug_design::ReactionMultiTransform::rdmol_
private

The converted input (needed for correspondance mapping of products)

Internal implementation detail - do not expose

Referenced by apply(), and get_additional_output().

◆ ref_restype_

core::chemical::MutableResidueTypeOP protocols::drug_design::ReactionMultiTransform::ref_restype_
private

A copy of the input residue type to apply(), for use in converting the output.

Internal implementation detail - do not expose

Referenced by apply(), and get_additional_output().


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