Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
protocols::match::output::WriteUpstreamHitKinemage Class Reference

#include <WriteUpstreamCoordinateKineamge.hh>

Inheritance diagram for protocols::match::output::WriteUpstreamHitKinemage:
Inheritance graph
[legend]

Public Member Functions

 WriteUpstreamHitKinemage ()
 
 WriteUpstreamHitKinemage (std::string const &fname)
 
 WriteUpstreamHitKinemage (std::ostream &ostr)
 
 ~WriteUpstreamHitKinemage () override
 
void process_hit (Hit const &hit, core::conformation::Residue const &upstream_conformation) override
 
void output_hit (Hit const &hit, core::conformation::Residue const &upstream_conformation)
 Non-virtual method to write out a kinemage for an upstream residue. More...
 
void output_upstream_coordinates (upstream_hit const &hit, core::conformation::Residue const &upstream_conformation)
 non-virtual method to write out a kinemage for an upstream residue; without invoking dswriter_->write_downstream_coordinates(). Only information about the upstream portion of the hit is needed. More...
 
void start_new_match ()
 
void set_kinemage_file (std::string const &fname)
 
void set_dswriter (DownstreamCoordinateKinemageWriterOP dswriter)
 
void geom_id (core::Size setting)
 
void set_master (std::string const &master)
 Set the kinemage master for the upstream residue, overriding the default master, which is "geom#". More...
 
void default_master (bool setting)
 Set whether the default master should be used, or whether the user-defined master should be used. If the user defined master is the empty string, no master will be writen. More...
 
bool default_master () const
 Returns whether or not the default master is being used. More...
 
void animate (bool setting)
 
void dominant (bool setting)
 
void group (bool setting)
 
void write_virtual_atoms (bool setting)
 
- Public Member Functions inherited from protocols::match::upstream::UpstreamResidueProcessor
 ~UpstreamResidueProcessor () override
 

Private Attributes

core::Size matches_output_count_
 
bool use_default_master_
 
std::string master_
 
bool animate_
 
bool dominant_
 
bool group_
 
bool write_virtual_atoms_
 
core::Size geom_id_
 
std::string kinemage_file_name_
 
std::ofstream file_out_
 
std::ostream & ostr_
 
DownstreamCoordinateKinemageWriterOP dswriter_
 

Constructor & Destructor Documentation

protocols::match::output::WriteUpstreamHitKinemage::WriteUpstreamHitKinemage ( )
protocols::match::output::WriteUpstreamHitKinemage::WriteUpstreamHitKinemage ( std::string const &  fname)

References file_out_, and kinemage_file_name_.

protocols::match::output::WriteUpstreamHitKinemage::WriteUpstreamHitKinemage ( std::ostream &  ostr)
protocols::match::output::WriteUpstreamHitKinemage::~WriteUpstreamHitKinemage ( )
override

References file_out_.

Member Function Documentation

void protocols::match::output::WriteUpstreamHitKinemage::animate ( bool  setting)

References animate_.

void protocols::match::output::WriteUpstreamHitKinemage::default_master ( bool  setting)

Set whether the default master should be used, or whether the user-defined master should be used. If the user defined master is the empty string, no master will be writen.

References use_default_master_.

bool protocols::match::output::WriteUpstreamHitKinemage::default_master ( ) const

Returns whether or not the default master is being used.

References use_default_master_.

void protocols::match::output::WriteUpstreamHitKinemage::dominant ( bool  setting)

References dominant_.

void protocols::match::output::WriteUpstreamHitKinemage::geom_id ( core::Size  setting)
void protocols::match::output::WriteUpstreamHitKinemage::group ( bool  setting)

References group_.

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

Non-virtual method to write out a kinemage for an upstream residue.

References dswriter_, ostr_, and output_upstream_coordinates().

Referenced by process_hit().

void protocols::match::output::WriteUpstreamHitKinemage::output_upstream_coordinates ( upstream_hit const &  hit,
core::conformation::Residue const &  upstream_conformation 
)
void protocols::match::output::WriteUpstreamHitKinemage::process_hit ( Hit const &  hit,
core::conformation::Residue const &  upstream_conformation 
)
overridevirtual
void protocols::match::output::WriteUpstreamHitKinemage::set_dswriter ( DownstreamCoordinateKinemageWriterOP  dswriter)

References dswriter_.

void protocols::match::output::WriteUpstreamHitKinemage::set_kinemage_file ( std::string const &  fname)

References file_out_, and kinemage_file_name_.

void protocols::match::output::WriteUpstreamHitKinemage::set_master ( std::string const &  master)

Set the kinemage master for the upstream residue, overriding the default master, which is "geom#".

References master_, and use_default_master_.

void protocols::match::output::WriteUpstreamHitKinemage::start_new_match ( )

References matches_output_count_, and ostr_.

void protocols::match::output::WriteUpstreamHitKinemage::write_virtual_atoms ( bool  setting)

References write_virtual_atoms_.

Member Data Documentation

bool protocols::match::output::WriteUpstreamHitKinemage::animate_
private
bool protocols::match::output::WriteUpstreamHitKinemage::dominant_
private
DownstreamCoordinateKinemageWriterOP protocols::match::output::WriteUpstreamHitKinemage::dswriter_
private

Referenced by geom_id(), output_hit(), and set_dswriter().

std::ofstream protocols::match::output::WriteUpstreamHitKinemage::file_out_
private
core::Size protocols::match::output::WriteUpstreamHitKinemage::geom_id_
private
bool protocols::match::output::WriteUpstreamHitKinemage::group_
private
std::string protocols::match::output::WriteUpstreamHitKinemage::kinemage_file_name_
private
std::string protocols::match::output::WriteUpstreamHitKinemage::master_
private
core::Size protocols::match::output::WriteUpstreamHitKinemage::matches_output_count_
private

Referenced by start_new_match().

std::ostream& protocols::match::output::WriteUpstreamHitKinemage::ostr_
private
bool protocols::match::output::WriteUpstreamHitKinemage::use_default_master_
private
bool protocols::match::output::WriteUpstreamHitKinemage::write_virtual_atoms_
private

Referenced by write_virtual_atoms().


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