core::id::JumpID Class Reference

#include <JumpID.hh>

Collaboration diagram for core::id::JumpID:

List of all members.

Public Member Functions
	JumpID ()
	Default constructor.
	JumpID (Size const rsd1_in, Size const rsd2_in)
	Property constructor.
Size	rsd1 () const
Size &	rsd2 ()
bool	valid () const
	Is this id valid?
Friends
std::ostream &	operator<< (std::ostream &os, JumpID const &a)
bool	operator== (JumpID const &a, JumpID const &b)
bool	operator!= (JumpID const &a, JumpID const &b)
bool	operator< (JumpID const &a, JumpID const &b)

---

Detailed Description

/brief Torsion identifier class

Note the order of the elements in construction calls:

( residue, type, torsion )

sort of from least to most specific

---

Constructor & Destructor Documentation

core::id::JumpID::JumpID

(

)

[inline]

Default constructor.

core::id::JumpID::JumpID	(	Size const	rsd1_in,
		Size const	rsd2_in
	)		[inline]

Property constructor.

---

Member Function Documentation

Size core::id::JumpID::rsd1

(

)

const [inline]

Size& core::id::JumpID::rsd2

(

)

[inline]

bool core::id::JumpID::valid

(

)

const [inline]

Is this id valid?

Note:

Must return false for BOGUS_TORSION_ID

---

Friends And Related Function Documentation

bool operator!=	(	JumpID const &	a,
		JumpID const &	b
	)		[friend]

bool operator<	(	JumpID const &	a,
		JumpID const &	b
	)		[friend]

std::ostream& operator<<	(	std::ostream &	os,
		JumpID const &	a
	)		[friend]

bool operator==	(	JumpID const &	a,
		JumpID const &	b
	)		[friend]

---

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

• src/core/id/JumpID.hh