core::environment::DofPassport Class Reference

#include <DofPassport.hh>

Inheritance diagram for core::environment::DofPassport:

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_ID >	accessible_dofs_
conformation::ConformationCOP	conf_

Friends
class	core::environment::EnvCore

Member Typedef Documentation

const_iterator

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

Constructor & Destructor Documentation

~DofPassport()

core::environment::DofPassport::~DofPassport ( )

overridedefault

DofPassport() [1/2]

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

private

DofPassport() [2/2]

core::environment::DofPassport::DofPassport ( DofPassport const &  )

private

Member Function Documentation

access_check()

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

private

References core::scoring::env, env_id_, and tr().

Referenced by dof_access().

active_dofs()

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

(

)

const

References accessible_dofs_.

active_jumps()

utility::vector1< int > core::environment::DofPassport::active_jumps

(

)

const

References conf_, and has_jump_access().

add_dof_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

id	the DOF_ID to allow access to

References accessible_dofs_.

begin()

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

(

)

const

References accessible_dofs_.

dof_access() [1/2]

bool core::environment::DofPassport::dof_access

(

core::id::DOF_ID const &

id

)

const

References accessible_dofs_.

Referenced by dof_access().

dof_access() [2/2]

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

References access_check(), dof_access(), core::scoring::env, and tr().

end()

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

inline

References accessible_dofs_.

env_id()

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

inline

References env_id_.

has_jump_access()

bool core::environment::DofPassport::has_jump_access

(

int

jump_num

)

const

References accessible_dofs_, conf_, core::id::RB1, and core::id::RB6.

Referenced by active_jumps(), and render_movemap().

mover()

std::string const & core::environment::DofPassport::mover

(

)

const

References mover_.

reference_conformation() [1/2]

conformation::ConformationCOP core::environment::DofPassport::reference_conformation

(

)

const

References conf_.

reference_conformation() [2/2]

void core::environment::DofPassport::reference_conformation

(

conformation::ConformationCOP

conf

)

References conf_.

render_movemap() [1/2]

MoveMapOP core::environment::DofPassport::render_movemap

(

)

const

render_movemap() [2/2]

void core::environment::DofPassport::render_movemap

(

core::kinematics::MoveMapOP

mm

)

const

References accessible_dofs_, core::id::BB, core::id::CHI, conf_, has_jump_access(), and core::id::DOF_ID::valid().

revoke_all_access()

void core::environment::DofPassport::revoke_all_access

(

)

References accessible_dofs_.

show()

void core::environment::DofPassport::show

(

std::ostream &

str

)

const

References env_id_, mover_, and protocols::kinmatch::str().

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

Friends And Related Function Documentation

core::environment::EnvCore

friend class core::environment::EnvCore

friend

Member Data Documentation

accessible_dofs_

std::set< core::id::DOF_ID > core::environment::DofPassport::accessible_dofs_

private

Referenced by active_dofs(), add_dof_access(), begin(), dof_access(), end(), has_jump_access(), render_movemap(), and revoke_all_access().

conf_

conformation::ConformationCOP core::environment::DofPassport::conf_

private

Referenced by active_jumps(), has_jump_access(), reference_conformation(), and render_movemap().

env_id_

core::Size core::environment::DofPassport::env_id_

private

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

mover_

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

private

Referenced by mover(), and show().

---

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

• src/core/environment/DofPassport.hh
• src/core/environment/DofPassport.cc