Rosetta
Public Member Functions | Private Attributes | Friends | List of all members
protocols::pmut_scan::Mutant Class Reference

#include <Mutant.hh>

Public Member Functions

 Mutant ()
 Mutant class constructor. More...
 
 ~Mutant ()
 Mutant class destructor. More...
 
core::Size n_mutations () const
 Returns the number of mutations in this mutant. More...
 
void add_mutation (MutationData md)
 Adds the passed in mutation to the class member list. More...
 
utility::vector1< MutationData >::const_iterator mutations_begin () const
 Returns a const iterator to beginning of the mutations vector. More...
 
utility::vector1< MutationData >::const_iterator mutations_end () const
 Returns a const iterator to end of the mutations vector. More...
 
bool operator== (const Mutant &m_other) const
 Function which tests two Mutant objects for equality; only used by unit tests. More...
 
MutationData pop_mutation ()
 Sets the passed in reference to the first element of the mutations_ vector, and removes that element from the vector. More...
 

Private Attributes

utility::vector1< MutationDatamutations_
 

Friends

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

Constructor & Destructor Documentation

◆ Mutant()

protocols::pmut_scan::Mutant::Mutant ( )
default

Mutant class constructor.

◆ ~Mutant()

protocols::pmut_scan::Mutant::~Mutant ( )
default

Mutant class destructor.

Member Function Documentation

◆ add_mutation()

void protocols::pmut_scan::Mutant::add_mutation ( MutationData  md)

◆ mutations_begin()

utility::vector1< MutationData >::const_iterator protocols::pmut_scan::Mutant::mutations_begin ( ) const

◆ mutations_end()

utility::vector1< MutationData >::const_iterator protocols::pmut_scan::Mutant::mutations_end ( ) const

◆ n_mutations()

core::Size protocols::pmut_scan::Mutant::n_mutations ( ) const

◆ operator==()

bool protocols::pmut_scan::Mutant::operator== ( const Mutant m_other) const

Function which tests two Mutant objects for equality; only used by unit tests.

References mutations_begin(), mutations_end(), and n_mutations().

◆ pop_mutation()

MutationData protocols::pmut_scan::Mutant::pop_mutation ( )

Sets the passed in reference to the first element of the mutations_ vector, and removes that element from the vector.

References mutations_.

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

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const Mutant m 
)
friend

◆ PointMutScanDriver

friend class PointMutScanDriver
friend

Member Data Documentation

◆ mutations_

utility::vector1< MutationData > protocols::pmut_scan::Mutant::mutations_
private

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