Rosetta Core  2014.35
Public Member Functions | Private Attributes | Friends | List of all members
core::id::TorsionID Class Reference

Torsion identifier class. More...

#include <TorsionID.hh>

Public Member Functions

 TorsionID ()
 Default constructor. More...
 
 TorsionID (TorsionID const &src)
 Copy constructor. More...
 
 TorsionID (Size const rsd_in, TorsionType const &type_in, Size const torsion_in)
 Property constructor. More...
 
Size rsd () const
 
Sizersd ()
 
TorsionType type () const
 
TorsionTypetype ()
 
uint torsion () const
 
Sizetorsion ()
 
bool valid () const
 Is this id valid? More...
 

Private Attributes

Size rsd_
 Residue number within the complex. More...
 
TorsionType type_
 The type (BB,CHI,JUMP) of this torsion. More...
 
Size torsion_
 Torsion number of the given type within the residue. More...
 

Friends

std::ostream & operator<< (std::ostream &os, TorsionID const &a)
 
bool operator== (TorsionID const &a, TorsionID const &b)
 
bool operator!= (TorsionID const &a, TorsionID const &b)
 
bool operator< (TorsionID const &a, TorsionID const &b)
 

Detailed Description

Torsion identifier class.

Consider a few examples to get a better picture for how torsions are uniquely identified:

#include <core/id/types.hh>
TorsionID(253, BB, 1) // Phi backbone torsion of residue 253.
TorsionID(253, BB, 2) // Psi backbone torsion of residue 253.
TorsionID(253, BB, 3) // Omega backbone torsion of residue 253.

Note the order of the elements in construction calls (residue, type, torsion) go from least to most specific.

Constructor & Destructor Documentation

core::id::TorsionID::TorsionID ( )
inline

Default constructor.

core::id::TorsionID::TorsionID ( TorsionID const &  src)
inline

Copy constructor.

core::id::TorsionID::TorsionID ( Size const  rsd_in,
TorsionType const &  type_in,
Size const  torsion_in 
)
inline

Property constructor.

Member Function Documentation

Size core::id::TorsionID::rsd ( ) const
inline
Size& core::id::TorsionID::rsd ( )
inline

References rsd_.

uint core::id::TorsionID::torsion ( ) const
inline
Size& core::id::TorsionID::torsion ( )
inline

References torsion_.

TorsionType core::id::TorsionID::type ( ) const
inline
TorsionType& core::id::TorsionID::type ( )
inline

References type_.

bool core::id::TorsionID::valid ( ) const
inline

Friends And Related Function Documentation

bool operator!= ( TorsionID const &  a,
TorsionID const &  b 
)
friend
bool operator< ( TorsionID const &  a,
TorsionID const &  b 
)
friend
std::ostream& operator<< ( std::ostream &  os,
TorsionID const &  a 
)
friend
bool operator== ( TorsionID const &  a,
TorsionID const &  b 
)
friend

Member Data Documentation

Size core::id::TorsionID::rsd_
private

Residue number within the complex.

Referenced by rsd(), and valid().

Size core::id::TorsionID::torsion_
private

Torsion number of the given type within the residue.

Referenced by torsion(), and valid().

TorsionType core::id::TorsionID::type_
private

The type (BB,CHI,JUMP) of this torsion.

Referenced by type().


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