Rosetta Protocols  2014.35
Public Member Functions | Private Attributes | List of all members
protocols::loops::LoopFromFileData Class Reference

#include <LoopsFileIO.hh>

Public Member Functions

 LoopFromFileData ()
 
 LoopFromFileData (ResidueIndexDescriptionFromFile const &start_res, ResidueIndexDescriptionFromFile const &cutpoint_res, ResidueIndexDescriptionFromFile const &end_res, core::Real skip_rate, bool extended, bool prohibit_single_residue_loops=true)
 
 LoopFromFileData (SerializedLoop const &loop, std::string const &fname, bool prohibit_single_residue_loops=true)
 constructed the other way around (for the the PoseNumberedLoopReader) More...
 
SerializedLoop resolve_as_serialized_loop_from_pose (core::pose::Pose const &pose) const
 loop-index resolution function: construct a SerializedLoopData object by possibly retrieving data from a Pose. This function also performs the loop-index checks performed by the PoseNumberedLoopFileReader. More...
 
ResidueIndexDescriptionFromFile
const & 
start_res () const
 
void start_res (ResidueIndexDescriptionFromFile const &setting)
 
ResidueIndexDescriptionFromFile
const & 
cutpoint_res () const
 
void cutpoint_res (ResidueIndexDescriptionFromFile const &setting)
 
ResidueIndexDescriptionFromFile
const & 
end_res () const
 
void end_res (ResidueIndexDescriptionFromFile const &setting)
 
core::Real skip_rate () const
 
void skip_rate (core::Real setting)
 
bool extended () const
 
void extended (bool setting)
 
bool prohibit_single_residue_loops () const
 
void prohibit_single_residue_loops (bool setting)
 

Private Attributes

ResidueIndexDescriptionFromFile start_res_
 
ResidueIndexDescriptionFromFile cutpoint_res_
 
ResidueIndexDescriptionFromFile end_res_
 
core::Real skip_rate_
 
bool extended_
 
bool prohibit_single_residue_loops_
 

Constructor & Destructor Documentation

protocols::loops::LoopFromFileData::LoopFromFileData ( )
protocols::loops::LoopFromFileData::LoopFromFileData ( ResidueIndexDescriptionFromFile const &  start_res,
ResidueIndexDescriptionFromFile const &  cutpoint_res,
ResidueIndexDescriptionFromFile const &  end_res,
core::Real  skip_rate,
bool  extended,
bool  prohibit_single_residue_loops = true 
)
protocols::loops::LoopFromFileData::LoopFromFileData ( SerializedLoop const &  loop,
std::string const &  fname,
bool  prohibit_single_residue_loops = true 
)

constructed the other way around (for the the PoseNumberedLoopReader)

References extended.

Member Function Documentation

ResidueIndexDescriptionFromFile const& protocols::loops::LoopFromFileData::cutpoint_res ( ) const
inline
void protocols::loops::LoopFromFileData::cutpoint_res ( ResidueIndexDescriptionFromFile const &  setting)
inline

References cutpoint_res_.

ResidueIndexDescriptionFromFile const& protocols::loops::LoopFromFileData::end_res ( ) const
inline
void protocols::loops::LoopFromFileData::end_res ( ResidueIndexDescriptionFromFile const &  setting)
inline

References end_res_.

bool protocols::loops::LoopFromFileData::extended ( ) const
inline
void protocols::loops::LoopFromFileData::extended ( bool  setting)
inline

References extended_.

bool protocols::loops::LoopFromFileData::prohibit_single_residue_loops ( ) const
inline
void protocols::loops::LoopFromFileData::prohibit_single_residue_loops ( bool  setting)
inline
SerializedLoop protocols::loops::LoopFromFileData::resolve_as_serialized_loop_from_pose ( core::pose::Pose const &  pose) const

loop-index resolution function: construct a SerializedLoopData object by possibly retrieving data from a Pose. This function also performs the loop-index checks performed by the PoseNumberedLoopFileReader.

Convert from the information read from the loop-definition file into residue indices that make sense in the context of this pose, and validate the input loop definition (i.e. that the index of the start residue is less than the index of the end residue ).

References cutpoint_res_, end_res_, extended_, protocols::loops::ResidueIndexDescriptionFromFile::fname(), protocols::loops::ResidueIndexDescriptionFromFile::linenum(), prohibit_single_residue_loops_, protocols::loops::ResidueIndexDescriptionFromFile::resolve_index(), skip_rate_, protocols::loops::SerializedLoop::start, start_res_, and protocols::loops::validate_loop_start_stop().

core::Real protocols::loops::LoopFromFileData::skip_rate ( ) const
inline
void protocols::loops::LoopFromFileData::skip_rate ( core::Real  setting)
inline

References skip_rate_.

ResidueIndexDescriptionFromFile const& protocols::loops::LoopFromFileData::start_res ( ) const
inline
void protocols::loops::LoopFromFileData::start_res ( ResidueIndexDescriptionFromFile const &  setting)
inline

References start_res_.

Member Data Documentation

ResidueIndexDescriptionFromFile protocols::loops::LoopFromFileData::cutpoint_res_
private
ResidueIndexDescriptionFromFile protocols::loops::LoopFromFileData::end_res_
private
bool protocols::loops::LoopFromFileData::extended_
private
bool protocols::loops::LoopFromFileData::prohibit_single_residue_loops_
private
core::Real protocols::loops::LoopFromFileData::skip_rate_
private
ResidueIndexDescriptionFromFile protocols::loops::LoopFromFileData::start_res_
private

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