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...
ContactPartner *	partner1 ()
	Accessor functions for private class variables. More...
ContactPartner *	partner2 ()

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

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

inline

Default constructor.

Member Function Documentation

void protocols::contact_map::Contact::add_distance

(

)

Adds distance to the contact.

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

)

const

Returns string representation of the Contact including partner names.

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

inline

Accessor functions for private class variables.

References partner1_.

ContactPartner* 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

(

)

const

Returns string representation of the Contact.

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

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

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

private

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

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:

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