Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
protocols::stepwise::sampler::StepWiseSamplerSizedAny Class Reference

#include <StepWiseSamplerSizedAny.hh>

Inheritance diagram for protocols::stepwise::sampler::StepWiseSamplerSizedAny:
Inheritance graph

Public Member Functions

 StepWiseSamplerSizedAny ()
 ~StepWiseSamplerSizedAny () override
void init () override
 Initialization. More...
void reset () override
 Reset to the first (or random if random()) rotamer. More...
void operator++ () override
 Move to next rotamer. More...
void apply (core::pose::Pose &pose) override
 Apply the current rotamer to pose. More...
void apply (core::pose::Pose &pose, core::Size const i) override
 Apply the i-th rotamer to pose. More...
core::Size size () const override
 Get the total number of rotamers in sampler. More...
virtual void add_external_loop_rotamer (StepWiseSamplerSizedOP const &rotamer)
 Add one more rotamer sampler to this sampler. More...
virtual void clear_rotamer ()
 Clear all rotamer samplers stored in this sampler. More...
std::string get_name () const override
 Name of the class. More...
toolbox::SamplerPlusPlusType type () const override
 Type of class (see enum in SamplerPlusPlusTypes.hh) More...
void show (std::ostream &out, core::Size const indent=0) const override
 output summary of class More...
- Public Member Functions inherited from protocols::stepwise::sampler::StepWiseSamplerSized
 StepWiseSamplerSized ()
 ~StepWiseSamplerSized () override
bool not_end () const override
 Check if reach the end of rotamer list. More...
core::Size const & id () const
virtual void fast_forward ()
virtual void set_id (core::Size const setting)
- Public Member Functions inherited from protocols::stepwise::sampler::StepWiseSampler
 StepWiseSampler ()
 ~StepWiseSampler () override
virtual bool random () const
 Check if is random modeler. More...
virtual void set_random (bool const setting)
 Set the random modeler state. More...
- Public Member Functions inherited from protocols::toolbox::SamplerPlusPlus
 SamplerPlusPlus ()
 ~SamplerPlusPlus () override
- Public Member Functions inherited from protocols::moves::Mover
 Mover ()
virtual MoverOP create ()
MoverCOP get_self_ptr () const
MoverOP get_self_ptr ()
MoverCAP get_self_weak_ptr () const
MoverAP get_self_weak_ptr ()
 Mover (std::string const &type_name)
 sets the type for a mover; name_ has been removed (2010/05/14) More...
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...
virtual MoverOP clone () const
 Return a clone of the Mover object. More...
virtual bool reinitialize_for_each_job () const
 Inform 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
 Inform 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...
virtual MoverOP fresh_instance () const
 Generates a new Mover object freshly created with the default ctor. More...
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...
void set_type (std::string const &setting)
 Set the 'type' string. More...
std::string get_type () const
void type (const std::string &type_in)
 Set the 'type' string. More...
std::string const & type () const
 Get the set 'type' string. More...
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 parse_my_tag (TagCOP tag, basic::datacache::DataMap &data)
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...
void set_current_job (protocols::jobdist::BasicJobCOP job)
jobdist::BasicJobCOP get_current_job () const
virtual void set_current_tag (std::string const &new_tag)
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...
virtual void show (std::ostream &output=std::cout) const
 Outputs details about the Mover, including current settings. More...
virtual core::Real last_proposal_density_ratio ()
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 void provide_citation_info (basic::citation_manager::CitationCollectionList &) const
 Provide citations to the passed CitationCollectionList Subclasses should add the info for themselves and any other classes they use. More...

Private Member Functions

std::pair< core::Size, core::Sizeid2state (core::Size const id) const
 Convert an id number to the sampler state pair. More...

Private Attributes

core::Size size_
std::pair< core::Size, core::Sizecurr_state_
utility::vector1< core::Sizesize_list_
< StepWiseSamplerSizedOP

Additional Inherited Members

- Public Types inherited from protocols::toolbox::SamplerPlusPlus
typedef utility::vector1
< core::Real
- Public Types inherited from protocols::moves::Mover
typedef utility::tag::TagCOP TagCOP
typedef core::pose::Pose Pose
typedef core::pose::PoseCOP PoseCOP
typedef std::list< std::string > Strings
- Static Public Member Functions inherited from protocols::moves::Mover
static std::string name ()
static void register_options ()
 Overload this static method if you access options within the mover. More...
- Protected Member Functions inherited from protocols::toolbox::SamplerPlusPlus
bool is_init () const
 return OP to the subsampler that controls exactly this torsion_id (assume only one). This is worked out in recces/sampler/MC_Sampler & derived classes – wouldn't be too hard to generalize to stepwise/sampler/ classes, too. More...
void set_init (bool const setting)
 Set the initialization state. More...
template<class T >
void set_and_reinit (T &params, T const &setting)
 Set value of a parameter, return to pre-init state. More...
- Protected Member Functions inherited from protocols::moves::Mover
void set_last_move_status (MoverStatus status)
 nonvirtual setter for MoverStatus last_status_. Protected means that only the mover itself will be able to change its own status. The job distributor (august 08 vintage) is aware of status set with this function and will do what the MoverStatus says. More...
- Protected Attributes inherited from protocols::stepwise::sampler::StepWiseSamplerSized
core::Size id_

Constructor & Destructor Documentation

protocols::stepwise::sampler::StepWiseSamplerSizedAny::StepWiseSamplerSizedAny ( )
protocols::stepwise::sampler::StepWiseSamplerSizedAny::~StepWiseSamplerSizedAny ( )

Member Function Documentation

virtual void protocols::stepwise::sampler::StepWiseSamplerSizedAny::add_external_loop_rotamer ( StepWiseSamplerSizedOP const &  rotamer)
void protocols::stepwise::sampler::StepWiseSamplerSizedAny::apply ( core::pose::Pose pose)
void protocols::stepwise::sampler::StepWiseSamplerSizedAny::apply ( core::pose::Pose pose,
core::Size const  i 
virtual void protocols::stepwise::sampler::StepWiseSamplerSizedAny::clear_rotamer ( )
std::string protocols::stepwise::sampler::StepWiseSamplerSizedAny::get_name ( ) const

Name of the class.

Reimplemented from protocols::stepwise::sampler::StepWiseSamplerSized.

std::pair< core::Size, core::Size > protocols::stepwise::sampler::StepWiseSamplerSizedAny::id2state ( core::Size const  id) const

Convert an id number to the sampler state pair.

References protocols::toolbox::SamplerPlusPlus::is_init(), size(), and size_list_.

Referenced by apply(), and operator++().

void protocols::stepwise::sampler::StepWiseSamplerSizedAny::init ( void  )
void protocols::stepwise::sampler::StepWiseSamplerSizedAny::operator++ ( )
void protocols::stepwise::sampler::StepWiseSamplerSizedAny::reset ( void  )
void protocols::stepwise::sampler::StepWiseSamplerSizedAny::show ( std::ostream &  out,
core::Size const  indent = 0 
) const
core::Size protocols::stepwise::sampler::StepWiseSamplerSizedAny::size ( ) const

Get the total number of rotamers in sampler.

Implements protocols::stepwise::sampler::StepWiseSamplerSized.

References protocols::toolbox::SamplerPlusPlus::is_init(), and size_.

Referenced by id2state(), and operator++().

toolbox::SamplerPlusPlusType protocols::stepwise::sampler::StepWiseSamplerSizedAny::type ( ) const

Type of class (see enum in SamplerPlusPlusTypes.hh)

Reimplemented from protocols::stepwise::sampler::StepWiseSamplerSized.

References protocols::toolbox::SIZED_ANY.

Member Data Documentation

std::pair<core::Size, core::Size> protocols::stepwise::sampler::StepWiseSamplerSizedAny::curr_state_

Referenced by apply(), operator++(), and reset().

utility::vector1<StepWiseSamplerSizedOP> protocols::stepwise::sampler::StepWiseSamplerSizedAny::rotamer_list_
core::Size protocols::stepwise::sampler::StepWiseSamplerSizedAny::size_

Referenced by init(), and size().

utility::vector1<core::Size> protocols::stepwise::sampler::StepWiseSamplerSizedAny::size_list_

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