Base class for logging information about the loop modeling run. More...

#include <Logger.hh>

Public Member Functions
void	log_beginning (Pose const &pose, Size I, Size J, Size K)
	Record the beginning of a simulation. More...

void	log_beginning (Pose const &pose, utility::vector1< Size > iterations)
	Record the beginning of a simulation. More...

void	log_iteration (Pose const &pose, Size i, Size j, Size k)
	Record the start of another iteration. More...

void	log_monte_carlo (protocols::moves::MonteCarlo const &monte_carlo)
	Record the result of a MonteCarlo acceptance check. More...

void	log_monte_carlo (protocols::moves::MonteCarloCOP monte_carlo)
	Record the result of a MonteCarlo acceptance check. More...

void	log_ending (Pose const &pose)
	Record the end of a simulation. More...

Protected Member Functions
virtual void	log_beginning_ (Pose const &)
	Reimplemented by subclasses to record the beginning of a simulation. More...

virtual void	log_iteration_ (Pose const &)
	Reimplemented by subclasses to record the start of another iteration. More...

virtual void	log_monte_carlo_ (protocols::moves::MonteCarlo const &)
	Reimplemented by subclasses to record the result of a MonteCarlo acceptance check. More...

virtual void	log_ending_ (Pose const &)
	Reimplemented by subclasses to record the end of a simulation. More...

Size	get_iteration_as_int () const
	Return the current iteration as an integer. More...

Size	get_max_iteration_as_int () const
	Return the number of iterations that will be run in the current simulation as an integer. More...

string	get_iteration_as_string () const
	Return the current iteration as a string. More...

string	get_max_iteration_as_string () const
	Return the number of iterations that will be run in the current simulation as an string. More...

Size	get_num_digits (Size value) const
	Return the number of digits in the given number. More...

Private Attributes
Size	i_

Size	j_

Size	k_

Size	I_

Size	J_

Size	K_

Detailed Description

Base class for logging information about the loop modeling run.

Subclasses should reimplement the protected method which all end with an underscore. These methods are expected to do the actual logging, and will be called by the public methods of the same name. In most cases, the public methods do a little bit of useful preprocessing before calling the corresponding protected methods.

Member Function Documentation

Size protocols::loop_modeling::loggers::Logger::get_iteration_as_int ( ) const

protected

Return the current iteration as an integer.

All of the index variables (i, j, k) count from 1. This function also counts from 1, in the sense that it will return 1 when i = j = k = 1.

Referenced by protocols::loop_modeling::loggers::ProgressBar::log_iteration_().

string protocols::loop_modeling::loggers::Logger::get_iteration_as_string ( ) const

protected

Return the current iteration as a string.

References get_num_digits().

Size protocols::loop_modeling::loggers::Logger::get_max_iteration_as_int ( ) const

protected

Return the number of iterations that will be run in the current simulation as an integer.

Referenced by protocols::loop_modeling::loggers::ProgressBar::log_iteration_().

string protocols::loop_modeling::loggers::Logger::get_max_iteration_as_string ( ) const

protected

Return the number of iterations that will be run in the current simulation as an string.

Size protocols::loop_modeling::loggers::Logger::get_num_digits ( Size value ) const

protected

Return the number of digits in the given number.

This is useful for formatting operations.

References utility::get_num_digits().

void protocols::loop_modeling::loggers::Logger::log_beginning	(	Pose const &	pose,
		Size	I,
		Size	J,
		Size	K
	)

Record the beginning of a simulation.

The arguments to this method should give the total number of iterations that will be run in each loop of the simulation.

void protocols::loop_modeling::loggers::Logger::log_beginning	(	Pose const &	pose,
		utility::vector1< Size >	iterations
	)

Record the beginning of a simulation.

The argument to this method should give the total number of iterations that will be run in each loop of the simulation.

virtual void protocols::loop_modeling::loggers::Logger::log_beginning_ ( Pose const & )

inlineprotectedvirtual

Reimplemented by subclasses to record the beginning of a simulation.

Reimplemented in protocols::loop_modeling::loggers::PdbLogger.

void protocols::loop_modeling::loggers::Logger::log_ending ( Pose const & pose )

Record the end of a simulation.

virtual void protocols::loop_modeling::loggers::Logger::log_ending_ ( Pose const & )

inlineprotectedvirtual

Reimplemented by subclasses to record the end of a simulation.

Reimplemented in protocols::loop_modeling::loggers::ScoreVsRmsd.

void protocols::loop_modeling::loggers::Logger::log_iteration	(	Pose const &	pose,
		Size	i,
		Size	j,
		Size	k
	)

Record the start of another iteration.

The arguments to this method should identify the current iteration. Since the loop protocol utilizes three nested loops, three index numbers are required.

virtual void protocols::loop_modeling::loggers::Logger::log_iteration_ ( Pose const & )

inlineprotectedvirtual

Reimplemented by subclasses to record the start of another iteration.

Reimplemented in protocols::loop_modeling::loggers::ProgressBar.

void protocols::loop_modeling::loggers::Logger::log_monte_carlo ( protocols::moves::MonteCarlo const & monte_carlo )

Record the result of a MonteCarlo acceptance check.

void protocols::loop_modeling::loggers::Logger::log_monte_carlo ( protocols::moves::MonteCarloCOP monte_carlo )

Record the result of a MonteCarlo acceptance check.

virtual void protocols::loop_modeling::loggers::Logger::log_monte_carlo_ ( protocols::moves::MonteCarlo const & )

inlineprotectedvirtual

Reimplemented by subclasses to record the result of a MonteCarlo acceptance check.

Reimplemented in protocols::loop_modeling::loggers::ScoreVsRmsd, and protocols::loop_modeling::loggers::PdbLogger.

Member Data Documentation

Size protocols::loop_modeling::loggers::Logger::i_

private

Size protocols::loop_modeling::loggers::Logger::I_

private

Size protocols::loop_modeling::loggers::Logger::j_

private

Size protocols::loop_modeling::loggers::Logger::J_

private

Size protocols::loop_modeling::loggers::Logger::k_

private

Size protocols::loop_modeling::loggers::Logger::K_

private

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

src/protocols/loop_modeling/loggers/Logger.hh
src/protocols/loop_modeling/loggers/Logger.cc

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation