Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
protocols::jd2::archive::BaseArchiveManager Class Referenceabstract

ArchiveManager is responsible for communication with JobDistributor and organization of Batches and returning decoys he owns an Archive (AbstractArchiveBase) that will be handed the decoys and is asked to generate_batch() if the QUEUE_EMPTY . More...

#include <ArchiveManager.hh>

Inheritance diagram for protocols::jd2::archive::BaseArchiveManager:
Inheritance graph
[legend]

Public Types

typedef utility::vector1< BatchBatchList
 

Public Member Functions

 BaseArchiveManager ()
 ctor is protected; singleton pattern More...
 
virtual ~BaseArchiveManager ()
 
virtual Batchstart_new_batch ()
 
virtual void finalize_batch (Batch &, bool reread=false)
 
virtual void cancel_batches_previous_to (core::Size batch_id, bool allow_reading_of_decoys=true)
 
virtual void save_archive ()=0
 
BatchList const & batches () const
 
virtual bool restore_archive ()=0
 
core::Size last_batch_id () const
 

Protected Member Functions

virtual void queue_batch (Batch const &batch)=0
 
virtual void cancel_batch (Batch &batch, bool allow_reading_of_decoys=true)
 
void set_archive (AbstractArchiveBaseOP)
 
AbstractArchiveBasethe_archive ()
 
virtual void unlock_file (Batch const &, bool)
 
void read_returning_decoys (Batch &batch, bool final)
 

Protected Attributes

utility::vector1< Batchbatches_
 

Static Protected Attributes

static bool options_registered_
 

Private Attributes

AbstractArchiveBaseOP theArchive_
 

Detailed Description

ArchiveManager is responsible for communication with JobDistributor and organization of Batches and returning decoys he owns an Archive (AbstractArchiveBase) that will be handed the decoys and is asked to generate_batch() if the QUEUE_EMPTY .

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::jd2::archive::BaseArchiveManager::BaseArchiveManager ( )
inline

ctor is protected; singleton pattern

virtual protocols::jd2::archive::BaseArchiveManager::~BaseArchiveManager ( )
inlinevirtual

Member Function Documentation

BatchList const& protocols::jd2::archive::BaseArchiveManager::batches ( ) const
inline
void protocols::jd2::archive::BaseArchiveManager::cancel_batch ( Batch batch,
bool  allow_reading_of_decoys = true 
)
protectedvirtual
void protocols::jd2::archive::BaseArchiveManager::cancel_batches_previous_to ( core::Size  batch_id,
bool  allow_reading_of_decoys = true 
)
virtual
void protocols::jd2::archive::BaseArchiveManager::finalize_batch ( Batch new_batch,
bool  reread = false 
)
virtual
core::Size protocols::jd2::archive::BaseArchiveManager::last_batch_id ( ) const
inline
virtual void protocols::jd2::archive::BaseArchiveManager::queue_batch ( Batch const &  batch)
protectedpure virtual
void protocols::jd2::archive::BaseArchiveManager::read_returning_decoys ( Batch batch,
bool  final 
)
protected
virtual bool protocols::jd2::archive::BaseArchiveManager::restore_archive ( )
pure virtual
virtual void protocols::jd2::archive::BaseArchiveManager::save_archive ( )
pure virtual
void protocols::jd2::archive::BaseArchiveManager::set_archive ( AbstractArchiveBaseOP  anArchive)
protected
Batch & protocols::jd2::archive::BaseArchiveManager::start_new_batch ( )
virtual
AbstractArchiveBase& protocols::jd2::archive::BaseArchiveManager::the_archive ( )
inlineprotected
virtual void protocols::jd2::archive::BaseArchiveManager::unlock_file ( Batch const &  ,
bool   
)
inlineprotectedvirtual

Member Data Documentation

utility::vector1< Batch > protocols::jd2::archive::BaseArchiveManager::batches_
protected
bool protocols::jd2::archive::BaseArchiveManager::options_registered_
staticprotected
AbstractArchiveBaseOP protocols::jd2::archive::BaseArchiveManager::theArchive_
private

Referenced by the_archive().


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