Rosetta Protocols  2014.35
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
protocols::match::output::MatchScoreWriter Class Reference

#include <MatchScoreWriter.hh>

Public Member Functions

 MatchScoreWriter ()
 Default constructor. More...
 
 MatchScoreWriter (MatchScoreWriter const &object_to_copy)
 Copy constructor. More...
 
MatchScoreWriteroperator= (MatchScoreWriter const &object_to_copy)
 
 ~MatchScoreWriter ()
 
virtual void show (std::ostream &output=std::cout) const
 Generate string representation of MatchScoreWriter for debugging purposes. More...
 
virtual void add_match (std::string match_name, core::Real score)
 Add a match name (along with score) to be outputed in score file. More...
 
virtual void add_match (core::Real score)
 Add an unnamed match (along with score) to be outputed in score file. More...
 
virtual void write_match_scores ()
 Write out the match scores once all scores have been added. More...
 
virtual void set_output_filename (std::string output_filename)
 Set output filename, which also turns on output. More...
 
virtual void set_output (bool output_on)
 Set whether or not to output. More...
 

Private Member Functions

virtual void copy_data (MatchScoreWriter object_to_copy_to, MatchScoreWriter object_to_copy_from)
 
virtual void init ()
 

Private Attributes

std::string score_output_filename_
 
utility::vector1< std::stringmatch_names_
 
utility::vector1< core::Realmatch_scores_
 
std::string output_header_
 
bool write_file_
 
core::Real generic_output_number_
 

Friends

std::ostream & operator<< (std::ostream &output, MatchScoreWriter const &object_to_output)
 

Detailed Description

Writes out a score file based on the sum of RMS of geometric constrainst satisfaction with the desired ligan positioning

Constructor & Destructor Documentation

protocols::match::output::MatchScoreWriter::MatchScoreWriter ( )

Default constructor.

default is to not really do much of anything, unless filename output is set

References init().

protocols::match::output::MatchScoreWriter::MatchScoreWriter ( MatchScoreWriter const &  object_to_copy)

Copy constructor.

References copy_data().

protocols::match::output::MatchScoreWriter::~MatchScoreWriter ( )

Member Function Documentation

void protocols::match::output::MatchScoreWriter::add_match ( std::string  match_name,
core::Real  score 
)
virtual

Add a match name (along with score) to be outputed in score file.

Add a match (along with score) to be outputted in score file.

References match_names_, and match_scores_.

void protocols::match::output::MatchScoreWriter::add_match ( core::Real  score)
virtual

Add an unnamed match (along with score) to be outputed in score file.

Each additional match will have an incremented name

References generic_output_number_, match_names_, and match_scores_.

void protocols::match::output::MatchScoreWriter::copy_data ( MatchScoreWriter  object_to_copy_to,
MatchScoreWriter  object_to_copy_from 
)
privatevirtual
void protocols::match::output::MatchScoreWriter::init ( void  )
privatevirtual
MatchScoreWriter & protocols::match::output::MatchScoreWriter::operator= ( MatchScoreWriter const &  object_to_copy)

References copy_data().

void protocols::match::output::MatchScoreWriter::set_output ( bool  output_on)
virtual

Set whether or not to output.

References write_file_.

Referenced by set_output_filename().

void protocols::match::output::MatchScoreWriter::set_output_filename ( std::string  output_filename)
virtual

Set output filename, which also turns on output.

References score_output_filename_, and set_output().

void protocols::match::output::MatchScoreWriter::show ( std::ostream &  output = std::cout) const
virtual

Generate string representation of MatchScoreWriter for debugging purposes.

References match_names_, match_scores_, and output_header_.

Referenced by protocols::match::output::operator<<().

void protocols::match::output::MatchScoreWriter::write_match_scores ( )
virtual

Write out the match scores once all scores have been added.

References match_names_, match_scores_, output_header_, score_output_filename_, protocols::match::output::TR, and write_file_.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  output,
MatchScoreWriter const &  object_to_output 
)
friend

Member Data Documentation

core::Real protocols::match::output::MatchScoreWriter::generic_output_number_
private

Referenced by add_match(), copy_data(), and init().

utility::vector1<std::string> protocols::match::output::MatchScoreWriter::match_names_
private

Referenced by add_match(), show(), and write_match_scores().

utility::vector1<core::Real> protocols::match::output::MatchScoreWriter::match_scores_
private

Referenced by add_match(), show(), and write_match_scores().

std::string protocols::match::output::MatchScoreWriter::output_header_
private
std::string protocols::match::output::MatchScoreWriter::score_output_filename_
private
bool protocols::match::output::MatchScoreWriter::write_file_
private

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