protocols::wum::WorkUnitManager Class Reference

#include <WorkUnitManager.hh>

Public Types
typedef WorkUnitQueue::iterator	iterator
typedef WorkUnitQueue::const_iterator	const_iterator

Public Member Functions
	WorkUnitManager ()
virtual	~WorkUnitManager ()
virtual void	go ()=0
void	register_work_units (const protocols::wum::WorkUnitList &work_unit_list)
WorkUnitQueue &	outbound ()
WorkUnitQueue &	inbound ()
const WorkUnitQueue &	outbound () const
const WorkUnitQueue &	inbound () const

Protected Member Functions
const protocols::wum::WorkUnitList &	work_unit_list () const
protocols::wum::WorkUnitList &	work_unit_list ()
void	write_queues_to_file (const std::string &prefix="default") const
void	write_work_unit (const WorkUnitBaseOP &wu, std::ostream &out) const
void	write_queue (const WorkUnitQueue &the_queue, std::ostream &out) const
void	read_queues_from_file (const std::string &prefix="default")
bool	read_work_unit (WorkUnitBaseOP &qualified_wu, std::istream &in)
void	read_queue (WorkUnitQueue &the_queue, std::istream &in)
core::Size	mem_foot_print () const
	return total memory foot print in bytes More...

Private Attributes
protocols::wum::WorkUnitList	work_unit_list_
WorkUnitQueue	inbound_wus_
WorkUnitQueue	outbound_wus_

Friends
class	WorkUnitQueue_Swapped

Member Typedef Documentation

typedef WorkUnitQueue::const_iterator protocols::wum::WorkUnitManager::const_iterator

typedef WorkUnitQueue::iterator protocols::wum::WorkUnitManager::iterator

Constructor & Destructor Documentation

protocols::wum::WorkUnitManager::WorkUnitManager ( )

inline

virtual protocols::wum::WorkUnitManager::~WorkUnitManager ( )

inlinevirtual

Member Function Documentation

virtual void protocols::wum::WorkUnitManager::go ( )

pure virtual

Implemented in protocols::wum::MPI_WorkUnitManager, protocols::wum::DatabaseQueryWorkUnitManager< T >, protocols::loophash::MPI_LoopHashRefine_Emperor, protocols::loophash::MPI_LoopHashRefine_Master, and protocols::wum::MPI_WorkUnitManager_Slave.

WorkUnitQueue& protocols::wum::WorkUnitManager::inbound ( )

inline

References inbound_wus_.

Referenced by protocols::loophash::MPI_LoopHashRefine::load_state(), mem_foot_print(), protocols::wum::MPI_WorkUnitManager::MPI_WorkUnitManager(), protocols::wum::MPI_WorkUnitManager::print_stats(), protocols::wum::MPI_WorkUnitManager_Slave::process_inbound_wus(), protocols::wum::MPI_Relax::process_inbound_wus_master(), read_queues_from_file(), protocols::wum::MPI_WorkUnitManager::receive_MPI_workunit(), protocols::loophash::MPI_LoopHashRefine::save_state(), and write_queues_to_file().

const WorkUnitQueue& protocols::wum::WorkUnitManager::inbound ( ) const

inline

References inbound_wus_.

core::Size protocols::wum::WorkUnitManager::mem_foot_print ( ) const

inlineprotected

return total memory foot print in bytes

References inbound(), protocols::wum::WorkUnitQueue::mem_foot_print(), and outbound().

WorkUnitQueue& protocols::wum::WorkUnitManager::outbound ( )

inline

References outbound_wus_.

Referenced by protocols::wum::MPI_Relax::fill_outbound_queue(), protocols::loophash::MPI_LoopHashRefine::load_state(), mem_foot_print(), protocols::wum::MPI_WorkUnitManager::MPI_WorkUnitManager(), protocols::wum::MPI_WorkUnitManager::print_stats(), protocols::wum::MPI_WorkUnitManager_Slave::process_inbound_wus(), protocols::wum::MPI_WorkUnitManager::process_incoming_msgs(), protocols::wum::MPI_WorkUnitManager_Slave::process_outbound_wus(), read_queues_from_file(), protocols::loophash::MPI_LoopHashRefine::save_state(), protocols::wum::MPI_WorkUnitManager::send_next_WU_on_request(), and write_queues_to_file().

const WorkUnitQueue& protocols::wum::WorkUnitManager::outbound ( ) const

inline

References outbound_wus_.

void protocols::wum::WorkUnitManager::read_queue ( WorkUnitQueue &  the_queue, std::istream &  in  )

protected

References protocols::wum::WorkUnitQueue::push_back(), read_work_unit(), and protocols::wum::TR.

Referenced by read_queues_from_file().

void protocols::wum::WorkUnitManager::read_queues_from_file ( const std::string &  prefix = "default" )

protected

References inbound(), outbound(), read_queue(), and protocols::wum::TR.

Referenced by protocols::loophash::MPI_LoopHashRefine::load_state().

bool protocols::wum::WorkUnitManager::read_work_unit ( WorkUnitBaseOP &  qualified_wu, std::istream &  in  )

protected

References protocols::wum::WorkUnitList::get_work_unit(), runtime_assert, protocols::wum::TR, utility_exit_with_message, work_unit_list(), and protocols::wum::WUB_magic_header_integer.

Referenced by read_queue().

void protocols::wum::WorkUnitManager::register_work_units

(

const protocols::wum::WorkUnitList &

work_unit_list

)

References protocols::wum::WorkUnitList::merge(), and work_unit_list_.

const protocols::wum::WorkUnitList& protocols::wum::WorkUnitManager::work_unit_list ( ) const

inlineprotected

References work_unit_list_.

Referenced by protocols::wum::MPI_Relax::fill_outbound_queue(), read_work_unit(), protocols::wum::MPI_WorkUnitManager::receive_MPI_workunit(), and protocols::wum::MPI_Relax::register_work_units().

protocols::wum::WorkUnitList& protocols::wum::WorkUnitManager::work_unit_list ( )

inlineprotected

References work_unit_list_.

void protocols::wum::WorkUnitManager::write_queue ( const WorkUnitQueue &  the_queue, std::ostream &  out  ) const

protected

References protocols::wum::WorkUnitQueue::begin(), protocols::wum::WorkUnitQueue::end(), and write_work_unit().

Referenced by protocols::wum::WorkUnitQueue_Swapped::add_to_swap(), and write_queues_to_file().

void protocols::wum::WorkUnitManager::write_queues_to_file ( const std::string &  prefix = "default" ) const

protected

References inbound(), outbound(), and write_queue().

Referenced by protocols::loophash::MPI_LoopHashRefine::save_state().

void protocols::wum::WorkUnitManager::write_work_unit ( const WorkUnitBaseOP &  wu, std::ostream &  out  ) const

protected

References MPI_ONLY, out, protocols::wum::TR, and protocols::wum::WUB_magic_header_integer.

Referenced by write_queue().

Friends And Related Function Documentation

friend class WorkUnitQueue_Swapped

friend

Member Data Documentation

WorkUnitQueue protocols::wum::WorkUnitManager::inbound_wus_

private

Referenced by inbound().

WorkUnitQueue protocols::wum::WorkUnitManager::outbound_wus_

private

Referenced by outbound().

protocols::wum::WorkUnitList protocols::wum::WorkUnitManager::work_unit_list_

private

Referenced by register_work_units(), and work_unit_list().

---

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

• src/protocols/wum/WorkUnitManager.hh
• src/protocols/wum/WorkUnitManager.cc