protocols::constraint_generator::ConstraintsMap Class Reference

Cacheable data map to cache constraint pointers in the pose. More...

#include <ConstraintsMap.hh>

Inheritance diagram for protocols::constraint_generator::ConstraintsMap:

Public Types
typedef NameToConstraintsMap::iterator	iterator
typedef NameToConstraintsMap::const_iterator	const_iterator

Public Member Functions
	ConstraintsMap ()
	~ConstraintsMap () override
basic::datacache::CacheableDataOP	clone () const override
iterator	insert (std::string const &name, ConstraintCOPs const &csts)
	Insert csts into the ConstraintsMap under the name given. More...
void	erase (iterator const &erase_me)
iterator	find (std::string const &name)
const_iterator	find (std::string const &name) const
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
std::string	valid_names_string () const
	prints out comma-separated list of constraint set names More...

Private Types
typedef core::scoring::constraints::ConstraintCOPs	ConstraintCOPs
typedef std::map< std::string, ConstraintCOPs >	NameToConstraintsMap

Private Member Functions
utility::vector1< std::string >	valid_names () const
	returns vector of constraint set names More...

Private Attributes
NameToConstraintsMap	cst_map_

Detailed Description

Cacheable data map to cache constraint pointers in the pose.

Member Typedef Documentation

typedef NameToConstraintsMap::const_iterator protocols::constraint_generator::ConstraintsMap::const_iterator

typedef core::scoring::constraints::ConstraintCOPs protocols::constraint_generator::ConstraintsMap::ConstraintCOPs

private

typedef NameToConstraintsMap::iterator protocols::constraint_generator::ConstraintsMap::iterator

typedef std::map< std::string, ConstraintCOPs > protocols::constraint_generator::ConstraintsMap::NameToConstraintsMap

private

Constructor & Destructor Documentation

protocols::constraint_generator::ConstraintsMap::ConstraintsMap

(

)

protocols::constraint_generator::ConstraintsMap::~ConstraintsMap ( )

overridedefault

Member Function Documentation

ConstraintsMap::iterator protocols::constraint_generator::ConstraintsMap::begin

(

)

References cst_map_.

ConstraintsMap::const_iterator protocols::constraint_generator::ConstraintsMap::begin

(

)

const

References cst_map_.

basic::datacache::CacheableDataOP protocols::constraint_generator::ConstraintsMap::clone ( ) const

override

ConstraintsMap::iterator protocols::constraint_generator::ConstraintsMap::end

(

)

References cst_map_.

Referenced by protocols::constraint_generator::ConstraintsManager::has_stored_constraints(), protocols::constraint_generator::ConstraintsManager::remove_constraints(), protocols::constraint_generator::ConstraintsManager::retrieve_constraints(), and protocols::constraint_generator::ConstraintsManager::store_constraints().

ConstraintsMap::const_iterator protocols::constraint_generator::ConstraintsMap::end

(

)

const

References cst_map_.

void protocols::constraint_generator::ConstraintsMap::erase

(

iterator const &

erase_me

)

References cst_map_.

Referenced by protocols::constraint_generator::ConstraintsManager::remove_constraints().

ConstraintsMap::iterator protocols::constraint_generator::ConstraintsMap::find

(

std::string const &

name

)

References cst_map_.

Referenced by protocols::constraint_generator::ConstraintsManager::has_stored_constraints(), protocols::constraint_generator::ConstraintsManager::remove_constraints(), protocols::constraint_generator::ConstraintsManager::retrieve_constraints(), and protocols::constraint_generator::ConstraintsManager::store_constraints().

ConstraintsMap::const_iterator protocols::constraint_generator::ConstraintsMap::find

(

std::string const &

name

)

const

References cst_map_.

ConstraintsMap::iterator protocols::constraint_generator::ConstraintsMap::insert	(	std::string const &	name,
		ConstraintCOPs const &	csts
	)

Insert csts into the ConstraintsMap under the name given.

Parameters

[in]	name	Map key name under which constraints will be stored
[in]	csts	Constraints to store

Returns

ConstraintsMap::iterator to new map item.

References cst_map_, and core::scoring::pair.

Referenced by protocols::constraint_generator::ConstraintsManager::store_constraints().

utility::vector1< std::string > protocols::constraint_generator::ConstraintsMap::valid_names ( ) const

private

returns vector of constraint set names

References cst_map_, and core::scoring::pair.

Referenced by valid_names_string().

std::string protocols::constraint_generator::ConstraintsMap::valid_names_string

(

)

const

prints out comma-separated list of constraint set names

References valid_names().

Referenced by protocols::constraint_generator::ConstraintsManager::retrieve_constraints().

Member Data Documentation

NameToConstraintsMap protocols::constraint_generator::ConstraintsMap::cst_map_

private

Referenced by begin(), end(), erase(), find(), insert(), and valid_names().

---

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

• src/protocols/constraint_generator/ConstraintsMap.hh
• src/protocols/constraint_generator/ConstraintsMap.cc