Rosetta 3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
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]

Public Types

typedef TrajectoryRecorder Parent
 

Public Member Functions

 SilentTrajectoryRecorder ()
 Constructor. More...
 
 SilentTrajectoryRecorder (SilentTrajectoryRecorder const &)
 Copy constructor. More...
 
virtual protocols::moves::MoverOP clone () const
 clone has to be overridden only if clone invocation is expected. More...
 
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). More...
 
virtual std::string get_name () const
 Each derived class must specify its name. The class name. More...
 
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. More...
 
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 More...
 
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 More...
 
- Public Member Functions inherited from protocols::canonical_sampling::TrajectoryRecorder
 TrajectoryRecorder ()
 Constructor. More...
 
 ~TrajectoryRecorder ()
 Destructor. More...
 
 TrajectoryRecorder (TrajectoryRecorder const &)
 Copy constructor. More...
 
std::string const & file_name () const
 
void file_name (std::string const &file_name)
 
core::Size model_count () const
 
core::Size step_count () const
 
core::Size stride () const
 
bool cumulate_jobs () const
 
bool cumulate_replicas () const
 
void stride (core::Size stride)
 
virtual void reset (protocols::moves::MonteCarlo const &mc, protocols::canonical_sampling::MetropolisHastingsMoverCAP metropolis_hastings_mover=0)
 
void update_after_boltzmann (core::pose::Pose const &pose, protocols::canonical_sampling::MetropolisHastingsMoverCAP metropolis_hastings_mover=0)
 
void update_after_boltzmann (protocols::moves::MonteCarlo const &mc)
 
virtual void apply (core::pose::Pose &pose)
 
- Public Member Functions inherited from protocols::canonical_sampling::ThermodynamicObserver
 ThermodynamicObserver ()
 
virtual ~ThermodynamicObserver ()
 
virtual void finalize_simulation (core::pose::Pose &, protocols::canonical_sampling::MetropolisHastingsMover const &)
 callback executed after all Monte Carlo trials More...
 
virtual bool requires_pose ()
 return false here if a valid pose is not required for "observe" i.e. a trialcounter More...
 
- Public Member Functions inherited from protocols::moves::Mover
 Mover ()
 
virtual ~Mover ()
 
virtual MoverSP create ()
 
virtual void apply (core::io::serialization::PipeMap &pmap)
 
virtual void parse_state (SerializableState const &state)
 
virtual void parse_def (utility::lua::LuaObject const &def, utility::lua::LuaObject const &score_fxns, utility::lua::LuaObject const &tasks, MoverCacheSP cache)
 
virtual void save_state (SerializableState &state)
 
 Mover (std::string const &type_name)
 sets the type for a mover; name_ has been removed (2010/05/14) More...
 
 Mover (Mover const &other)
 
Moveroperator= (Mover const &other)
 assignment operator More...
 
virtual core::Real last_proposal_density_ratio ()
 
std::string const & type () const
 
std::string get_current_tag () const
 A tag is a unique identifier used to identify structures produced by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor. More...
 
void set_current_tag (std::string const &new_tag)
 
virtual void set_input_pose (PoseCOP pose)
 setter for poses contained for rms More...
 
virtual void set_native_pose (PoseCOP pose)
 setter for native poses contained for rms -— we should get rid of this method? it is widely used, but a bit unsafe More...
 
PoseCOP get_input_pose () const
 
PoseCOP get_native_pose () const
 
virtual void test_move (Pose &pose)
 : Unit test support function. Apply one move to a given pose. Allows extra test specific functions to be called before applying More...
 
void type (const std::string &type_in)
 
std::string get_type () const
 
MoverStatus get_last_move_status () const
 end parser interface, start Job Distributor interface///////////// More...
 
void reset_status ()
 resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s. More...
 
virtual core::pose::PoseOP get_additional_output ()
 Mechanism by which a mover may return multiple output poses from a single input pose. More...
 
virtual void clear_info ()
 Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file. More...
 
virtual Stringsinfo ()
 non-const accessor More...
 
virtual Strings const & info () const
 const accessor More...
 
virtual bool reinitialize_for_each_job () const
 this function informs the job distributor (august 08 vintage) whether this object needs to be freshly regenerated on each use. More...
 
virtual bool reinitialize_for_new_input () const
 this function informs the job distributor (august 08 vintage) whether this object needs to be regenerated when the input pose is about to change (for example, if the mover has special code on the first apply() that is only valid for that one input pose). More...
 
void set_current_job (protocols::jobdist::BasicJobCOP job)
 
jobdist::BasicJobCOP get_current_job () const
 

Static Public Member Functions

static void register_options ()
 Associates relevant options with the TemperedDocking class. More...
 
- Static Public Member Functions inherited from protocols::canonical_sampling::TrajectoryRecorder
static void register_options ()
 Associates relevant options with the TemperedDocking class. More...
 

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 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.

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.

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

Referenced by protocols::docking::TemperedDocking::register_options().

bool protocols::canonical_sampling::SilentTrajectoryRecorder::restart_simulation ( core::pose::Pose ,
protocols::canonical_sampling::MetropolisHastingsMover ,
core::Size ,
core::Size ,
core::Real  
)
virtual
void protocols::canonical_sampling::SilentTrajectoryRecorder::write_model ( core::pose::Pose const &  pose,
protocols::canonical_sampling::MetropolisHastingsMoverCAP  metropolis_hastings_mover = 0 
)
protectedvirtual

Member Data Documentation

bool protocols::canonical_sampling::SilentTrajectoryRecorder::options_registered_
staticprotected
core::Size protocols::canonical_sampling::SilentTrajectoryRecorder::score_stride_
protected

Referenced by parse_my_tag(), and write_model().


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