Rosetta 3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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>

Collaboration diagram for protocols::contact_map::Contact:
Collaboration graph
[legend]

Public Member Functions

 Contact (ContactPartner p1=ContactPartner(), ContactPartner p2=ContactPartner())
 Default constructor. 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 ()
 Returns string representation of the Contact. More...
 
std::string string_rep (core::Size n_poses)
 Returns string representation of the Contact as percentage value. More...
 
std::string long_string_rep (core::Size n_poses=0)
 Returns string representation of the Contact including partner names. More...
 
ContactPartnerAP partner1 ()
 Accessor functions for private class variables. More...
 
ContactPartnerAP partner2 ()
 

Private Attributes

core::Size count_
 
ContactPartner partner1_
 
ContactPartner partner2_
 

Detailed Description

Simple class representing a contact between two atoms.

Constructor & Destructor Documentation

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

Default constructor.

Member Function Documentation

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

Adds distance to the contact.

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

Returns string representation of the Contact including partner names.

ContactPartnerAP protocols::contact_map::Contact::partner1 ( )
inline

Accessor functions for private class variables.

References partner1_.

ContactPartnerAP protocols::contact_map::Contact::partner2 ( )
inline

References partner2_.

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

Resets count to 0.

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

Returns string representation of the Contact.

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

Returns string representation of the Contact as percentage value.

Member Data Documentation

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

Referenced by partner1().

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

Referenced by partner2().


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