Rosetta 3.4
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
protocols::canonical_sampling::SilentTrajectoryRecorder Class Reference

#include <SilentTrajectoryRecorder.hh>

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

List of all members.

Public Types

typedef TrajectoryRecorder Parent

Public Member Functions

 SilentTrajectoryRecorder ()
 Constructor.
 SilentTrajectoryRecorder (SilentTrajectoryRecorder const &)
 Copy constructor.
virtual 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 std::string get_name () const
 Each derived class must specify its name. The class name.
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.
virtual void initialize_simulation (core::pose::Pose &pose, protocols::canonical_sampling::MetropolisHastingsMover const &metropolis_hastings_mover, core::Size cycle)
virtual void observe_after_metropolis (protocols::canonical_sampling::MetropolisHastingsMover const &metropolis_hastings_mover)
 callback executed after the Metropolis criterion is evaluated
virtual bool restart_simulation (core::pose::Pose &pose, protocols::canonical_sampling::MetropolisHastingsMover &metropolis_hastings_mover, core::Size &cycle, core::Size &temp_level, core::Real &temperature)
 callback executed before any Monte Carlo trials

Static Public Member Functions

static void register_options ()
 Associates relevant options with the TemperedDocking class.

Protected Member Functions

virtual void write_model (core::pose::Pose const &pose, protocols::canonical_sampling::MetropolisHastingsMoverCAP metropolis_hastings_mover=0)

Protected Attributes

core::Size score_stride_

Static Protected Attributes

static bool options_registered_

Member Typedef Documentation


Constructor & Destructor Documentation

protocols::canonical_sampling::SilentTrajectoryRecorder::SilentTrajectoryRecorder ( )

Constructor.

References protocols::evaluation::options_registered_.

Referenced by clone(), and fresh_instance().

protocols::canonical_sampling::SilentTrajectoryRecorder::SilentTrajectoryRecorder ( SilentTrajectoryRecorder const &  other)

Copy constructor.


Member Function Documentation

protocols::moves::MoverOP protocols::canonical_sampling::SilentTrajectoryRecorder::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::moves::Mover.

References SilentTrajectoryRecorder().

protocols::moves::MoverOP protocols::canonical_sampling::SilentTrajectoryRecorder::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::moves::Mover.

References SilentTrajectoryRecorder().

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

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

Reimplemented from protocols::canonical_sampling::TrajectoryRecorder.

void protocols::canonical_sampling::SilentTrajectoryRecorder::initialize_simulation ( core::pose::Pose pose,
protocols::canonical_sampling::MetropolisHastingsMover const &  metropolis_hastings_mover,
core::Size  cycle 
) [virtual]
void protocols::canonical_sampling::SilentTrajectoryRecorder::observe_after_metropolis ( protocols::canonical_sampling::MetropolisHastingsMover const &  metropolis_hastings_mover) [virtual]
void protocols::canonical_sampling::SilentTrajectoryRecorder::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::TrajectoryRecorder.

References protocols::canonical_sampling::TrajectoryRecorder::parse_my_tag(), and score_stride_.

void protocols::canonical_sampling::SilentTrajectoryRecorder::register_options ( ) [static]

Associates relevant options with the TemperedDocking class.

Reimplemented from protocols::canonical_sampling::TrajectoryRecorder.

References protocols::evaluation::options_registered_, and protocols::evaluation::register_options().

bool protocols::canonical_sampling::SilentTrajectoryRecorder::restart_simulation ( core::pose::Pose pose,
protocols::canonical_sampling::MetropolisHastingsMover metropolis_hastings_mover,
core::Size cycle,
core::Size temp_level,
core::Real temperature 
) [virtual]
void protocols::canonical_sampling::SilentTrajectoryRecorder::write_model ( core::pose::Pose const &  pose,
protocols::canonical_sampling::MetropolisHastingsMoverCAP  metropolis_hastings_mover = 0 
) [protected, virtual]

Member Data Documentation

Referenced by parse_my_tag(), and write_model().


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