Rosetta 3.4
Public Types | Public Member Functions
protocols::match::output::WriteUpstreamCoordinateKinemage Class Reference

#include <WriteUpstreamCoordinateKineamge.hh>

Inheritance diagram for protocols::match::output::WriteUpstreamCoordinateKinemage:
Inheritance graph
[legend]
Collaboration diagram for protocols::match::output::WriteUpstreamCoordinateKinemage:
Collaboration graph
[legend]

List of all members.

Public Types

typedef core::Size Size
typedef core::Vector Vector

Public Member Functions

 WriteUpstreamCoordinateKinemage ()
 WriteUpstreamCoordinateKinemage (std::string const &fname)
 WriteUpstreamCoordinateKinemage (std::ostream &ostr)
virtual ~WriteUpstreamCoordinateKinemage ()
virtual
downstream::DownstreamAlgorithmOP 
clone () const
virtual std::list< Hitbuild (Size const scaffold_build_point_id, Size const upstream_conf_id, core::conformation::Residue const &upstream_residue) const
 To be invoked by derived classes, this function completes the building of the downstream conformation once the coordinates of the upstream conformation are known (and deemed non-colliding or, generally, pass any filter the upstream builder would use).
virtual bool upstream_only () const
 This method returns 'true' whether or not it's ClassicMatchAlgorithm is set as it should not have its hits_to_include_with_partial_match method invoked.
virtual bool generates_primary_hits () const
 This method returns 'true' since when it does return hits, it's those generated by the ClassicMatchAlgorithm.
virtual HitPtrListCOP hits_to_include_with_partial_match (match_dspos1 const &m) const
 This method should not be invoked on this class, since it returns "true" in its upstream_only method.
virtual Size n_possible_hits_per_upstream_conformation () const
void set_kinemage_file_name (std::string const &filename)
void set_match_algorithm (downstream::ClassicMatchAlgorithmCOP algorithm)
void set_downstream_writer (DownstreamCoordinateKinemageWriterCOP dswriter)
void set_n_downstream_to_output (Size n_downstream_to_output)
bool return_pseudo_hits () const
void return_pseudo_hits (bool setting)

Member Typedef Documentation


Constructor & Destructor Documentation

protocols::match::output::WriteUpstreamCoordinateKinemage::WriteUpstreamCoordinateKinemage ( )

Referenced by clone().

protocols::match::output::WriteUpstreamCoordinateKinemage::WriteUpstreamCoordinateKinemage ( std::string const &  fname)
protocols::match::output::WriteUpstreamCoordinateKinemage::WriteUpstreamCoordinateKinemage ( std::ostream &  ostr)
protocols::match::output::WriteUpstreamCoordinateKinemage::~WriteUpstreamCoordinateKinemage ( ) [virtual]

Member Function Documentation

std::list< Hit > protocols::match::output::WriteUpstreamCoordinateKinemage::build ( Size const  scaffold_build_point_id,
Size const  upstream_conf_id,
core::conformation::Residue const &  upstream_residue 
) const [virtual]

To be invoked by derived classes, this function completes the building of the downstream conformation once the coordinates of the upstream conformation are known (and deemed non-colliding or, generally, pass any filter the upstream builder would use).

Implements protocols::match::downstream::DownstreamAlgorithm.

References protocols::match::Hit::first(), core::conformation::Residue::has(), protocols::match::output::ResidueKinemageWriter::master(), protocols::match::output::ResidueKinemageWriter::write_rsd_coords(), and core::conformation::Residue::xyz().

downstream::DownstreamAlgorithmOP protocols::match::output::WriteUpstreamCoordinateKinemage::clone ( ) const [virtual]
bool protocols::match::output::WriteUpstreamCoordinateKinemage::generates_primary_hits ( ) const [virtual]

This method returns 'true' since when it does return hits, it's those generated by the ClassicMatchAlgorithm.

Implements protocols::match::downstream::DownstreamAlgorithm.

HitPtrListCOP protocols::match::output::WriteUpstreamCoordinateKinemage::hits_to_include_with_partial_match ( match_dspos1 const &  m) const [virtual]

This method should not be invoked on this class, since it returns "true" in its upstream_only method.

If this function is causing an exit, then there is a bug within the Matcher's match-enumeration logic. There is no meaningful way forward after this function is invoked. It should not be invoked. Truely, this class should not be used in match enumeration.

Implements protocols::match::downstream::DownstreamAlgorithm.

WriteUpstreamCoordinateKinemage::Size protocols::match::output::WriteUpstreamCoordinateKinemage::n_possible_hits_per_upstream_conformation ( ) const [virtual]
bool protocols::match::output::WriteUpstreamCoordinateKinemage::return_pseudo_hits ( ) const [inline]
void protocols::match::output::WriteUpstreamCoordinateKinemage::return_pseudo_hits ( bool  setting) [inline]
void protocols::match::output::WriteUpstreamCoordinateKinemage::set_downstream_writer ( DownstreamCoordinateKinemageWriterCOP  dswriter)
void protocols::match::output::WriteUpstreamCoordinateKinemage::set_kinemage_file_name ( std::string const &  filename)
void protocols::match::output::WriteUpstreamCoordinateKinemage::set_match_algorithm ( downstream::ClassicMatchAlgorithmCOP  algorithm)
void protocols::match::output::WriteUpstreamCoordinateKinemage::set_n_downstream_to_output ( Size  n_downstream_to_output)
bool protocols::match::output::WriteUpstreamCoordinateKinemage::upstream_only ( ) const [virtual]

This method returns 'true' whether or not it's ClassicMatchAlgorithm is set as it should not have its hits_to_include_with_partial_match method invoked.

This is an acceptalbe return value for this debugging-purposed class.

Implements protocols::match::downstream::DownstreamAlgorithm.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines