Rosetta 3.4
Public Types | Public Member Functions | Friends
core::scoring::hbonds::HBondSet Class Reference

#include <HBondSet.hh>

Inheritance diagram for core::scoring::hbonds::HBondSet:
Inheritance graph
[legend]
Collaboration diagram for core::scoring::hbonds::HBondSet:
Collaboration graph
[legend]

List of all members.

Public Types

typedef id::AtomID AtomID

Public Member Functions

 HBondSet ()
 ~HBondSet ()
 HBondSet (Size const nres)
 HBondSet (HBondOptions const &options)
 HBondSet (HBondOptions const &options, Size const nres)
 HBondSet (pose::Pose &pose)
 convenience constructor: Find all the hbonds in the pose.
 HBondSet (HBondOptions const &options, pose::Pose &pose)
 convenience constructor: Find all the hbonds in the pose.
 HBondSet (HBondSet const &src)
 copy ctor
 HBondSet (HBondSet const &src, utility::vector1< core::Size > exclude_list)
 copy ctor
 HBondSet (HBondSet const &src, utility::vector1< bool > residue_mask)
 copy ctor
 HBondSet (HBondSet const &src, Size seqpos)
 copy ctor
basic::datacache::CacheableDataOP clone () const
 Clone this object.
Size nhbonds () const
 Number of hbonds.
int nbrs (Size const seqpos) const
void set_nbrs (Size const seqpos, Size value)
HBond const & hbond (Size const number) const
 Access hbond.
void append_hbond (Size const dhatm, conformation::Residue const &don_rsd, Size const aatm, conformation::Residue const &acc_rsd, HBEvalTuple const &hbe_tuple, Real const energy, Real const weight, HBondDerivs const &deriv)
 Add a new hbond to the list updates the "hbchk" array as necessary.
bool allow_hbond (Size const index) const
 Is this hbond allowed under the bb-bb exclusion scheme?
bool allow_hbond (HBond const &hbond) const
bool acc_bbg_in_bb_bb_hbond (Size const residue) const
 is the backbone bone acceptor group in a bb/bb hydrogen bond?
bool don_bbg_in_bb_bb_hbond (Size const residue) const
 is the backbone bone donor group in a bb/bb hydrogen bond?
void set_backbone_backbone_acceptor (Size const residue, bool state)
 set the state of backbone-backbone acceptor. Used for symmetry.
void set_backbone_backbone_donor (Size const residue, bool state)
 set the state of backbone-backbone donor. Used for symmetry.
void setup_atom_map () const
 Setup the mapping from atoms to hbonds.
utility::vector1< HBondCOP >
const & 
atom_hbonds (AtomID const &atom) const
 Get a vector of all the hbonds involving this atom.
void clear ()
 Delete all the data.
void resize_bb_donor_acceptor_arrays (Size const new_dimension)
 Resize bb info arrays.
void copy_bb_donor_acceptor_arrays (HBondSet const &src)
void setup_for_residue_pair_energies (pose::Pose const &pose, bool const calculate_derivative=false, bool const backbone_only=true)
void sort_by_weighted_energy ()
HBondOptions const & hbond_options () const
 Read access to the stored hbond options.
void set_hbond_options (HBondOptions const &options)
 set the hbond options for this hbond set; clears all hbonds already stored
void show (std::ostream &out) const
 Print just the information stored in each individual hbond.
void show () const
void show (pose::Pose const &pose, bool const print_header, std::ostream &out) const
 Print nicely formated summary of the hbonds and their geometry in the pose.
void show (pose::Pose const &pose, bool const print_header=true) const
void show (pose::Pose const &pose, Size const residue, bool const print_header, std::ostream &out) const
 Print nicely formated summary of all the hbonds to a specific residue.
void show (pose::Pose const &pose, Size const residue, bool const print_header=true) const

Friends

std::ostream & operator<< (std::ostream &out, const HBondSet &hbond_set)
bool operator== (HBondSet const &a, HBondSet const &b)
 equality operator

Member Typedef Documentation


Constructor & Destructor Documentation

core::scoring::hbonds::HBondSet::HBondSet ( )

Referenced by clone().

core::scoring::hbonds::HBondSet::~HBondSet ( )
core::scoring::hbonds::HBondSet::HBondSet ( Size const  nres)
core::scoring::hbonds::HBondSet::HBondSet ( HBondOptions const &  options)
core::scoring::hbonds::HBondSet::HBondSet ( HBondOptions const &  options,
Size const  nres 
)
core::scoring::hbonds::HBondSet::HBondSet ( pose::Pose pose)

convenience constructor: Find all the hbonds in the pose.

convenience constructor. If you need more controlled construction please use one of the other constructors

The pose must be non-const because the neighbor graph may need to be initialized.

References setup_for_residue_pair_energies(), and core::pose::Pose::update_residue_neighbors().

core::scoring::hbonds::HBondSet::HBondSet ( HBondOptions const &  opts,
pose::Pose pose 
)

convenience constructor: Find all the hbonds in the pose.

convenience constructor. If you need more controlled construction please use one of the other constructors

The pose must be non-const because the neighbor graph may need to be initialized.

References setup_for_residue_pair_energies(), and core::pose::Pose::update_residue_neighbors().

core::scoring::hbonds::HBondSet::HBondSet ( HBondSet const &  src)

copy ctor

core::scoring::hbonds::HBondSet::HBondSet ( HBondSet const &  src,
utility::vector1< core::Size exclude_list 
)
core::scoring::hbonds::HBondSet::HBondSet ( HBondSet const &  src,
utility::vector1< bool residue_mask 
)
core::scoring::hbonds::HBondSet::HBondSet ( HBondSet const &  src,
Size  seqpos 
)

Member Function Documentation

bool core::scoring::hbonds::HBondSet::acc_bbg_in_bb_bb_hbond ( Size const  residue) const
bool core::scoring::hbonds::HBondSet::allow_hbond ( Size const  index) const
bool core::scoring::hbonds::HBondSet::allow_hbond ( HBond const &  hbond) const
void core::scoring::hbonds::HBondSet::append_hbond ( Size const  dhatm,
conformation::Residue const &  don_rsd,
Size const  aatm,
conformation::Residue const &  acc_rsd,
HBEvalTuple const &  hbe_tuple,
Real const  energy,
Real const  weight,
HBondDerivs const &  deriv 
)
utility::vector1< HBondCOP > const & core::scoring::hbonds::HBondSet::atom_hbonds ( AtomID const &  atom) const

Get a vector of all the hbonds involving this atom.

References setup_atom_map().

Referenced by core::scoring::methods::WaterAdductHBondEnergy::get_atom_h2o_hbond_derivative().

void core::scoring::hbonds::HBondSet::clear ( )
basic::datacache::CacheableDataOP core::scoring::hbonds::HBondSet::clone ( ) const

Clone this object.

clone this object

References HBondSet().

void core::scoring::hbonds::HBondSet::copy_bb_donor_acceptor_arrays ( HBondSet const &  src)
bool core::scoring::hbonds::HBondSet::don_bbg_in_bb_bb_hbond ( Size const  residue) const
HBond const & core::scoring::hbonds::HBondSet::hbond ( Size const  number) const
HBondOptions const & core::scoring::hbonds::HBondSet::hbond_options ( ) const
int core::scoring::hbonds::HBondSet::nbrs ( Size const  seqpos) const
Size core::scoring::hbonds::HBondSet::nhbonds ( ) const
void core::scoring::hbonds::HBondSet::resize_bb_donor_acceptor_arrays ( Size const  new_dimension)

Resize bb info arrays.

Referenced by append_hbond(), HBondSet(), and setup_for_residue_pair_energies().

void core::scoring::hbonds::HBondSet::set_backbone_backbone_acceptor ( Size const  residue,
bool  state 
) [inline]

set the state of backbone-backbone acceptor. Used for symmetry.

void core::scoring::hbonds::HBondSet::set_backbone_backbone_donor ( Size const  residue,
bool  state 
) [inline]

set the state of backbone-backbone donor. Used for symmetry.

void core::scoring::hbonds::HBondSet::set_hbond_options ( HBondOptions const &  options)

set the hbond options for this hbond set; clears all hbonds already stored

References clear().

Referenced by core::scoring::WaterAdductHBondPotential::fill_h2o_hbond_set().

void core::scoring::hbonds::HBondSet::set_nbrs ( Size const  seqpos,
Size  value 
)
void core::scoring::hbonds::HBondSet::setup_atom_map ( ) const
void core::scoring::hbonds::HBondSet::setup_for_residue_pair_energies ( pose::Pose const &  pose,
bool const  calculate_derivative = false,
bool const  backbone_only = true 
)
void core::scoring::hbonds::HBondSet::show ( pose::Pose const &  pose,
bool const  print_header,
std::ostream &  out 
) const

Print nicely formated summary of the hbonds and their geometry in the pose.

Optionally print a header, and then a row for each hydrogen bond in the set using the iterprable version of the hbond show format formatted for easy parsing by R, Excel, etc.

References hbond(), nhbonds(), and core::scoring::hbonds::HBond::show().

void core::scoring::hbonds::HBondSet::show ( ) const [inline]

References show().

Referenced by show().

void core::scoring::hbonds::HBondSet::show ( std::ostream &  out) const

Print just the information stored in each individual hbond.

References hbond(), and nhbonds().

Referenced by core::scoring::hbonds::operator<<().

void core::scoring::hbonds::HBondSet::show ( pose::Pose const &  pose,
bool const  print_header = true 
) const [inline]

References show().

Referenced by show().

void core::scoring::hbonds::HBondSet::show ( pose::Pose const &  pose,
Size const  residue_number,
bool const  print_header,
std::ostream &  out 
) const

Print nicely formated summary of all the hbonds to a specific residue.

Optionally print a header, and then a row for each hydrogen bond in the set using the iterprable version of the hbond show format formatted for easy parsing by R, Excel, etc.

References core::scoring::hbonds::HBond::acc_res(), hbond(), nhbonds(), and core::scoring::hbonds::HBond::show().

void core::scoring::hbonds::HBondSet::show ( pose::Pose const &  pose,
Size const  residue,
bool const  print_header = true 
) const [inline]

References show().

Referenced by show().

void core::scoring::hbonds::HBondSet::sort_by_weighted_energy ( )

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out,
const HBondSet hbond_set 
) [friend]
bool operator== ( HBondSet const &  a,
HBondSet const &  b 
) [friend]

equality operator


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines