protocols::wum2::WorkUnit Class Reference

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

#include <WorkUnit.hh>

Inheritance diagram for protocols::wum2::WorkUnit:

Collaboration diagram for protocols::wum2::WorkUnit:

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.

Definition at line 46 of file WorkUnit.hh.

Constructor & Destructor Documentation

protocols::wum2::WorkUnit::WorkUnit ( )

inline

Definition at line 50 of file WorkUnit.hh.

protocols::wum2::WorkUnit::WorkUnit	(	core::Size	master,
		core::Size	trajectory_idx
	)

Definition at line 62 of file WorkUnit.cc.

virtual protocols::wum2::WorkUnit::~WorkUnit ( )

inlinevirtual

Definition at line 55 of file WorkUnit.hh.

Member Function Documentation

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

protected

Definition at line 96 of file WorkUnit.cc.

References id_.

core::Size protocols::wum2::WorkUnit::get_run_time

(

)

Returns the difference between unix start and stop times.

Definition at line 92 of file WorkUnit.cc.

References unixtime_start_, and unixtime_stop_.

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

inline

Definition at line 73 of file WorkUnit.hh.

References id(), and id_.

Referenced by id().

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

inline

Definition at line 74 of file WorkUnit.hh.

References id_.

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

inline

Definition at line 87 of file WorkUnit.hh.

References cache_.

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

inline

Definition at line 76 of file WorkUnit.hh.

References master(), and master_.

Referenced by master().

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

inline

Definition at line 77 of file WorkUnit.hh.

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.

Definition at line 76 of file WorkUnit.cc.

References id_, unixtime_creation_, unixtime_start_, and unixtime_stop_.

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

inline

Definition at line 82 of file WorkUnit.hh.

References prioritize(), and prioritize_.

Referenced by prioritize().

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

inline

Definition at line 83 of file WorkUnit.hh.

References prioritize_.

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

pure virtual

Run the workunit.

Implemented in protocols::wum2::WorkUnit_ElScripts, and protocols::wum2::WorkUnit_Wait.

void protocols::wum2::WorkUnit::set_run_start

(

)

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

Definition at line 84 of file WorkUnit.cc.

References unixtime_start_.

void protocols::wum2::WorkUnit::set_run_stop

(

)

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

Definition at line 88 of file WorkUnit.cc.

References unixtime_stop_.

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

inline

Definition at line 79 of file WorkUnit.hh.

References trajectory_idx(), and trajectory_idx_.

Referenced by trajectory_idx().

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

inline

Definition at line 80 of file WorkUnit.hh.

References trajectory_idx_.

Member Data Documentation

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

protected

Definition at line 128 of file WorkUnit.hh.

Referenced by link_cache().

int protocols::wum2::WorkUnit::id_

protected

Definition at line 114 of file WorkUnit.hh.

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

int protocols::wum2::WorkUnit::master_

protected

Definition at line 118 of file WorkUnit.hh.

Referenced by master().

bool protocols::wum2::WorkUnit::prioritize_

protected

Definition at line 108 of file WorkUnit.hh.

Referenced by prioritize().

int protocols::wum2::WorkUnit::trajectory_idx_

protected

Definition at line 119 of file WorkUnit.hh.

Referenced by trajectory_idx().

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

protected

Important unixtimes.

Definition at line 122 of file WorkUnit.hh.

Referenced by print().

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

protected

Definition at line 123 of file WorkUnit.hh.

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

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

protected

Definition at line 124 of file WorkUnit.hh.

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

---

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

• src/protocols/wum2/WorkUnit.hh
• src/protocols/wum2/WorkUnit.cc