Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
core::environment::DofPassport Class Reference

#include <DofPassport.hh>

Inheritance diagram for core::environment::DofPassport:
Inheritance graph
[legend]

Public Types

typedef std::set
< core::id::DOF_ID >
::const_iterator 
const_iterator
 

Public Member Functions

 ~DofPassport () override
 
void show (std::ostream &) const
 
core::kinematics::MoveMapOP render_movemap () const
 
void render_movemap (core::kinematics::MoveMapOP) const
 
std::set< core::id::DOF_ID >
::const_iterator 
begin () const
 
std::set< core::id::DOF_ID >
::const_iterator 
end () const
 
void add_dof_access (id::DOF_ID const &id)
 configure passport to allow access to a bond length or angle dof_id More...
 
void revoke_all_access ()
 
bool has_jump_access (int jump_num) const
 
std::set< core::id::DOF_ID >
const & 
active_dofs () const
 
utility::vector1< int > active_jumps () const
 
bool dof_access (core::id::DOF_ID const &id) const
 
bool dof_access (EnvCore const &, core::id::DOF_ID const &id) const
 
std::string const & mover () const
 
core::Size const & env_id () const
 
conformation::ConformationCOP reference_conformation () const
 
void reference_conformation (conformation::ConformationCOP conf)
 

Private Member Functions

 DofPassport (std::string const &mover, Size env_id)
 
 DofPassport (DofPassport const &)
 
bool access_check (EnvCore const &env, bool type_specific_check) const
 

Private Attributes

std::string mover_
 
core::Size env_id_
 
std::set< core::id::DOF_IDaccessible_dofs_
 
conformation::ConformationCOP conf_
 

Friends

class core::environment::EnvCore
 

Member Typedef Documentation

Constructor & Destructor Documentation

core::environment::DofPassport::~DofPassport ( )
overridedefault
core::environment::DofPassport::DofPassport ( std::string const &  mover,
core::Size  env 
)
private
core::environment::DofPassport::DofPassport ( DofPassport const &  )
private

Member Function Documentation

bool core::environment::DofPassport::access_check ( EnvCore const &  env,
bool  type_specific_check 
) const
private

References env_id_, core::environment::EnvCore::id(), and tr().

Referenced by dof_access().

std::set< core::id::DOF_ID > const & core::environment::DofPassport::active_dofs ( ) const

References accessible_dofs_.

utility::vector1< int > core::environment::DofPassport::active_jumps ( ) const

References conf_, and has_jump_access().

void core::environment::DofPassport::add_dof_access ( id::DOF_ID const &  id)

configure passport to allow access to a bond length or angle dof_id

Parameters
idthe DOF_ID to allow access to

References accessible_dofs_.

std::set< core::id::DOF_ID >::const_iterator core::environment::DofPassport::begin ( ) const

References accessible_dofs_.

bool core::environment::DofPassport::dof_access ( core::id::DOF_ID const &  id) const

References accessible_dofs_.

Referenced by dof_access().

bool core::environment::DofPassport::dof_access ( EnvCore const &  env,
core::id::DOF_ID const &  id 
) const

References access_check(), dof_access(), and tr().

std::set< core::id::DOF_ID >::const_iterator core::environment::DofPassport::end ( ) const
inline

References accessible_dofs_.

core::Size const& core::environment::DofPassport::env_id ( ) const
inline

References env_id_.

bool core::environment::DofPassport::has_jump_access ( int  jump_num) const
std::string const & core::environment::DofPassport::mover ( ) const

References mover_.

conformation::ConformationCOP core::environment::DofPassport::reference_conformation ( ) const

References conf_.

void core::environment::DofPassport::reference_conformation ( conformation::ConformationCOP  conf)

References conf_.

MoveMapOP core::environment::DofPassport::render_movemap ( ) const
void core::environment::DofPassport::render_movemap ( core::kinematics::MoveMapOP  mm) const
void core::environment::DofPassport::revoke_all_access ( )

References accessible_dofs_.

void core::environment::DofPassport::show ( std::ostream &  str) const

References env_id_, and mover_.

Referenced by core::environment::operator<<().

Friends And Related Function Documentation

friend class core::environment::EnvCore
friend

Member Data Documentation

std::set< core::id::DOF_ID > core::environment::DofPassport::accessible_dofs_
private
conformation::ConformationCOP core::environment::DofPassport::conf_
private
core::Size core::environment::DofPassport::env_id_
private

Referenced by access_check(), env_id(), and show().

std::string core::environment::DofPassport::mover_
private

Referenced by mover(), and show().


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