core::id::JumpID Class Reference

#include <JumpID.hh>

Public Member Functions
	JumpID ()
	Default constructor. More...
	JumpID (Size const rsd1_in, Size const rsd2_in)
	Property constructor. More...
Size	rsd1 () const
Size	rsd2 () const
Size &	rsd2 ()
bool	valid () const
	Is this id valid? More...

Private Attributes
Size	rsd1_
	Residue number within the complex. More...
Size	rsd2_

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.

References rsd1_, and rsd2_.

Member Function Documentation

Size core::id::JumpID::rsd1 ( ) const

inline

References rsd1_.

Size core::id::JumpID::rsd2 ( ) const

inline

References rsd2_.

Size& core::id::JumpID::rsd2 ( )

inline

References rsd2_.

bool core::id::JumpID::valid ( ) const

inline

Is this id valid?

Note

Must return false for BOGUS_TORSION_ID

References rsd1_, and rsd2_.

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

Member Data Documentation

Size core::id::JumpID::rsd1_

private

Residue number within the complex.

Referenced by JumpID(), core::id::operator<<(), rsd1(), and valid().

Size core::id::JumpID::rsd2_

private

Referenced by JumpID(), core::id::operator<<(), rsd2(), and valid().

---

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

• src/core/id/JumpID.hh