Rosetta Protocols  2014.35
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
protocols::wum2::WorkUnit Class Referenceabstract

The base class for all work units, this is abstract. More...

#include <WorkUnit.hh>

Public Member Functions

 WorkUnit ()
 
 WorkUnit (core::Size master, core::Size trajectory_idx)
 
virtual ~WorkUnit ()
 
virtual void run ()=0
 Run the workunit. More...
 
virtual void print (std::ostream &out, bool verbose=false) const
 Print WU details to the stream, single line by default. 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...
 
core::Size get_run_time ()
 Returns the difference between unix start and stop times. More...
 
void id (int id)
 
int id ()
 
void master (int master)
 
int master ()
 
void trajectory_idx (int trajectory_idx)
 
int trajectory_idx ()
 
void prioritize (bool prioritize)
 
bool prioritize ()
 
void link_cache (protocols::moves::MoverCacheSP cache)
 

Protected Member Functions

void create_unique_id ()
 

Protected Attributes

bool prioritize_
 
int id_
 
int master_
 
int trajectory_idx_
 
core::Size unixtime_creation_
 Important unixtimes. More...
 
core::Size unixtime_start_
 
core::Size unixtime_stop_
 
protocols::moves::MoverCacheSP cache_
 

Detailed Description

The base class for all work units, this is abstract.

Constructor & Destructor Documentation

protocols::wum2::WorkUnit::WorkUnit ( )
inline
protocols::wum2::WorkUnit::WorkUnit ( core::Size  master,
core::Size  trajectory_idx 
)
virtual protocols::wum2::WorkUnit::~WorkUnit ( )
inlinevirtual

Member Function Documentation

void protocols::wum2::WorkUnit::create_unique_id ( )
protected

References id_.

core::Size protocols::wum2::WorkUnit::get_run_time ( )

Returns the difference between unix start and stop times.

References unixtime_start_, and unixtime_stop_.

void protocols::wum2::WorkUnit::id ( int  id)
inline

References id(), and id_.

Referenced by id().

int protocols::wum2::WorkUnit::id ( )
inline

References id_.

void protocols::wum2::WorkUnit::link_cache ( protocols::moves::MoverCacheSP  cache)
inline

References cache_.

void protocols::wum2::WorkUnit::master ( int  master)
inline

References master(), and master_.

Referenced by master().

int protocols::wum2::WorkUnit::master ( )
inline

References master_.

void protocols::wum2::WorkUnit::print ( std::ostream &  out,
bool  verbose = false 
) const
virtual

Print WU details to the stream, single line by default.

References id_, unixtime_creation_, unixtime_start_, and unixtime_stop_.

void protocols::wum2::WorkUnit::prioritize ( bool  prioritize)
inline

References prioritize(), and prioritize_.

Referenced by prioritize().

bool protocols::wum2::WorkUnit::prioritize ( )
inline

References prioritize_.

virtual void protocols::wum2::WorkUnit::run ( )
pure virtual
void protocols::wum2::WorkUnit::set_run_start ( )

Set the unixtime of the start of the execution of this WorkUnit.

References unixtime_start_.

void protocols::wum2::WorkUnit::set_run_stop ( )

Set the unixtime of the stop of the execution of this WorkUnit.

References unixtime_stop_.

void protocols::wum2::WorkUnit::trajectory_idx ( int  trajectory_idx)
inline

References trajectory_idx(), and trajectory_idx_.

Referenced by trajectory_idx().

int protocols::wum2::WorkUnit::trajectory_idx ( )
inline

References trajectory_idx_.

Member Data Documentation

protocols::moves::MoverCacheSP protocols::wum2::WorkUnit::cache_
protected

Referenced by link_cache().

int protocols::wum2::WorkUnit::id_
protected

Referenced by create_unique_id(), id(), and print().

int protocols::wum2::WorkUnit::master_
protected

Referenced by master().

bool protocols::wum2::WorkUnit::prioritize_
protected

Referenced by prioritize().

int protocols::wum2::WorkUnit::trajectory_idx_
protected

Referenced by trajectory_idx().

core::Size protocols::wum2::WorkUnit::unixtime_creation_
protected

Important unixtimes.

Referenced by print().

core::Size protocols::wum2::WorkUnit::unixtime_start_
protected

Referenced by get_run_time(), print(), and set_run_start().

core::Size protocols::wum2::WorkUnit::unixtime_stop_
protected

Referenced by get_run_time(), print(), and set_run_stop().


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