Rosetta
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | Friends | List of all members
protocols::wum::WorkUnitManager Class Referenceabstract

#include <WorkUnitManager.hh>

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

Public Types

typedef WorkUnitQueue::iterator iterator
 
typedef WorkUnitQueue::const_iterator const_iterator
 

Public Member Functions

 WorkUnitManager ()
 
 ~WorkUnitManager () override=default
 
virtual void go ()=0
 
void register_work_units (const protocols::wum::WorkUnitList &work_unit_list)
 
WorkUnitQueueoutbound ()
 
WorkUnitQueueinbound ()
 
const WorkUnitQueueoutbound () const
 
const WorkUnitQueueinbound () const
 

Protected Member Functions

const protocols::wum::WorkUnitListwork_unit_list () const
 
protocols::wum::WorkUnitListwork_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

◆ const_iterator

◆ iterator

Constructor & Destructor Documentation

◆ WorkUnitManager()

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

◆ ~WorkUnitManager()

protocols::wum::WorkUnitManager::~WorkUnitManager ( )
overridedefault

Member Function Documentation

◆ go()

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

◆ inbound() [1/2]

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

◆ inbound() [2/2]

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

References inbound_wus_.

◆ mem_foot_print()

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().

◆ outbound() [1/2]

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

◆ outbound() [2/2]

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

References outbound_wus_.

◆ read_queue()

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

◆ read_queues_from_file()

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

◆ read_work_unit()

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

◆ register_work_units()

void protocols::wum::WorkUnitManager::register_work_units ( const protocols::wum::WorkUnitList work_unit_list)

◆ work_unit_list() [1/2]

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

References work_unit_list_.

◆ work_unit_list() [2/2]

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

◆ write_queue()

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

◆ write_queues_to_file()

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

◆ write_work_unit()

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

Friends And Related Function Documentation

◆ WorkUnitQueue_Swapped

friend class WorkUnitQueue_Swapped
friend

Member Data Documentation

◆ inbound_wus_

WorkUnitQueue protocols::wum::WorkUnitManager::inbound_wus_
private

Referenced by inbound().

◆ outbound_wus_

WorkUnitQueue protocols::wum::WorkUnitManager::outbound_wus_
private

Referenced by outbound().

◆ work_unit_list_

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

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