#include <UpstreamHitCacher.hh>

Inheritance diagram for protocols::match::output::UpstreamHitCacher:

Collaboration diagram for protocols::match::output::UpstreamHitCacher:

Public Types
typedef utility::fixedsizearray1< Size, 2 >	ScaffoldRotamerPair

typedef utility::OrderedTuple < ScaffoldRotamerPair >	ScaffoldRotamerTuple

Public Member Functions
	UpstreamHitCacher (MatcherCOP matcher)

virtual	~UpstreamHitCacher ()

void	set_cache_size (Size n_rotamers_to_cache)

core::conformation::ResidueCOP	upstream_conformation_for_hit (Size geometric_constraint_id, Hit const &hit)

virtual void	process_hit (Hit const &hit, core::conformation::Residue const &upstream_conformation)
	The method by which the UpstreamHitCacher communicates with the UpstreamBuilders. CAUTION: this class should not be handed to an UpstreamBuilder directly. It should only hand itself to an UpstreamBuilder. Ask the UpstreamHitCacher for a particular hit, and it will call recover_rotamer() on the upstream builder; it's doing bookkeeping in the background and that bookkeeping is important for the success of this function. More...

Public Member Functions inherited from protocols::match::upstream::UpstreamResidueProcessor
virtual	~UpstreamResidueProcessor ()

Private Member Functions
void	resize_arrays ()
	Allocate space in the arrays dependent on n_geometric_constraints_ and n_confs_to_cache_. More...

Size	already_in_queue (Size cst_id, ScaffoldRotamerTuple const &rotid) const
	Returns 0 if the scaffold/rotamer pair is not already in the queue, and the non-zero index in the queue if it is. More...

Size	fetch (Size cst_id, ScaffoldRotamerTuple const &rotid)
	Construct the rotamer for the requested scaffold/rotamer pair and put it into the queue, evicting the previous queue resident if necessary. More...

Private Attributes
MatcherCOP	matcher_

Size	n_geometric_constraints_

Size	n_confs_to_cache_

utility::vector1< std::map < ScaffoldRotamerTuple, Size > >	index_for_rotamer_

Size	which_cst_being_processed_

utility::vector1< Size >	queue_head_

utility::vector1 < utility::vector1 < ScaffoldRotamerTuple > >	scafrot_pair_for_conf_

utility::vector1 < utility::vector1 < core::conformation::ResidueCOP > >	upstream_confs_

Member Typedef Documentation

typedef utility::fixedsizearray1< Size, 2 > protocols::match::output::UpstreamHitCacher::ScaffoldRotamerPair

typedef utility::OrderedTuple< ScaffoldRotamerPair > protocols::match::output::UpstreamHitCacher::ScaffoldRotamerTuple

Constructor & Destructor Documentation

protocols::match::output::UpstreamHitCacher::UpstreamHitCacher ( MatcherCOP matcher)

References resize_arrays().

protocols::match::output::UpstreamHitCacher::~UpstreamHitCacher ( )

virtual

Member Function Documentation

UpstreamHitCacher::Size protocols::match::output::UpstreamHitCacher::already_in_queue	(	Size	cst_id,
		ScaffoldRotamerTuple const &	rotid
	)		const

private

Returns 0 if the scaffold/rotamer pair is not already in the queue, and the non-zero index in the queue if it is.

References core::sequence::end, and index_for_rotamer_.

Referenced by upstream_conformation_for_hit().

UpstreamHitCacher::Size protocols::match::output::UpstreamHitCacher::fetch	(	Size	cst_id,
		ScaffoldRotamerTuple const &	rotid
	)

private

Construct the rotamer for the requested scaffold/rotamer pair and put it into the queue, evicting the previous queue resident if necessary.

References protocols::match::Hit::first(), matcher_, queue_head_, protocols::match::Hit::scaffold_build_id(), and which_cst_being_processed_.

Referenced by upstream_conformation_for_hit().

void protocols::match::output::UpstreamHitCacher::process_hit	(	Hit const &	hit,
		core::conformation::Residue const &	upstream_conformation
	)

virtual

The method by which the UpstreamHitCacher communicates with the UpstreamBuilders. CAUTION: this class should not be handed to an UpstreamBuilder directly. It should only hand itself to an UpstreamBuilder. Ask the UpstreamHitCacher for a particular hit, and it will call recover_rotamer() on the upstream builder; it's doing bookkeeping in the background and that bookkeeping is important for the success of this function.

Implements protocols::match::upstream::UpstreamResidueProcessor.

References core::sequence::end, index_for_rotamer_, n_confs_to_cache_, queue_head_, protocols::match::Hit::scaffold_build_id(), scafrot_pair_for_conf_, protocols::match::Hit::upstream_conf_id(), upstream_confs_, and which_cst_being_processed_.

void protocols::match::output::UpstreamHitCacher::resize_arrays ( )

private

Allocate space in the arrays dependent on n_geometric_constraints_ and n_confs_to_cache_.

References index_for_rotamer_, n_confs_to_cache_, n_geometric_constraints_, queue_head_, scafrot_pair_for_conf_, and upstream_confs_.

Referenced by set_cache_size(), and UpstreamHitCacher().

void protocols::match::output::UpstreamHitCacher::set_cache_size ( Size n_rotamers_to_cache)

References n_confs_to_cache_, and resize_arrays().

core::conformation::ResidueCOP protocols::match::output::UpstreamHitCacher::upstream_conformation_for_hit	(	Size	geometric_constraint_id,
		Hit const &	hit
	)