This class contains the 3 AlignmentAtoms that we want to use to define the new jump value. More...

#include <AlignmentAtom.hh>

Public Member Functions
Stub	create_destination_stub () const
	Define the intended stub that represents the future pose after updating the jump. More...

Stub	create_stub_from_atom_ids (conformation::Conformation const &conf) const
	This utility function uses the current XYZ coordinates for the AtomIDs in the pose. More...

Public Attributes
std::array< AlignmentAtom, 3 >	atoms

Detailed Description

This class contains the 3 AlignmentAtoms that we want to use to define the new jump value.

In theory, the order of the atoms does not matter. We are using struct instead of class because AlignmentAtomArray has no invariants. We are also defining functions in the header because the function body does a better job of explaining the purpose than my comments do.

Member Function Documentation

◆ create_destination_stub()

Stub core::kinematics::inverse::AlignmentAtomArray::create_destination_stub ( ) const

inline

Define the intended stub that represents the future pose after updating the jump.

References atoms.

Referenced by core::kinematics::inverse::calculate_new_jump().

◆ create_stub_from_atom_ids()

Stub core::kinematics::inverse::AlignmentAtomArray::create_stub_from_atom_ids ( conformation::Conformation const & conf ) const

inline

This utility function uses the current XYZ coordinates for the AtomIDs in the pose.

References atoms, and core::conformation::Conformation::xyz().

Referenced by core::kinematics::inverse::calculate_new_jump().

Member Data Documentation

◆ atoms

std::array< AlignmentAtom, 3 > core::kinematics::inverse::AlignmentAtomArray::atoms

Referenced by core::kinematics::inverse::assert_atoms_are_downstream_of_jump(), core::kinematics::inverse::assert_atoms_are_upstream_of_jump(), create_destination_stub(), create_stub_from_atom_ids(), and core::kinematics::inverse::jump_from_internal_coords().

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

src/core/kinematics/inverse/AlignmentAtom.hh