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

This WorkUnit type can encapsulate any MoverOP. When registering this WOrkunit provide it with a MoverOP and then, when executed on the slaves, this workunit will run the mover On every single input structure and return the results. More...

#include <WorkUnitBase.hh>

Inheritance diagram for protocols::wum::WorkUnit_MoverWrapper:
Inheritance graph
[legend]
Collaboration diagram for protocols::wum::WorkUnit_MoverWrapper:
Collaboration graph
[legend]

Public Member Functions

 WorkUnit_MoverWrapper (protocols::moves::MoverOP the_mover)
 
virtual ~WorkUnit_MoverWrapper ()
 
virtual
protocols::wum::WorkUnitBaseOP 
clone () const
 
virtual void run ()
 This Work unit doesnt do anything - its just keeps the structures. More...
 
- Public Member Functions inherited from protocols::wum::WorkUnit_SilentStructStore
 WorkUnit_SilentStructStore ()
 
virtual ~WorkUnit_SilentStructStore ()
 
virtual void serialize ()
 write decoys into serial data store overwritinge whatever was there before. It basically syncs the silent struct store with the derial data More...
 
virtual void deserialize ()
 Make ready for working. More...
 
const
protocols::wum::SilentStructStore
decoys () const
 Accessor for decoy store. More...
 
protocols::wum::SilentStructStoredecoys ()
 Accessor for decoy store. More...
 
- Public Member Functions inherited from protocols::wum::WorkUnitBase
 WorkUnitBase ()
 
virtual ~WorkUnitBase ()
 
virtual void clear_serial_data ()
 Remove all data, make sure that the memory is also cleared, hence the cals to reserve. More...
 
void print (std::ostream &out, bool verbose=false) const
 Print header information to the stream, single line by default or verbose if verbose is set to true. More...
 
core::Size id ()
 Accessor to the ID of the WorkUnit. More...
 
core::Size extra_data_1 ()
 Accessor to the extra_data_1 and 3 field of the header. More...
 
core::Size extra_data_3 ()
 
void add_blacklist (int mpi_rank)
 Adds to the blacklist. More...
 
void clear_blacklist ()
 Erases the blacklist. More...
 
bool in_blacklist (int mpi_rank)
 Finds in blacklist, true if is, false if it isn't. More...
 
core::Size get_run_time ()
 Returns the differrence between unix start and stop times. More...
 
std::string get_wu_type () const
 Accessor to header structure, return the WorkUnit Type. More...
 
void set_wu_type (const std::string &text)
 Accessor to header structure, sets the WorkUnit Type. More...
 
std::string get_options () const
 Optain the options string from the header. More...
 
virtual core::Size mem_footprint () const
 Return the memory usage of this WorkUnit. More...
 
core::Size last_received_from ()
 

Protected Member Functions

void set_defaults ()
 

Private Attributes

protocols::moves::MoverOP the_mover_
 

Additional Inherited Members

- Protected Attributes inherited from protocols::wum::WorkUnitBase
WU_Header header
 The header data. More...
 
core::Size last_received_from_
 Contains the serial number of whatever Rank/Node this WU was last receeived from. More...
 
std::vector< intblacklist_
 Contains blacklist of nodes. This data is NOT sent, and is only used on the sending side to determine where not to send a workunit. More...
 

Detailed Description

This WorkUnit type can encapsulate any MoverOP. When registering this WOrkunit provide it with a MoverOP and then, when executed on the slaves, this workunit will run the mover On every single input structure and return the results.

Constructor & Destructor Documentation

protocols::wum::WorkUnit_MoverWrapper::WorkUnit_MoverWrapper ( protocols::moves::MoverOP  the_mover)

References set_defaults().

Referenced by clone().

virtual protocols::wum::WorkUnit_MoverWrapper::~WorkUnit_MoverWrapper ( )
inlinevirtual

Member Function Documentation

virtual protocols::wum::WorkUnitBaseOP protocols::wum::WorkUnit_MoverWrapper::clone ( ) const
inlinevirtual
void protocols::wum::WorkUnit_MoverWrapper::run ( )
virtual
void protocols::wum::WorkUnit_MoverWrapper::set_defaults ( )
protected

Referenced by WorkUnit_MoverWrapper().

Member Data Documentation

protocols::moves::MoverOP protocols::wum::WorkUnit_MoverWrapper::the_mover_
private

Referenced by run().


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