Rosetta
Public Member Functions | Private Attributes | List of all members
core::chemical::modifications::ChemistryBase Class Referenceabstract

#include <ChemistryBase.hh>

Inheritance diagram for core::chemical::modifications::ChemistryBase:
Inheritance graph
[legend]

Public Member Functions

 ChemistryBase (std::string const &name)
 
std::string name () const
 Return the name of this Chemistry object. More...
 
virtual void apply (MutableResidueType &)=0
 Modify the passed ResidueType. More...
 
virtual bool has_additional_output () const
 Are there alternate ResidueTypes which are availible from the last time we called apply? (That is, will get_addtional_output() return non-null?) More...
 
virtual core::chemical::MutableResidueTypeOP get_additional_output ()
 Get additional generated ResidueTypes, if any. This allows for 1-to-many Chemistries. More...
 
virtual VDVDMapping get_mapping () const
 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...
 
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...
 

Private Attributes

std::string name_
 
ChemistryStatus last_status_
 

Constructor & Destructor Documentation

◆ ChemistryBase()

core::chemical::modifications::ChemistryBase::ChemistryBase ( std::string const &  name)
inline

Member Function Documentation

◆ apply()

virtual void core::chemical::modifications::ChemistryBase::apply ( MutableResidueType )
pure virtual

◆ get_additional_output()

virtual core::chemical::MutableResidueTypeOP core::chemical::modifications::ChemistryBase::get_additional_output ( )
inlinevirtual

◆ get_last_status()

ChemistryStatus core::chemical::modifications::ChemistryBase::get_last_status ( ) const
inline

◆ get_mapping()

VDVDMapping core::chemical::modifications::ChemistryBase::get_mapping ( ) const
virtual

◆ has_additional_output()

virtual bool core::chemical::modifications::ChemistryBase::has_additional_output ( ) const
inlinevirtual

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

Reimplemented in protocols::drug_design::ReactionMultiTransform, and protocols::chemistries::WrappedBaseChemistry.

◆ name()

std::string core::chemical::modifications::ChemistryBase::name ( ) const
inline

Return the name of this Chemistry object.

References name_.

Referenced by protocols::drug_design::RandomFragmentLigand::apply(), and protocols::drug_design::DrugDesignMover::apply().

◆ set_last_status()

void core::chemical::modifications::ChemistryBase::set_last_status ( ChemistryStatus  setting)
inline

Member Data Documentation

◆ last_status_

ChemistryStatus core::chemical::modifications::ChemistryBase::last_status_
private

Referenced by get_last_status(), and set_last_status().

◆ name_

std::string core::chemical::modifications::ChemistryBase::name_
private

Referenced by name().


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