Rosetta 3.4
Public Member Functions | Friends
protocols::pmut_scan::MutationData Class Reference

#include <Mutant.hh>

Collaboration diagram for protocols::pmut_scan::MutationData:
Collaboration graph
[legend]

List of all members.

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.
 ~MutationData ()
 Destructor for MutationData objects. No dynamically allocated memory held in MutationData objects so nothing to do here.
std::string mutation_string () const
 Returns a string representation of this mutation.
std::string mutation_string_PDB_numbering () const
 Returns a string representation of this mutation using PDB not pose numbering.
char mut_residue () const
 Accessor for the mut_residue member variable. Needed by the function make_mutant_structure() in the PointMutScanDriver class.
core::Size pose_resnum () const
 Accessor for the pose_resnum member variable. Needed by the function make_mutant_structure() in the PointMutScanDriver class.
void print_mutation_data (MutationData &md)
 print function for MutationData class; only used by unit tests
bool operator== (const MutationData &md_other) const
 function which tests two MutationData objects for equality; only used by unit tests

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.

MutationData::MutationData

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

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

MutationData::~MutationData


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.

MutationData::mut_residue

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

Returns a string representation of this mutation.

MutationData::mutation_string

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

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

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

MutationData::mutation_string_PDB_numbering

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

MutationData::mutation_data_equals

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.

MutationData::pose_resnum

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

print function for MutationData class; only used by unit tests

MutationData::print_mutation_data


Friends And Related Function Documentation

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

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines