protocols::cyclic_peptide_predict::HierarchicalHybridJD_ResultsSummaryBase Class Reference

A pure virtual base class for the helper classes used by the HierarchicalHybridJDApplication class for transmitting information up the MPI hierarchy. More...

#include <HierarchicalHybridJD_ResultsSummaryBase.hh>

Inheritance diagram for protocols::cyclic_peptide_predict::HierarchicalHybridJD_ResultsSummaryBase:

Public Member Functions
	HierarchicalHybridJD_ResultsSummaryBase ()=default
	Default constructor. More...
	HierarchicalHybridJD_ResultsSummaryBase (HierarchicalHybridJD_ResultsSummaryBase const &)=default
	Copy constructor. More...
	HierarchicalHybridJD_ResultsSummaryBase (int const originating_node_MPI_rank, core::Size const jobindex_on_originating_node)
	Constructor with options. More...
virtual HierarchicalHybridJD_ResultsSummaryBaseOP	clone () const =0
	Clone operation: make a copy of this object, and return an owning pointer to the copy. More...
int	originating_node_MPI_rank () const
	-------—— Getters -------------------------—— More...
core::Size	jobindex_on_originating_node () const
	Get the local index of the job on the node on which it was carried out. More...
utility::vector1< int > const &	MPI_ranks_handling_message () const
	Get the list of procs that transmitted this JobResultsSummary. More...
void	set_originating_node_MPI_rank (int const rank)
	-------—— Setters -------------------------—— More...
void	set_jobindex_on_originating_node (core::Size const index)
	Set the local index of the job on the node on which it was carried out. More...
void	add_MPI_rank_handling_message (int const new_proc)
	Add a proc that handled this message to the list of procs that transmitted this JobResultsSummary. More...

Private Attributes
int	originating_node_MPI_rank_ = 0
	The rank of the process that actually ran the job. More...
core::Size	jobindex_on_originating_node_ = 0
	The local index of the job on the process that ran the job. More...
utility::vector1< int >	mpi_ranks_handling_message_
	The list of procs that transmitted this JobResultsSummary. More...

Detailed Description

A pure virtual base class for the helper classes used by the HierarchicalHybridJDApplication class for transmitting information up the MPI hierarchy.

Author

Vikram K. Mulligan (vmull.nosp@m.igan.nosp@m.@flat.nosp@m.iron.nosp@m.insti.nosp@m.tute.nosp@m..org)

Constructor & Destructor Documentation

protocols::cyclic_peptide_predict::HierarchicalHybridJD_ResultsSummaryBase::HierarchicalHybridJD_ResultsSummaryBase ( )

default

Default constructor.

protocols::cyclic_peptide_predict::HierarchicalHybridJD_ResultsSummaryBase::HierarchicalHybridJD_ResultsSummaryBase ( HierarchicalHybridJD_ResultsSummaryBase const &  )

default

Copy constructor.

protocols::cyclic_peptide_predict::HierarchicalHybridJD_ResultsSummaryBase::HierarchicalHybridJD_ResultsSummaryBase	(	int const	originating_node_MPI_rank,
		core::Size const	jobindex_on_originating_node
	)

Constructor with options.

References jobindex_on_originating_node_, and originating_node_MPI_rank_.

Member Function Documentation

void protocols::cyclic_peptide_predict::HierarchicalHybridJD_ResultsSummaryBase::add_MPI_rank_handling_message

(

int const

new_proc

)

Add a proc that handled this message to the list of procs that transmitted this JobResultsSummary.

Whenever a proc sends it to someone else, the receiving proc appends the sender's rank here. This allows the director node to address an output request to the correct proc.

References mpi_ranks_handling_message_.

virtual HierarchicalHybridJD_ResultsSummaryBaseOP protocols::cyclic_peptide_predict::HierarchicalHybridJD_ResultsSummaryBase::clone ( ) const

pure virtual

Clone operation: make a copy of this object, and return an owning pointer to the copy.

Implemented in protocols::cyclic_peptide_predict::HierarchicalHybridJD_JobResultsSummary, protocols::cyclic_peptide_predict::HierarchicalHybridJD_SASASummary, and protocols::cyclic_peptide_predict::HierarchicalHybridJD_RMSDToBestSummary.

core::Size protocols::cyclic_peptide_predict::HierarchicalHybridJD_ResultsSummaryBase::jobindex_on_originating_node ( ) const

inline

Get the local index of the job on the node on which it was carried out.

References jobindex_on_originating_node_.

Referenced by protocols::cyclic_peptide_predict::HierarchicalHybridJD_JobResultsSummary::show().

utility::vector1<int> const& protocols::cyclic_peptide_predict::HierarchicalHybridJD_ResultsSummaryBase::MPI_ranks_handling_message ( ) const

inline

Get the list of procs that transmitted this JobResultsSummary.

Whenever a proc sends it to someone else, the receiving proc appends the sender's rank here. This allows the director node to address an output request to the correct proc.

References mpi_ranks_handling_message_.

Referenced by protocols::cyclic_peptide_predict::HierarchicalHybridJD_JobResultsSummary::show().

int protocols::cyclic_peptide_predict::HierarchicalHybridJD_ResultsSummaryBase::originating_node_MPI_rank ( ) const

inline

-------—— Getters -------------------------——

Get the MPI rank of the process that initially carried out this job.

References originating_node_MPI_rank_.

Referenced by protocols::cyclic_peptide_predict::HierarchicalHybridJD_JobResultsSummary::show().

void protocols::cyclic_peptide_predict::HierarchicalHybridJD_ResultsSummaryBase::set_jobindex_on_originating_node

(

core::Size const

index

)

Set the local index of the job on the node on which it was carried out.

References jobindex_on_originating_node_.

void protocols::cyclic_peptide_predict::HierarchicalHybridJD_ResultsSummaryBase::set_originating_node_MPI_rank

(

int const

rank

)

-------—— Setters -------------------------——

Set the MPI rank of the process that initially carried out this job.

References originating_node_MPI_rank_.

Member Data Documentation

core::Size protocols::cyclic_peptide_predict::HierarchicalHybridJD_ResultsSummaryBase::jobindex_on_originating_node_ = 0

private

The local index of the job on the process that ran the job.

Referenced by HierarchicalHybridJD_ResultsSummaryBase(), jobindex_on_originating_node(), and set_jobindex_on_originating_node().

utility::vector1< int > protocols::cyclic_peptide_predict::HierarchicalHybridJD_ResultsSummaryBase::mpi_ranks_handling_message_

private

The list of procs that transmitted this JobResultsSummary.

Whenever a proc sends it to someone else, the receiving proc appends the sender's rank here. This allows the director node to address an output request to the correct proc.

Referenced by add_MPI_rank_handling_message(), and MPI_ranks_handling_message().

int protocols::cyclic_peptide_predict::HierarchicalHybridJD_ResultsSummaryBase::originating_node_MPI_rank_ = 0

private

The rank of the process that actually ran the job.

Referenced by HierarchicalHybridJD_ResultsSummaryBase(), originating_node_MPI_rank(), and set_originating_node_MPI_rank().

---

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

• src/protocols/cyclic_peptide_predict/HierarchicalHybridJD_ResultsSummaryBase.hh
• src/protocols/cyclic_peptide_predict/HierarchicalHybridJD_ResultsSummaryBase.cc