Rosetta 3.4
Public Types | Public Member Functions
protocols::canonical_sampling::SidechainMetropolisHastingsMover Class Reference

#include <SidechainMetropolisHastingsMover.hh>

Inheritance diagram for protocols::canonical_sampling::SidechainMetropolisHastingsMover:
Inheritance graph
[legend]
Collaboration diagram for protocols::canonical_sampling::SidechainMetropolisHastingsMover:
Collaboration graph
[legend]

List of all members.

Public Types

typedef MetropolisHastingsMover Parent

Public Member Functions

 SidechainMetropolisHastingsMover ()
 SidechainMetropolisHastingsMover (core::Size stride)
 SidechainMetropolisHastingsMover (SidechainMetropolisHastingsMover const &metropolis_hastings_mover)
virtual ~SidechainMetropolisHastingsMover ()
virtual void apply (core::pose::Pose &pose)
virtual std::string get_name () const
 Each derived class must specify its name. The class name.
protocols::moves::MoverOP clone () const
 clone has to be overridden only if clone invocation is expected.
virtual protocols::moves::MoverOP fresh_instance () const
 this is like clone(), except it generates a new mover object freshly created with the default ctor. This function _should_ be pure virtual but that would disrupt the code base; MAKE SURE YOU DEFINE IT if you want to have your mover be a protocol handed to the job distributor (august 08 vintage).
virtual void parse_my_tag (utility::tag::TagPtr const tag, protocols::moves::DataMap &data, protocols::filters::Filters_map const &filters, protocols::moves::Movers_map const &movers, core::pose::Pose const &pose)
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing.
bool pass_metropolis (core::Real delta_energy, core::Real last_proposal_density_ratio) const
core::Size output_count (core::Size ct) const
void set_stride (core::Size setting)

Member Typedef Documentation


Constructor & Destructor Documentation

protocols::canonical_sampling::SidechainMetropolisHastingsMover::SidechainMetropolisHastingsMover ( )

Referenced by clone(), and fresh_instance().

protocols::canonical_sampling::SidechainMetropolisHastingsMover::SidechainMetropolisHastingsMover ( core::Size  stride)
protocols::canonical_sampling::SidechainMetropolisHastingsMover::SidechainMetropolisHastingsMover ( SidechainMetropolisHastingsMover const &  metropolis_hastings_mover)
protocols::canonical_sampling::SidechainMetropolisHastingsMover::~SidechainMetropolisHastingsMover ( ) [virtual]

Member Function Documentation

void protocols::canonical_sampling::SidechainMetropolisHastingsMover::apply ( core::pose::Pose pose) [virtual]
protocols::moves::MoverOP protocols::canonical_sampling::SidechainMetropolisHastingsMover::clone ( ) const [virtual]

clone has to be overridden only if clone invocation is expected.

clone is meant to return an OP'ed deep copy of this object. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function.

Reimplemented from protocols::canonical_sampling::MetropolisHastingsMover.

References SidechainMetropolisHastingsMover().

protocols::moves::MoverOP protocols::canonical_sampling::SidechainMetropolisHastingsMover::fresh_instance ( ) const [virtual]

this is like clone(), except it generates a new mover object freshly created with the default ctor. This function _should_ be pure virtual but that would disrupt the code base; MAKE SURE YOU DEFINE IT if you want to have your mover be a protocol handed to the job distributor (august 08 vintage).

fresh_instance is meant to return a new object of this class, created with the default constructor. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function. This is used by the August 08 job distributor.

Reimplemented from protocols::canonical_sampling::MetropolisHastingsMover.

References SidechainMetropolisHastingsMover().

std::string protocols::canonical_sampling::SidechainMetropolisHastingsMover::get_name ( ) const [virtual]

Each derived class must specify its name. The class name.

Reimplemented from protocols::canonical_sampling::MetropolisHastingsMover.

core::Size protocols::canonical_sampling::SidechainMetropolisHastingsMover::output_count ( core::Size  ct) const

Referenced by apply().

void protocols::canonical_sampling::SidechainMetropolisHastingsMover::parse_my_tag ( utility::tag::TagPtr const  tag,
protocols::moves::DataMap data,
protocols::filters::Filters_map const &  filters,
protocols::moves::Movers_map const &  movers,
core::pose::Pose const &  pose 
) [virtual]

Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing.

Some movers need not be parsed, so we shouldn't stop executions. This, however, calls attention to the lack of this method, which could be due to something as silly as a wrong parameters definition.

Reimplemented from protocols::canonical_sampling::MetropolisHastingsMover.

References protocols::canonical_sampling::MetropolisHastingsMover::parse_my_tag().

bool protocols::canonical_sampling::SidechainMetropolisHastingsMover::pass_metropolis ( core::Real  delta_energy,
core::Real  last_proposal_density_ratio 
) const
void protocols::canonical_sampling::SidechainMetropolisHastingsMover::set_stride ( core::Size  setting) [inline]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines