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

This WorkUnit type has structures in it. Most Workunits should derive from this one rather THe the Base class. More...

#include <WorkUnitBase.hh>

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

Public Member Functions

 WorkUnit_SilentStructStore ()
 
 ~WorkUnit_SilentStructStore () override=default
 
protocols::wum::WorkUnitBaseOP clone () const override
 
void run () override
 This Work unit doesnt do anything - its just keeps the structures. More...
 
void serialize () override
 write decoys into serial data store overwritinge whatever was there before. It basically syncs the silent struct store with the derial data More...
 
void deserialize () override
 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 ()
 
 ~WorkUnitBase () override=default
 
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_2 ()
 
core::Size extra_data_3 ()
 
void set_extra_data_1 (core::Size const value)
 
void set_extra_data_2 (core::Size const value)
 
void set_extra_data_3 (core::Size const value)
 
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...
 
void set_options (const std::string &text)
 Accesor to the "options" text field. 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 ()
 

Private Attributes

protocols::wum::SilentStructStore decoys_
 This WorkUnit type has structures in it. More...
 

Additional Inherited Members

- Protected Member Functions inherited from protocols::wum::WorkUnitBase
void create_unique_id ()
 Make a unique number out of Processor Number and unix timestamp ? More...
 
std::string & serial_data ()
 Accessor to the serial data field. More...
 
const std::string & serial_data () const
 Accessor to the serial data field. More...
 
void set_run_start ()
 Set the unixtime of the start of the execution of this WorkUnit. More...
 
void set_run_stop ()
 Set the unixtime of the stop of the execution of this WorkUnit. More...
 
- 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< int > blacklist_
 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 has structures in it. Most Workunits should derive from this one rather THe the Base class.

Constructor & Destructor Documentation

protocols::wum::WorkUnit_SilentStructStore::WorkUnit_SilentStructStore ( )
inline
protocols::wum::WorkUnit_SilentStructStore::~WorkUnit_SilentStructStore ( )
overridedefault

Member Function Documentation

protocols::wum::WorkUnitBaseOP protocols::wum::WorkUnit_SilentStructStore::clone ( ) const
inlineoverridevirtual
const protocols::wum::SilentStructStore& protocols::wum::WorkUnit_SilentStructStore::decoys ( ) const
inline
protocols::wum::SilentStructStore& protocols::wum::WorkUnit_SilentStructStore::decoys ( )
inline

Accessor for decoy store.

References decoys_.

void protocols::wum::WorkUnit_SilentStructStore::deserialize ( )
overridevirtual
void protocols::wum::WorkUnit_SilentStructStore::run ( )
inlineoverridevirtual

This Work unit doesnt do anything - its just keeps the structures.

Reimplemented from protocols::wum::WorkUnitBase.

Reimplemented in protocols::wum::WorkUnit_MoverWrapper.

void protocols::wum::WorkUnit_SilentStructStore::serialize ( )
overridevirtual

write decoys into serial data store overwritinge whatever was there before. It basically syncs the silent struct store with the derial data

Reimplemented from protocols::wum::WorkUnitBase.

References decoys_, protocols::wum::WorkUnitBase::serial_data(), and protocols::wum::SilentStructStore::serialize().

Member Data Documentation

protocols::wum::SilentStructStore protocols::wum::WorkUnit_SilentStructStore::decoys_
private

This WorkUnit type has structures in it.

Referenced by decoys(), deserialize(), and serialize().


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