protocols::pmut_scan::Mutant Class Reference

#include <Mutant.hh>

Collaboration diagram for protocols::pmut_scan::Mutant:

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< MutationData >	mutations_

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

Detailed Description

Definition at line 80 of file Mutant.hh.

Constructor & Destructor Documentation

protocols::pmut_scan::Mutant::Mutant

(

)

Mutant class constructor.

Definition at line 142 of file Mutant.cc.

protocols::pmut_scan::Mutant::~Mutant

(

)

Mutant class destructor.

Definition at line 146 of file Mutant.cc.

Member Function Documentation

void protocols::pmut_scan::Mutant::add_mutation

(

MutationData

md)

Adds the passed in mutation to the class member list.

Mutant::add_mutation

Definition at line 165 of file Mutant.cc.

References mutations_.

Referenced by protocols::pmut_scan::PointMutScanDriver::fill_mutations_list(), and protocols::pmut_scan::PointMutScanDriver::read_mutants_list_file().

utility::vector1< MutationData >::const_iterator protocols::pmut_scan::Mutant::mutations_begin

(

)

const

Returns a const iterator to beginning of the mutations vector.

Mutant::mutations_begin

Definition at line 175 of file Mutant.cc.

References mutations_.

Referenced by protocols::pmut_scan::operator<<(), operator==(), protocols::pmut_scan::AlterSpecDisruptionDriver::reject_on_chains(), and protocols::pmut_scan::AlterSpecDisruptionDriver::reject_on_interface().

utility::vector1< MutationData >::const_iterator protocols::pmut_scan::Mutant::mutations_end

(

)

const

Returns a const iterator to end of the mutations vector.

Mutant::mutations_end

Definition at line 185 of file Mutant.cc.

References mutations_.

Referenced by protocols::pmut_scan::operator<<(), operator==(), protocols::pmut_scan::AlterSpecDisruptionDriver::reject_on_chains(), and protocols::pmut_scan::AlterSpecDisruptionDriver::reject_on_interface().

core::Size protocols::pmut_scan::Mutant::n_mutations

(

)

const

Returns the number of mutations in this mutant.

Mutant::n_mutations

Definition at line 155 of file Mutant.cc.

References mutations_.

Referenced by protocols::pmut_scan::PointMutScanDriver::make_specific_mutant(), operator==(), and protocols::pmut_scan::AlterSpecDisruptionDriver::reject_on_chains().

bool protocols::pmut_scan::Mutant::operator==

(

const Mutant &

m_other)

const

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

Mutant::operator==

Definition at line 195 of file Mutant.cc.

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

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.

Mutant::pop_mutation

Definition at line 217 of file Mutant.cc.

References mutations_.

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

Friends And Related Function Documentation

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

friend

Definition at line 231 of file Mutant.cc.

friend class PointMutScanDriver

friend

Definition at line 104 of file Mutant.hh.

Member Data Documentation

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

private

Definition at line 102 of file Mutant.hh.

Referenced by add_mutation(), mutations_begin(), mutations_end(), n_mutations(), and pop_mutation().

---

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

• src/protocols/pmut_scan/Mutant.hh
• src/protocols/pmut_scan/Mutant.cc