Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
core::chemical::DeleteVariantType Class Reference

A patch operation for deleting a VariantType from a ResidueType. More...

#include <PatchOperation.hh>

Inheritance diagram for core::chemical::DeleteVariantType:
Inheritance graph
[legend]

Public Member Functions

 DeleteVariantType (std::string const &variant_in)
 
 DeleteVariantType (VariantType const variant_in)
 
bool apply (MutableResidueType &rsd) const override
 Apply this patch to the given ResidueType. More...
 
std::string name () const override
 Return the name of this PatchOperation ("DeleteVariantType"). More...
 
std::string deletes_variant () const override
 Which variant, if any, is deleted. More...
 
VariantType deletes_variant_enum () const override
 Which variant, if any, is deleted, by enum. More...
 
- Public Member Functions inherited from core::chemical::PatchOperation
 ~PatchOperation () override
 Automatically generated virtual destructor for class deriving directly from VirtualBase. More...
 
virtual utility::vector1
< std::string > 
adds_atoms ()
 Which atom(s), if any, is/are added. Used for fast matching of ResidueType/Patches to PDB residues. More...
 
virtual std::string deletes_atom ()
 Which atom, if any, is deleted. Used for fast matching of ResidueType/Patches to PDB residues. More...
 
virtual std::string adds_property () const
 Which property, if any, is added. More...
 
virtual ResidueProperty adds_property_enum () const
 Which property, if any, is added. More...
 
virtual std::string deletes_property () const
 Which property, if any, is deleted. More...
 
virtual ResidueProperty deletes_property_enum () const
 Which property, if any, is deleted. More...
 
virtual bool may_change_aa ()
 Generates a new aa. More...
 
virtual bool changes_connections_on (ResidueType const &, std::string const &) const
 Can this case change connections for the atom on the residue? More...
 
virtual std::string generates_name3 ()
 Generates name3. More...
 
virtual std::string generates_interchangeability_group ()
 Generates interchangeability_group. More...
 
virtual bool generates_base_residue ()
 Generates base residue – legacy for D_AA – do not use otherwise. More...
 
virtual bool applies_to_placeholder () const
 Special – does this apply to 'minimal', placeholder types? Generally true, unless updating aa or name3. More...
 

Private Attributes

std::string variant_str_
 
VariantType variant_
 

Detailed Description

A patch operation for deleting a VariantType from a ResidueType.

Author
Labonte JWLab.nosp@m.onte.nosp@m.@jhu..nosp@m.edu
Vikram K. Mulligan (vmull.nosp@m.ig@u.nosp@m.w.edu) – modified to primarily use enums instead of strings.

Constructor & Destructor Documentation

core::chemical::DeleteVariantType::DeleteVariantType ( std::string const &  variant_in)
core::chemical::DeleteVariantType::DeleteVariantType ( VariantType const  variant_in)

Member Function Documentation

bool core::chemical::DeleteVariantType::apply ( MutableResidueType rsd) const
overridevirtual

Apply this patch to the given ResidueType.

Returns
false on success
Remarks
Because ResidueType is not throwing exceptions, this will never return true. Failure will lead to exits from ResidueType. ~Labonte

Implements core::chemical::PatchOperation.

References core::chemical::NO_VARIANT, core::chemical::ResidueTypeBase::remove_variant_type(), variant_, and variant_str_.

std::string core::chemical::DeleteVariantType::deletes_variant ( ) const
inlineoverridevirtual

Which variant, if any, is deleted.

Reimplemented from core::chemical::PatchOperation.

References variant_str_.

VariantType core::chemical::DeleteVariantType::deletes_variant_enum ( ) const
inlineoverridevirtual

Which variant, if any, is deleted, by enum.

Reimplemented from core::chemical::PatchOperation.

References variant_.

std::string core::chemical::DeleteVariantType::name ( ) const
overridevirtual

Return the name of this PatchOperation ("DeleteVariantType").

Author
Vikram K. Mulligan (vmull.nosp@m.ig@u.nosp@m.w.edu).

Implements core::chemical::PatchOperation.

Member Data Documentation

VariantType core::chemical::DeleteVariantType::variant_
private

Referenced by apply(), and deletes_variant_enum().

std::string core::chemical::DeleteVariantType::variant_str_
private

Referenced by apply(), and deletes_variant().


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