 |
|
IMP Reference Guide
2.23.0
The Integrative Modeling Platform
|
Base class for sampling certain combinations of degrees of freedom. More...
#include <IMP/kinematics/DOFsSampler.h>
Inheritance diagram for IMP::kinematics::DOFsSampler:Base class for sampling certain combinations of degrees of freedom.
Definition at line 17 of file DOFsSampler.h.
Public Member Functions | |
| DOFsSampler (DOFs dofs) | |
| Constructs the dofs sampler over specified dofs. More... | |
| virtual void | apply (const DOFValues &values)=0 |
| void | apply_last_sample () |
| DOF const * | get_dof (unsigned int i) const |
| Returns the i'th dof over which this sampler works. More... | |
| DOFs const & | get_dofs () const |
| Returns the dofs over which this sampler works. More... | |
| unsigned int | get_number_of_dofs () const |
| DOFValues | get_sample () const |
| virtual std::string | get_type_name () const override |
| virtual ::IMP::VersionInfo | get_version_info () const override |
| Get information about the module and version of the object. More... | |
| void | sample_and_apply () |
| Public Member Functions inherited from IMP::Object | |
| virtual void | clear_caches () |
| CheckLevel | get_check_level () const |
| LogLevel | get_log_level () const |
| void | set_check_level (CheckLevel l) |
| void | set_log_level (LogLevel l) |
| Set the logging level used in this object. More... | |
| void | set_was_used (bool tf) const |
| void | show (std::ostream &out=std::cout) const |
| const std::string & | get_name () const |
| void | set_name (std::string name) |
Protected Member Functions | |
| virtual DOFValues | do_get_sample () const =0 |
| Protected Member Functions inherited from IMP::Object | |
| Object (std::string name) | |
| Construct an object with the given name. More... | |
| virtual void | do_destroy () |
| IMP::kinematics::DOFsSampler::DOFsSampler | ( | DOFs | dofs | ) |
Constructs the dofs sampler over specified dofs.
Definition at line 22 of file DOFsSampler.h.
|
pure virtual |
apply set of dof values in values over objects associated with this DOFsSampler (e.g., joints)
Implemented in IMP::kinematics::FibrilSampler, and IMP::kinematics::UniformBackboneSampler.
| void IMP::kinematics::DOFsSampler::apply_last_sample | ( | ) |
calls apply(), using values from the last sample returned by get_sample() (or values of initial dofs provided to constructor, if no sample was taken yet)
Definition at line 46 of file DOFsSampler.h.
| DOF const* IMP::kinematics::DOFsSampler::get_dof | ( | unsigned int | i | ) | const |
Returns the i'th dof over which this sampler works.
Definition at line 59 of file DOFsSampler.h.
| DOFs const& IMP::kinematics::DOFsSampler::get_dofs | ( | ) | const |
Returns the dofs over which this sampler works.
Definition at line 56 of file DOFsSampler.h.
| DOFValues IMP::kinematics::DOFsSampler::get_sample | ( | ) | const |
Definition at line 28 of file DOFsSampler.h.
|
overridevirtual |
Get information about the module and version of the object.
Reimplemented from IMP::Object.
Definition at line 18 of file DOFsSampler.h.
| void IMP::kinematics::DOFsSampler::sample_and_apply | ( | ) |
make a new sample of the dofs over which this class samples, and apply them to objects associated with this sampler (e.g. joints)
Definition at line 53 of file DOFsSampler.h.