Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Attributes | Friends | List of all members
core::id::DOF_ID Class Reference

Kinematics DOF identifier class. More...

#include <DOF_ID.hh>

Public Member Functions

constexpr DOF_ID ()
 
 DOF_ID (AtomID const &atom_id_in, DOF_Type const &type_in)
 
AtomID const & atom_id () const
 
Size rsd () const
 
Size atomno () const
 
DOF_Type type () const
 
bool valid () const
 Is this DOF_ID valid? More...
 

Static Public Member Functions

static constexpr DOF_ID BOGUS_DOF_ID ()
 

Private Attributes

AtomID atom_id_
 Atom identifier. More...
 
DOF_Type type_
 DOF type. More...
 

Friends

std::ostream & operator<< (std::ostream &os, DOF_ID const &a)
 stream << DOF_ID More...
 
bool operator== (DOF_ID const &a, DOF_ID const &b)
 
bool operator!= (DOF_ID const &a, DOF_ID const &b)
 
bool operator< (DOF_ID const &a, DOF_ID const &b)
 

Detailed Description

Kinematics DOF identifier class.

Constructor & Destructor Documentation

constexpr core::id::DOF_ID::DOF_ID ( )
inline

Referenced by BOGUS_DOF_ID().

core::id::DOF_ID::DOF_ID ( AtomID const &  atom_id_in,
DOF_Type const &  type_in 
)
inline

Member Function Documentation

AtomID const& core::id::DOF_ID::atom_id ( ) const
inline
Size core::id::DOF_ID::atomno ( ) const
inline
static constexpr DOF_ID core::id::DOF_ID::BOGUS_DOF_ID ( )
inlinestatic
Size core::id::DOF_ID::rsd ( ) const
inline
DOF_Type core::id::DOF_ID::type ( ) const
inline
bool core::id::DOF_ID::valid ( ) const
inline

Friends And Related Function Documentation

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

stream << DOF_ID

bool operator== ( DOF_ID const &  a,
DOF_ID const &  b 
)
friend

Member Data Documentation

AtomID core::id::DOF_ID::atom_id_
private

Atom identifier.

Referenced by atom_id(), atomno(), rsd(), and valid().

DOF_Type core::id::DOF_ID::type_
private

DOF type.

Referenced by type().


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