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

#include <WorkUnitManager.hh>

Inheritance diagram for protocols::wum::WorkUnitQueue:
Inheritance graph
[legend]

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 WorkUnitBaseOPnext ()
 
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< WorkUnitBaseOPwus_
 

Private Attributes

core::Size memory_limit_
 

Member Typedef Documentation

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
iterator protocols::wum::WorkUnitQueue::begin ( )
inline
const_iterator protocols::wum::WorkUnitQueue::begin ( ) const
inline

References wus_.

virtual void protocols::wum::WorkUnitQueue::clear ( )
inlinevirtual
iterator protocols::wum::WorkUnitQueue::end ( )
inline
const_iterator protocols::wum::WorkUnitQueue::end ( ) const
inline

References wus_.

WorkUnitQueue::iterator protocols::wum::WorkUnitQueue::erase ( iterator  i)
virtual
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
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
WorkUnitBaseOP protocols::wum::WorkUnitQueue::pop_next ( )
virtual
virtual void protocols::wum::WorkUnitQueue::push_back ( WorkUnitBaseOP  new_wu)
inlinevirtual
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
virtual core::Size protocols::wum::WorkUnitQueue::size ( ) const
inlinevirtual

Member Data Documentation

core::Size protocols::wum::WorkUnitQueue::memory_limit_
private
std::list< WorkUnitBaseOP > protocols::wum::WorkUnitQueue::wus_
protected

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