Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Attributes | List of all members
protocols::simple_moves::bb_sampler::BBDihedralSamplerBase Class Reference

This class functions to hold, access, sample on, and set independent and dependent dihedral data. It is an abstract base class for particular types of data. More...

#include <BBDihedralSampler.hh>

Inheritance diagram for protocols::simple_moves::bb_sampler::BBDihedralSamplerBase:
Inheritance graph
[legend]

Public Member Functions

 BBDihedralSamplerBase ()
 
 BBDihedralSamplerBase (core::id::MainchainTorsionType torsion_type, BBSampleType sampling_type=probability)
 
 BBDihedralSamplerBase (BBDihedralSamplerBase const &src)
 
 ~BBDihedralSamplerBase () override
 
BBDihedralSamplerBaseOP clone () const
 
void set_torsion_type (core::id::MainchainTorsionType torsion_type)
 Set the torsion type we will be querying. More...
 
core::Size get_torsion_type () const
 
void set_sample_type (BBSampleType sampling_type)
 Set the sampling type. Default is to sample probabilistically on the data. More...
 
virtual std::string get_name () const
 

Protected Attributes

core::id::MainchainTorsionType torsion_type_
 
BBSampleType sampling_type_
 

Detailed Description

This class functions to hold, access, sample on, and set independent and dependent dihedral data. It is an abstract base class for particular types of data.

get_torsion functions should give either the minima on a set of data or sample via the probability If you are subclassing, you do not necessarily need to use the BBSampleType.

Feel free to implement more types. See the SugarBBSampler and RangedBBSampler as examples.

Technically - with now storing the torsion_types as core::Size (due to waay too many in sugars) - we can now remove the 'BB' part of this whole thing.

Constructor & Destructor Documentation

protocols::simple_moves::bb_sampler::BBDihedralSamplerBase::BBDihedralSamplerBase ( )
protocols::simple_moves::bb_sampler::BBDihedralSamplerBase::BBDihedralSamplerBase ( core::id::MainchainTorsionType  torsion_type,
BBSampleType  sampling_type = probability 
)
protocols::simple_moves::bb_sampler::BBDihedralSamplerBase::BBDihedralSamplerBase ( BBDihedralSamplerBase const &  src)
protocols::simple_moves::bb_sampler::BBDihedralSamplerBase::~BBDihedralSamplerBase ( )
overridedefault

Member Function Documentation

BBDihedralSamplerBaseOP protocols::simple_moves::bb_sampler::BBDihedralSamplerBase::clone ( ) const
virtual std::string protocols::simple_moves::bb_sampler::BBDihedralSamplerBase::get_name ( ) const
inlinevirtual
core::Size protocols::simple_moves::bb_sampler::BBDihedralSamplerBase::get_torsion_type ( ) const
inline

References torsion_type_.

void protocols::simple_moves::bb_sampler::BBDihedralSamplerBase::set_sample_type ( BBSampleType  sampling_type)
inline

Set the sampling type. Default is to sample probabilistically on the data.

References sampling_type_.

void protocols::simple_moves::bb_sampler::BBDihedralSamplerBase::set_torsion_type ( core::id::MainchainTorsionType  torsion_type)
inline

Set the torsion type we will be querying.

References torsion_type_.

Referenced by protocols::carbohydrates::GlycanSampler::randomize_glycan_torsions().

Member Data Documentation

BBSampleType protocols::simple_moves::bb_sampler::BBDihedralSamplerBase::sampling_type_
protected
core::id::MainchainTorsionType protocols::simple_moves::bb_sampler::BBDihedralSamplerBase::torsion_type_
protected

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