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

#include <MRSJob.hh>

Inheritance diagram for protocols::multistage_rosetta_scripts::MRSJob:
Inheritance graph
[legend]

Public Member Functions

 MRSJob (core::Size max_num_results=1)
 
 ~MRSJob () override
 
void set_pose (core::pose::PoseOP pose)
 
core::pose::PoseCOP pose () const
 
jd3::CompletedJobOutput run () override
 This is the main function of the Job object. It will be invoked by the JobDistributor. The Job will return a JobResult at the conclusion of its execution, and the JobResult will be serialized and sent to the appropriate JobQueen for processing and output. The Job itself will be discarded. Large constant data that might be shared between multiple jobs can be held by the Job object (or by classes that the Job object holds) but that data should not be put into the JobResult – large data should not be repeatedly serialized and shipped between nodes. More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &, std::map< std::string, utility::tag::TagCOP > const &mover_tags_by_name, std::map< std::string, utility::tag::TagCOP > const &filter_tags_by_name)
 
void parse_my_tag (utility::tag::TagCOP tag, ParsedTagCacheOP cache)
 
core::Real metric_for_evaluation (core::pose::PoseOP pose) const
 returns metric generated by the final filter of the protocol More...
 
void set_max_num_results (core::Size setting)
 the final mover of the protocol is allowed to return additional output poses. This value places a cap on the number of poses that can be output by that mover More...
 
core::Size max_num_results () const
 
std::list< mover_or_filter > & protocols ()
 this getter is only really intended to be used for unit tests More...
 
void set_cluster_metric_tag (utility::tag::TagCOP tag_for_cluster_metric)
 
- Public Member Functions inherited from protocols::jd3::Job
 Job ()
 
 ~Job () override
 

Protected Member Functions

cluster::ClusterMetricOP get_cluster_metric (core::pose::Pose const &pose)
 

Private Member Functions

jd3::CompletedJobOutput run_inner ()
 

Private Attributes

core::pose::PoseOP pose_
 
std::list< mover_or_filterprotocols_
 
core::Size max_num_results_
 
bool positive_scores_are_better_
 
utility::tag::TagCOP tag_for_cluster_metric_
 
ParsedTagCacheOP data_
 

Constructor & Destructor Documentation

protocols::multistage_rosetta_scripts::MRSJob::MRSJob ( core::Size  max_num_results = 1)
protocols::multistage_rosetta_scripts::MRSJob::~MRSJob ( )
override

Member Function Documentation

cluster::ClusterMetricOP protocols::multistage_rosetta_scripts::MRSJob::get_cluster_metric ( core::pose::Pose const &  pose)
protected

References data_, pose(), and tag_for_cluster_metric_.

Referenced by run_inner().

core::Size protocols::multistage_rosetta_scripts::MRSJob::max_num_results ( ) const
inline

References max_num_results_.

core::Real protocols::multistage_rosetta_scripts::MRSJob::metric_for_evaluation ( core::pose::PoseOP  pose) const

returns metric generated by the final filter of the protocol

References protocols_.

void protocols::multistage_rosetta_scripts::MRSJob::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &  map,
std::map< std::string, utility::tag::TagCOP > const &  mover_tags_by_name,
std::map< std::string, utility::tag::TagCOP > const &  filter_tags_by_name 
)
void protocols::multistage_rosetta_scripts::MRSJob::parse_my_tag ( utility::tag::TagCOP  tag,
ParsedTagCacheOP  cache 
)
inline

References data_, and parse_my_tag().

core::pose::PoseCOP protocols::multistage_rosetta_scripts::MRSJob::pose ( ) const
inline

References pose_.

Referenced by get_cluster_metric(), and set_pose().

std::list< mover_or_filter >& protocols::multistage_rosetta_scripts::MRSJob::protocols ( )
inline

this getter is only really intended to be used for unit tests

References protocols_.

jd3::CompletedJobOutput protocols::multistage_rosetta_scripts::MRSJob::run ( )
overridevirtual

This is the main function of the Job object. It will be invoked by the JobDistributor. The Job will return a JobResult at the conclusion of its execution, and the JobResult will be serialized and sent to the appropriate JobQueen for processing and output. The Job itself will be discarded. Large constant data that might be shared between multiple jobs can be held by the Job object (or by classes that the Job object holds) but that data should not be put into the JobResult – large data should not be repeatedly serialized and shipped between nodes.

Implements protocols::jd3::Job.

References protocols::jd3::jd3_job_status_failed_do_not_retry, protocols::jd3::jd3_job_status_success, protocols::jd3::CompletedJobOutput::job_results, pose_, run_inner(), and protocols::jd3::CompletedJobOutput::status.

jd3::CompletedJobOutput protocols::multistage_rosetta_scripts::MRSJob::run_inner ( )
private
void protocols::multistage_rosetta_scripts::MRSJob::set_cluster_metric_tag ( utility::tag::TagCOP  tag_for_cluster_metric)
inline
void protocols::multistage_rosetta_scripts::MRSJob::set_max_num_results ( core::Size  setting)
inline

the final mover of the protocol is allowed to return additional output poses. This value places a cap on the number of poses that can be output by that mover

References max_num_results_.

void protocols::multistage_rosetta_scripts::MRSJob::set_pose ( core::pose::PoseOP  pose)
inline

References pose(), and pose_.

Member Data Documentation

ParsedTagCacheOP protocols::multistage_rosetta_scripts::MRSJob::data_
private

Referenced by get_cluster_metric(), and parse_my_tag().

core::Size protocols::multistage_rosetta_scripts::MRSJob::max_num_results_
private
core::pose::PoseOP protocols::multistage_rosetta_scripts::MRSJob::pose_
private

Referenced by pose(), run(), run_inner(), and set_pose().

bool protocols::multistage_rosetta_scripts::MRSJob::positive_scores_are_better_
private

Referenced by parse_my_tag(), and run_inner().

std::list< mover_or_filter > protocols::multistage_rosetta_scripts::MRSJob::protocols_
private
utility::tag::TagCOP protocols::multistage_rosetta_scripts::MRSJob::tag_for_cluster_metric_
private

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