Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | Friends | List of all members
protocols::pmut_scan::MutationData Class Reference

#include <Mutant.hh>

Public Member Functions

 MutationData (char wt_residue, char mut_residue, core::Size pose_resnum, core::Size pdb_resnum, char icode, char chain)
 Constructor for MutationData objects. A mutation holds the wt and mutant amino acid type, pdb resnum, pose resnum, chain and icode. More...
 
 ~MutationData ()
 Destructor for MutationData objects. No dynamically allocated memory held in MutationData objects so nothing to do here. More...
 
std::string mutation_string () const
 Returns a string representation of this mutation. More...
 
std::string mutation_string_PDB_numbering () const
 Returns a string representation of this mutation using PDB not pose numbering. More...
 
char mut_residue () const
 Accessor for the mut_residue member variable. Needed by the function make_mutant_structure() in the PointMutScanDriver class. More...
 
core::Size pose_resnum () const
 Accessor for the pose_resnum member variable. Needed by the function make_mutant_structure() in the PointMutScanDriver class. More...
 
char pdb_chain () const
 
void print_mutation_data (MutationData &md)
 print function for MutationData class; only used by unit tests More...
 
bool operator== (const MutationData &md_other) const
 function which tests two MutationData objects for equality; only used by unit tests More...
 

Private Attributes

char wt_residue_
 
char mut_residue_
 
core::Size pose_resnum_
 
core::Size pdb_resnum_
 
char icode_
 
char chain_
 

Friends

class Mutant
 
class PointMutScanDriver
 
std::ostream & operator<< (std::ostream &os, const MutationData &md)
 

Constructor & Destructor Documentation

protocols::pmut_scan::MutationData::MutationData ( char  wt_residue,
char  mut_residue,
core::Size  pose_resnum,
core::Size  pdb_resnum,
char  icode,
char  chain 
)

Constructor for MutationData objects. A mutation holds the wt and mutant amino acid type, pdb resnum, pose resnum, chain and icode.

protocols::pmut_scan::MutationData::~MutationData ( )
default

Destructor for MutationData objects. No dynamically allocated memory held in MutationData objects so nothing to do here.

Member Function Documentation

char protocols::pmut_scan::MutationData::mut_residue ( ) const

Accessor for the mut_residue member variable. Needed by the function make_mutant_structure() in the PointMutScanDriver class.

References mut_residue_.

Referenced by protocols::pmut_scan::PointMutScanDriver::make_mutant_structure().

std::string protocols::pmut_scan::MutationData::mutation_string ( ) const
std::string protocols::pmut_scan::MutationData::mutation_string_PDB_numbering ( ) const

Returns a string representation of this mutation using PDB not pose numbering.

References chain_, icode_, mut_residue_, core::conformation::membrane::out, pdb_resnum_, and wt_residue_.

Referenced by protocols::pmut_scan::PointMutScanDriver::make_specific_mutant().

bool protocols::pmut_scan::MutationData::operator== ( const MutationData md_other) const

function which tests two MutationData objects for equality; only used by unit tests

References chain_, icode_, mut_residue_, pdb_resnum_, pose_resnum_, and wt_residue_.

char protocols::pmut_scan::MutationData::pdb_chain ( ) const
inline

References chain_.

core::Size protocols::pmut_scan::MutationData::pose_resnum ( ) const

Accessor for the pose_resnum member variable. Needed by the function make_mutant_structure() in the PointMutScanDriver class.

References pose_resnum_.

Referenced by protocols::pmut_scan::PointMutScanDriver::make_mutant_structure().

void protocols::pmut_scan::MutationData::print_mutation_data ( MutationData md)

print function for MutationData class; only used by unit tests

References chain_, icode_, mut_residue_, pdb_resnum_, pose_resnum_, and wt_residue_.

Friends And Related Function Documentation

friend class Mutant
friend
std::ostream& operator<< ( std::ostream &  os,
const MutationData md 
)
friend
friend class PointMutScanDriver
friend

Member Data Documentation

char protocols::pmut_scan::MutationData::chain_
private
char protocols::pmut_scan::MutationData::icode_
private
char protocols::pmut_scan::MutationData::mut_residue_
private
core::Size protocols::pmut_scan::MutationData::pdb_resnum_
private
core::Size protocols::pmut_scan::MutationData::pose_resnum_
private
char protocols::pmut_scan::MutationData::wt_residue_
private

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