Rosetta
Public Member Functions | Private Attributes | List of all members
protocols::contact_map::Contact Class Reference

Simple class representing a contact between two atoms. More...

#include <ContactMap.hh>

Public Member Functions

 Contact (ContactPartner const &p1=ContactPartner(), ContactPartner const &p2=ContactPartner())
 Default constructor. More...
 
void add_distance ()
 Adds distance to the contact. More...
 
void add_distance (core::Real distance)
 Adds distance to the contact. More...
 
void reset_count ()
 Resets count to 0. More...
 
std::string string_rep () const
 Returns string representation of the Contact. More...
 
std::string string_rep (core::Size n_poses) const
 Returns string representation of the Contact as percentage value. More...
 
std::string long_string_rep (core::Size n_poses=0) const
 Returns string representation of the Contact including partner names. More...
 
ContactPartnerpartner1 ()
 Accessor functions for private class variables. More...
 
ContactPartnerpartner2 ()
 

Private Attributes

ContactPartner partner1_
 
ContactPartner partner2_
 
core::Size count_
 
core::Real distance_
 

Detailed Description

Simple class representing a contact between two atoms.

Constructor & Destructor Documentation

◆ Contact()

protocols::contact_map::Contact::Contact ( ContactPartner const &  p1 = ContactPartner(),
ContactPartner const &  p2 = ContactPartner() 
)
inline

Default constructor.

Member Function Documentation

◆ add_distance() [1/2]

void protocols::contact_map::Contact::add_distance ( )

Adds distance to the contact.

◆ add_distance() [2/2]

void protocols::contact_map::Contact::add_distance ( core::Real  distance)

Adds distance to the contact.

◆ long_string_rep()

std::string protocols::contact_map::Contact::long_string_rep ( core::Size  n_poses = 0) const

Returns string representation of the Contact including partner names.

◆ partner1()

ContactPartner* protocols::contact_map::Contact::partner1 ( )
inline

Accessor functions for private class variables.

References partner1_.

◆ partner2()

ContactPartner* protocols::contact_map::Contact::partner2 ( )
inline

References partner2_.

◆ reset_count()

void protocols::contact_map::Contact::reset_count ( )

Resets count to 0.

◆ string_rep() [1/2]

std::string protocols::contact_map::Contact::string_rep ( ) const

Returns string representation of the Contact.

Referenced by protocols::contact_map::ContactMap::write_to_stream().

◆ string_rep() [2/2]

std::string protocols::contact_map::Contact::string_rep ( core::Size  n_poses) const

Returns string representation of the Contact as percentage value.

Member Data Documentation

◆ count_

core::Size protocols::contact_map::Contact::count_
private

◆ distance_

core::Real protocols::contact_map::Contact::distance_
private

◆ partner1_

ContactPartner protocols::contact_map::Contact::partner1_
private

Referenced by partner1().

◆ partner2_

ContactPartner protocols::contact_map::Contact::partner2_
private

Referenced by partner2().


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