ConvergenceCheck.hh

Go to the documentation of this file.

// -*- mode:c++;tab-width:2;indent-tabs-mode:t;show-trailing-whitespace:t;rm-trailing-spaces:t -*-
// vi: set ts=2 noet:
//
// (c) Copyright Rosetta Commons Member Institutions.
// (c) This file is part of the Rosetta software suite and is made available under license.
// (c) The Rosetta software is developed by the contributing members of the Rosetta Commons.
// (c) For more information, see http://www.rosettacommons.org. Questions about this can be
// (c) addressed to University of Washington UW TechTransfer, email: license@u.washington.edu.

/// @file
/// @brief
/// @author


#ifndef INCLUDED_protocols_moves_mc_convergence_checks_ConvergenceCheck_hh
#define INCLUDED_protocols_moves_mc_convergence_checks_ConvergenceCheck_hh


// type headers
// AUTO-REMOVED #include <core/types.hh>

// unit headers
#include <protocols/moves/mc_convergence_checks/ConvergenceCheck.fwd.hh>
#include <protocols/moves/MonteCarlo.fwd.hh>
#include <utility/excn/Exceptions.hh>

// package headers
#include <core/pose/Pose.fwd.hh>
// AUTO-REMOVED #include <core/scoring/ScoreFunction.fwd.hh>

// utility headers
#include <utility/pointer/ReferenceCount.hh>
// #include "utility/basic_sys_util.h"

// C++ headers
// AUTO-REMOVED #include <map>
#include <string>

#include <utility/vector1.hh>


// Forward declarations

namespace protocols {
namespace moves {
namespace mc_convergence_checks {

class EXCN_Converged : public utility::excn::EXCN_Msg_Exception {
public:
  EXCN_Converged() : EXCN_Msg_Exception( "exit protocol because structure is converged" ) {};
};

class ConvergenceCheck : public utility::pointer::ReferenceCount {
public:
  virtual bool operator() ( const core::pose::Pose & pose, MonteCarlo const&, bool reject ) = 0; //throw exception EXCN_Converged if positive
protected:
};

} // mc_convergence_check
} // moves
} // rosetta

#endif