core::id::DOF_ID Class Reference

Kinematics DOF identifier class. More...

#include <DOF_ID.hh>

Collaboration diagram for core::id::DOF_ID:

Public Member Functions
	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...

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.

Definition at line 40 of file DOF_ID.hh.

Constructor & Destructor Documentation

core::id::DOF_ID::DOF_ID ( )

inline

Definition at line 45 of file DOF_ID.hh.

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

inline

Definition at line 47 of file DOF_ID.hh.

Member Function Documentation

AtomID const& core::id::DOF_ID::atom_id ( ) const

inline

Definition at line 59 of file DOF_ID.hh.

References atom_id_.

Referenced by core::scoring::symmetry::SymmetricScoreFunction::eval_dof_derivative(), core::scoring::ScoreFunction::eval_dof_derivative(), core::pose::Pose::has_dof(), and core::id::operator<<().

Size core::id::DOF_ID::atomno ( ) const

inline

Definition at line 67 of file DOF_ID.hh.

References atom_id_, and core::id::AtomID::atomno().

Referenced by core::pack::scmin::AtomTreeSCMinMinimizerMap::add_atom(), core::pack::scmin::AtomTreeSCMinMinimizerMap::add_torsion(), core::optimization::symmetry::SymMinimizerMap::asymmetric_dof(), core::pose::Pose::has_dof(), core::optimization::symmetry::numerical_derivative_check(), core::optimization::numerical_derivative_check(), core::pack::scmin::CartSCMinMinimizerMap::tor_for_dof(), and core::pack::scmin::AtomTreeSCMinMinimizerMap::tor_for_dof().

Size core::id::DOF_ID::rsd ( ) const

inline

Definition at line 63 of file DOF_ID.hh.

References atom_id_, and core::id::AtomID::rsd().

Referenced by core::optimization::symmetry::SymMinimizerMap::add_new_dof_node(), core::optimization::symmetry::SymMinimizerMap::asymmetric_dof(), core::optimization::symmetry::atom_tree_get_atompairE_deriv(), core::pose::Pose::has_dof(), core::optimization::symmetry::numerical_derivative_check(), core::optimization::numerical_derivative_check(), core::pack::scmin::CartSCMinMinimizerMap::tor_for_dof(), and core::pack::scmin::AtomTreeSCMinMinimizerMap::tor_for_dof().

DOF_Type core::id::DOF_ID::type ( ) const

inline

Definition at line 71 of file DOF_ID.hh.

References type_.

Referenced by core::optimization::CartesianMinimizerMap::add_torsion(), core::optimization::symmetry::SymMinimizerMap::add_torsion(), core::pack::scmin::AtomTreeSCMinMinimizerMap::add_torsion(), core::optimization::symmetry::SymMinimizerMap::asymmetric_dof(), core::pose::Pose::has_dof(), core::optimization::symmetry::numerical_derivative_check(), core::optimization::numerical_derivative_check(), core::id::operator<<(), core::pack::scmin::CartSCMinMinimizerMap::tor_for_dof(), and core::pack::scmin::AtomTreeSCMinMinimizerMap::tor_for_dof().

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

inline

Is this DOF_ID valid?

Note

Must return false for BOGUS_TORSION_ID.

Definition at line 78 of file DOF_ID.hh.

References atom_id_, and core::id::AtomID::valid().

Referenced by core::optimization::symmetry::SymMinimizerMap::add_atom(), core::pack::scmin::AtomTreeSCMinMinimizerMap::add_atom(), core::optimization::MinimizerMap::add_atom(), core::optimization::symmetry::SymMinimizerMap::add_new_dof_node(), core::pack::scmin::AtomTreeSCMinMinimizerMap::add_torsion(), core::optimization::MinimizerMap::add_torsion(), protocols::simple_moves::TorsionDOFMover::apply(), core::kinematics::AtomTree::bond_angle(), core::kinematics::AtomTree::bond_length(), core::kinematics::AtomTree::set_bond_angle(), and core::kinematics::AtomTree::set_bond_length().

Friends And Related Function Documentation

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

friend

Definition at line 100 of file DOF_ID.hh.

bool operator< ( DOF_ID const &  a, DOF_ID const &  b  )

friend

Definition at line 108 of file DOF_ID.hh.

std::ostream& operator<< ( std::ostream &  os, DOF_ID const &  a  )

friend

stream << DOF_ID

Definition at line 31 of file DOF_ID.cc.

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

friend

Definition at line 92 of file DOF_ID.hh.

Member Data Documentation

AtomID core::id::DOF_ID::atom_id_

private

Atom identifier.

Definition at line 120 of file DOF_ID.hh.

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

DOF_Type core::id::DOF_ID::type_

private

DOF type.

Definition at line 123 of file DOF_ID.hh.

Referenced by type().

---

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

• src/core/id/DOF_ID.hh