protocols::wum::WorkUnitQueue Class Reference

#include <WorkUnitManager.hh>

Inheritance diagram for protocols::wum::WorkUnitQueue:

Public Types
typedef std::list < WorkUnitBaseOP >::iterator	iterator
typedef std::list < WorkUnitBaseOP > ::const_iterator	const_iterator

Public Member Functions
	WorkUnitQueue ()
virtual	~WorkUnitQueue ()
virtual core::Size	size () const
virtual void	add (WorkUnitBaseOP new_wu)
virtual void	push_back (WorkUnitBaseOP new_wu)
virtual void	push_front (WorkUnitBaseOP new_wu)
virtual WorkUnitBaseOP &	next ()
virtual WorkUnitBaseOP	pop_next ()
virtual iterator	erase (iterator i)
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
virtual void	clear ()
core::Size	mem_foot_print () const
	return total memory foot print in bytes More...
void	mem_stats (core::Size &n_structs, core::Size &structs_memory, core::Size &WU_memory) const
	report number of total structures, and memory foot prints More...
void	set_memory_limit (core::Size memory_limit)
bool	is_under_memory_limit () const

Protected Attributes
std::list< WorkUnitBaseOP >	wus_

Private Attributes
core::Size	memory_limit_

Member Typedef Documentation

typedef std::list< WorkUnitBaseOP >::const_iterator protocols::wum::WorkUnitQueue::const_iterator

typedef std::list< WorkUnitBaseOP >::iterator protocols::wum::WorkUnitQueue::iterator

Constructor & Destructor Documentation

protocols::wum::WorkUnitQueue::WorkUnitQueue ( )

inline

virtual protocols::wum::WorkUnitQueue::~WorkUnitQueue ( )

inlinevirtual

Member Function Documentation

virtual void protocols::wum::WorkUnitQueue::add ( WorkUnitBaseOP  new_wu )

inlinevirtual

Reimplemented in protocols::wum::WorkUnitQueue_Swapped.

References is_under_memory_limit(), and wus_.

Referenced by protocols::wum::WorkUnitQueue_Swapped::add(), protocols::wum::WorkUnitQueue_Swapped::add_to_swap(), protocols::wum::MPI_WorkUnitManager_Slave::process_inbound_wus(), and protocols::wum::MPI_WorkUnitManager::receive_MPI_workunit().

iterator protocols::wum::WorkUnitQueue::begin ( )

inline

References wus_.

Referenced by protocols::wum::MPI_WorkUnitManager::send_next_WU_on_request().

const_iterator protocols::wum::WorkUnitQueue::begin ( ) const

inline

References wus_.

virtual void protocols::wum::WorkUnitQueue::clear ( )

inlinevirtual

References wus_.

Referenced by protocols::wum::WorkUnitQueue_Swapped::add_to_swap(), protocols::loophash::MPI_LoopHashRefine::load_state(), and protocols::mpi_refinement::MPI_Refinement::load_state().

iterator protocols::wum::WorkUnitQueue::end ( )

inline

References wus_.

Referenced by protocols::wum::MPI_WorkUnitManager::send_next_WU_on_request().

const_iterator protocols::wum::WorkUnitQueue::end ( ) const

inline

References wus_.

WorkUnitQueue::iterator protocols::wum::WorkUnitQueue::erase ( iterator  i )

virtual

References wus_.

Referenced by protocols::wum::MPI_WorkUnitManager::send_next_WU_on_request().

bool protocols::wum::WorkUnitQueue::is_under_memory_limit ( ) const

inline

References mem_foot_print(), and memory_limit_.

Referenced by add(), push_back(), and push_front().

core::Size protocols::wum::WorkUnitQueue::mem_foot_print

(

)

const

return total memory foot print in bytes

References mem_stats().

Referenced by is_under_memory_limit(), protocols::wum::WorkUnitManager::mem_foot_print(), and protocols::wum::MPI_WorkUnitManager::print_stats().

void protocols::wum::WorkUnitQueue::mem_stats	(	core::Size &	n_structs,
		core::Size &	structs_memory,
		core::Size &	WU_memory
	)		const

report number of total structures, and memory foot prints

References protocols::wum::SilentStructStore::size().

Referenced by mem_foot_print(), and protocols::wum::MPI_WorkUnitManager::print_stats().

WorkUnitBaseOP & protocols::wum::WorkUnitQueue::next ( )

virtual

References wus_.

Referenced by pop_next(), and protocols::wum::MPI_WorkUnitManager_Slave::process_inbound_wus().

WorkUnitBaseOP protocols::wum::WorkUnitQueue::pop_next ( )

virtual

References next(), size(), and wus_.

Referenced by protocols::wum::MPI_WorkUnitManager_Slave::process_inbound_wus(), and protocols::wum::MPI_WorkUnitManager_Slave::process_outbound_wus().

virtual void protocols::wum::WorkUnitQueue::push_back ( WorkUnitBaseOP  new_wu )

inlinevirtual

References is_under_memory_limit(), and wus_.

Referenced by protocols::wum::WorkUnitManager::read_queue(), and protocols::wum::MPI_WorkUnitManager::send_next_WU_on_request().

virtual void protocols::wum::WorkUnitQueue::push_front ( WorkUnitBaseOP  new_wu )

inlinevirtual

References is_under_memory_limit(), and wus_.

void protocols::wum::WorkUnitQueue::set_memory_limit ( core::Size  memory_limit )

inline

References memory_limit_.

Referenced by protocols::wum::MPI_WorkUnitManager::MPI_WorkUnitManager().

virtual core::Size protocols::wum::WorkUnitQueue::size ( ) const

inlinevirtual

References wus_.

Referenced by protocols::wum::WorkUnitQueue_Swapped::add_to_swap(), pop_next(), protocols::wum::MPI_WorkUnitManager::print_stats(), protocols::wum::MPI_WorkUnitManager::process_incoming_msgs(), protocols::loophash::MPI_LoopHashRefine::save_state(), protocols::mpi_refinement::MPI_Refinement::save_state(), and protocols::wum::MPI_WorkUnitManager::send_next_WU_on_request().

Member Data Documentation

core::Size protocols::wum::WorkUnitQueue::memory_limit_

private

Referenced by is_under_memory_limit(), and set_memory_limit().

std::list< WorkUnitBaseOP > protocols::wum::WorkUnitQueue::wus_

protected

Referenced by add(), protocols::wum::WorkUnitQueue_Swapped::add(), begin(), clear(), end(), erase(), next(), pop_next(), push_back(), push_front(), and size().

---

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

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