Rosetta 3.4
Public Member Functions | Static Public Member Functions | Friends
core::scoring::hbonds::HBond Class Reference

#include <HBondSet.hh>

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

List of all members.

Public Member Functions

 HBond (Size const dhatm, bool const dhatm_is_protein_backbone, bool const dres_is_protein, bool const dres_is_dna, bool const dhatm_is_backbone, Size const dres, Size const aatm, bool const aatm_is_protein_backbone, bool const ares_is_protein, bool const ares_is_dna, bool const aatm_is_backbone, Size const ares, HBEvalTuple const hbe_tuple, Real const energy_in, Real const weight_in, HBondDerivs const &derivs_in)
Size don_res () const
Size don_hatm () const
bool don_hatm_is_protein_backbone () const
 needed for silly allow logic
bool don_res_is_protein () const
bool don_res_is_dna () const
bool don_hatm_is_backbone () const
 needed for silly allow logic
Size acc_res () const
Size acc_atm () const
bool acc_atm_is_protein_backbone () const
 needed for silly allow logic
bool acc_res_is_protein () const
bool acc_res_is_dna () const
bool acc_atm_is_backbone () const
 needed for silly allow logic
Real energy () const
 NOTE: this is unweighted energy, see weight() for the weight.
Real weight () const
HBondDerivs const & derivs () const
HBEvalType eval_type () const
 The HBEval type encodes the evaluation type as a single enum value.
HBEvalTuple const & eval_tuple () const
 The HBEvalTuple is a tuple of enums for each dimension of the evaluation type.
bool atom_is_donorH (id::AtomID const &atom) const
bool atom_is_acceptor (id::AtomID const &atom) const
void show (std::ostream &out) const
 a bare bones description of the data contained in the hbond object
void show (pose::Pose const &pose, bool const print_header, std::ostream &out) const
 a prettier, more interpretable description of an hbond, including pdb identified residues and the geometric dimensions of the hydrogen bond.
void show (pose::Pose const &pose, bool const print_header=true) const

Static Public Member Functions

static bool hbond_energy_comparer (HBondCOP a, HBondCOP b)

Friends

std::ostream & operator<< (std::ostream &out, const HBond &hbond)
bool operator== (HBond const &a, HBond const &b)

Constructor & Destructor Documentation

core::scoring::hbonds::HBond::HBond ( Size const  dhatm,
bool const  dhatm_is_protein_backbone,
bool const  dres_is_protein,
bool const  dres_is_dna,
bool const  dhatm_is_backbone,
Size const  dres,
Size const  aatm,
bool const  aatm_is_protein_backbone,
bool const  ares_is_protein,
bool const  ares_is_dna,
bool const  aatm_is_backbone,
Size const  ares,
HBEvalTuple const  hbe_tuple,
Real const  energy_in,
Real const  weight_in,
HBondDerivs const &  derivs_in 
)

Member Function Documentation

Size core::scoring::hbonds::HBond::acc_atm ( ) const
bool core::scoring::hbonds::HBond::acc_atm_is_backbone ( ) const

needed for silly allow logic

bool core::scoring::hbonds::HBond::acc_atm_is_protein_backbone ( ) const

needed for silly allow logic

Referenced by core::scoring::hbonds::HBondSet::allow_hbond().

Size core::scoring::hbonds::HBond::acc_res ( ) const
bool core::scoring::hbonds::HBond::acc_res_is_dna ( ) const
bool core::scoring::hbonds::HBond::acc_res_is_protein ( ) const
bool core::scoring::hbonds::HBond::atom_is_acceptor ( id::AtomID const &  atom) const
bool core::scoring::hbonds::HBond::atom_is_donorH ( id::AtomID const &  atom) const
HBondDerivs const & core::scoring::hbonds::HBond::derivs ( ) const
Size core::scoring::hbonds::HBond::don_hatm ( ) const
bool core::scoring::hbonds::HBond::don_hatm_is_backbone ( ) const

needed for silly allow logic

bool core::scoring::hbonds::HBond::don_hatm_is_protein_backbone ( ) const

needed for silly allow logic

Referenced by core::scoring::hbonds::HBondSet::allow_hbond().

Size core::scoring::hbonds::HBond::don_res ( ) const
bool core::scoring::hbonds::HBond::don_res_is_dna ( ) const
bool core::scoring::hbonds::HBond::don_res_is_protein ( ) const
Real core::scoring::hbonds::HBond::energy ( ) const
HBEvalTuple const & core::scoring::hbonds::HBond::eval_tuple ( ) const

The HBEvalTuple is a tuple of enums for each dimension of the evaluation type.

HBEvalType core::scoring::hbonds::HBond::eval_type ( ) const
bool core::scoring::hbonds::HBond::hbond_energy_comparer ( HBondCOP  a,
HBondCOP  b 
) [static]
void core::scoring::hbonds::HBond::show ( std::ostream &  out) const

a bare bones description of the data contained in the hbond object

References core::scoring::hbonds::HBEvalTuple::eval_type().

Referenced by core::scoring::hbonds::operator<<(), and core::scoring::hbonds::HBondSet::show().

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

References show().

Referenced by show().

Real core::scoring::hbonds::HBond::weight ( ) const

Friends And Related Function Documentation

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

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