protocols::wum::WorkUnitQueue_Swapped Class Reference

#include <WorkUnitManager.hh>

Inheritance diagram for protocols::wum::WorkUnitQueue_Swapped:

Public Member Functions
	WorkUnitQueue_Swapped (WorkUnitManager *wum, std::string const &swap_file, core::Size memory_limit)
	~WorkUnitQueue_Swapped () override
void	add (WorkUnitBaseOP new_wu) override
const std::string &	swap_file () const
Public Member Functions inherited from protocols::wum::WorkUnitQueue
	WorkUnitQueue ()
virtual	~WorkUnitQueue ()
virtual core::Size	size () const
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 Member Functions
virtual void	add_to_swap (WorkUnitBaseOP new_wu)

Private Member Functions
void	set_swap_file (const std::string &swap_file)

Private Attributes
std::string	swap_file_
WorkUnitQueue	swap_buffer_
core::Size	memory_limit_
core::Size	max_swap_buffer_size_
core::Size	n_swap_total_
core::Size	n_swap_dead_
WorkUnitManager *	wum_

Additional Inherited Members
Public Types inherited from protocols::wum::WorkUnitQueue
typedef std::list < WorkUnitBaseOP >::iterator	iterator
typedef std::list < WorkUnitBaseOP > ::const_iterator	const_iterator
Protected Attributes inherited from protocols::wum::WorkUnitQueue
std::list< WorkUnitBaseOP >	wus_

Constructor & Destructor Documentation

protocols::wum::WorkUnitQueue_Swapped::WorkUnitQueue_Swapped ( WorkUnitManager *  wum, std::string const &  swap_file, core::Size  memory_limit  )

inline

protocols::wum::WorkUnitQueue_Swapped::~WorkUnitQueue_Swapped ( )

inlineoverride

Member Function Documentation

void protocols::wum::WorkUnitQueue_Swapped::add ( WorkUnitBaseOP  new_wu )

overridevirtual

Reimplemented from protocols::wum::WorkUnitQueue.

References protocols::wum::WorkUnitQueue::add(), add_to_swap(), memory_limit_, n_swap_dead_, n_swap_total_, and protocols::wum::WorkUnitQueue::wus_.

void protocols::wum::WorkUnitQueue_Swapped::add_to_swap ( WorkUnitBaseOP  new_wu )

protectedvirtual

References protocols::wum::WorkUnitQueue::add(), protocols::wum::WorkUnitQueue::clear(), max_swap_buffer_size_, protocols::wum::WorkUnitQueue::size(), swap_buffer_, swap_file_, protocols::wum::WorkUnitManager::write_queue(), and wum_.

Referenced by add().

void protocols::wum::WorkUnitQueue_Swapped::set_swap_file ( const std::string &  swap_file )

inlineprivate

References swap_file(), and swap_file_.

const std::string& protocols::wum::WorkUnitQueue_Swapped::swap_file ( ) const

inline

References swap_file_.

Referenced by set_swap_file().

Member Data Documentation

core::Size protocols::wum::WorkUnitQueue_Swapped::max_swap_buffer_size_

private

Referenced by add_to_swap().

core::Size protocols::wum::WorkUnitQueue_Swapped::memory_limit_

private

Referenced by add().

core::Size protocols::wum::WorkUnitQueue_Swapped::n_swap_dead_

private

Referenced by add().

core::Size protocols::wum::WorkUnitQueue_Swapped::n_swap_total_

private

Referenced by add().

WorkUnitQueue protocols::wum::WorkUnitQueue_Swapped::swap_buffer_

private

Referenced by add_to_swap().

std::string protocols::wum::WorkUnitQueue_Swapped::swap_file_

private

Referenced by add_to_swap(), set_swap_file(), and swap_file().

WorkUnitManager* protocols::wum::WorkUnitQueue_Swapped::wum_

private

Referenced by add_to_swap().

---

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

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