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:

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.

Definition at line 159 of file ContactMap.hh.

Constructor & Destructor Documentation

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

inline

Default constructor.

Definition at line 163 of file ContactMap.hh.

Member Function Documentation

void protocols::contact_map::Contact::add_distance

(

core::Real

distance)

Adds distance to the contact.

Definition at line 468 of file ContactMap.cc.

std::string protocols::contact_map::Contact::long_string_rep

(

core::Size

n_poses = 0)

Returns string representation of the Contact including partner names.

Definition at line 495 of file ContactMap.cc.

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

inline

Accessor functions for private class variables.

Definition at line 185 of file ContactMap.hh.

References partner1_.

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

inline

Definition at line 186 of file ContactMap.hh.

References partner2_.

void protocols::contact_map::Contact::reset_count

(

)

Resets count to 0.

Definition at line 473 of file ContactMap.cc.

std::string protocols::contact_map::Contact::string_rep

(

)

Returns string representation of the Contact.

Definition at line 478 of file ContactMap.cc.

std::string protocols::contact_map::Contact::string_rep

(

core::Size

n_poses)

Returns string representation of the Contact as percentage value.

Definition at line 486 of file ContactMap.cc.

Member Data Documentation

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

private

Definition at line 189 of file ContactMap.hh.

ContactPartner protocols::contact_map::Contact::partner1_

private

Definition at line 190 of file ContactMap.hh.

Referenced by partner1().

ContactPartner protocols::contact_map::Contact::partner2_

private

Definition at line 191 of file ContactMap.hh.

Referenced by partner2().

---

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

• src/protocols/contact_map/ContactMap.hh
• src/protocols/contact_map/ContactMap.cc