protocols::wum Namespace Reference

Classes
class	DatabaseEntryWorkUnit
class	find_SilentStructOPs
	this little class is a predicate for finding silent structures in say a vector of silent structures More...
class	MoverList
class	MPI_WorkUnitManager
class	MPI_WorkUnitManager_Slave
class	SilentStructStore
class	sort_SilentStructOPs
class	WorkUnit_MoverWrapper
	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...
class	WorkUnit_SilentStructStore
	This WorkUnit type has structures in it. Most Workunits should derive from this one rather THe the Base class. More...
class	WorkUnit_Wait
class	WorkUnitBase
	The base class for all work units. More...
class	WorkUnitList
	WOrkUnitList is a store for WorkUnitCOPs. THe purpose of this class is to store all the possible WorkUnits that a protocol might need. When needed these are cloned and then used. THis class acts like a library of WorkUnit blueprints. More...
class	WorkUnitManager
class	WorkUnitQueue
class	WorkUnitQueue_Swapped

Typedefs
typedef utility::pointer::shared_ptr < DatabaseEntryWorkUnit >	DatabaseEntryWorkUnitOP
typedef utility::pointer::shared_ptr < DatabaseEntryWorkUnit const >	DatabaseEntryWorkUnitCOP
typedef const MoverList *	MoverListCAP
typedef utility::pointer::shared_ptr < MPI_WorkUnitManager >	MPI_WorkUnitManagerOP
typedef utility::pointer::shared_ptr < MPI_WorkUnitManager const >	MPI_WorkUnitManagerCOP
typedef utility::pointer::shared_ptr < SilentStructStore >	SilentStructStoreOP
typedef utility::pointer::shared_ptr < SilentStructStore const >	SilentStructStoreCOP
typedef utility::pointer::shared_ptr < WorkUnitBase >	WorkUnitBaseOP
typedef utility::pointer::shared_ptr < WorkUnitBase const >	WorkUnitBaseCOP
typedef utility::pointer::shared_ptr < WorkUnit_Wait >	WorkUnit_WaitOP
typedef utility::pointer::shared_ptr < WorkUnit_Wait const >	WorkUnit_WaitCOP
typedef utility::pointer::shared_ptr < WorkUnit_SilentStructStore >	WorkUnit_SilentStructStoreOP
typedef utility::pointer::shared_ptr < WorkUnit_SilentStructStore const >	WorkUnit_SilentStructStoreCOP
typedef utility::pointer::shared_ptr < WorkUnit_MoverWrapper >	WorkUnit_MoverWrapperOP
typedef utility::pointer::shared_ptr < WorkUnit_MoverWrapper const >	WorkUnit_MoverWrapperCOP
typedef const WorkUnitList *	WorkUnitListCAP
	@ brief just a prettier name for a pointer to a work unitlist. More...
typedef utility::pointer::shared_ptr < WorkUnitManager >	WorkUnitManagerOP
typedef utility::pointer::shared_ptr < WorkUnitManager const >	WorkUnitManagerCOP

Enumerations
enum	WUM_MPI_TAGS {   WUM_MPI_REQUEST_WU =101, WUM_MPI_SEND_WU, WUM_MPI_DATA_BLOCK, WUM_MPI_SPINDOWN,   WUM_MPI_end }

Functions
static thread_local basic::Tracer	TR ("MoverList")
static thread_local basic::Tracer	TR ("MPI_WUM")
int	mpi_rank ()
	Helper function - returns rank of the current node. More...
int	mpi_npes ()
	Helper function - returns total number of nodes. More...
core::Real	get_time ()
	Get a time in seconds. If MPI is enabled you'll get an accuracy of microsecs. More...
static thread_local basic::Tracer	TR ("MPI_WUM_Slave")
static thread_local basic::Tracer	TR ("SilentStructStore")
std::string	encode_alphanum (unsigned long number, int pad_width=0, char pad_char= '0')
std::string	generate_unique_structure_id ()
static thread_local basic::Tracer	TR ("WorkUnitBase")
static thread_local basic::Tracer	TR ("WorkUnitList")
static thread_local basic::Tracer	TR ("WorkUnitManager")

Variables
const unsigned int	WUB_magic_header_integer = 0xAF34B14C

Typedef Documentation

typedef utility::pointer::shared_ptr< DatabaseEntryWorkUnit const > protocols::wum::DatabaseEntryWorkUnitCOP

typedef utility::pointer::shared_ptr< DatabaseEntryWorkUnit > protocols::wum::DatabaseEntryWorkUnitOP

typedef const MoverList* protocols::wum::MoverListCAP

typedef utility::pointer::shared_ptr< MPI_WorkUnitManager const > protocols::wum::MPI_WorkUnitManagerCOP

typedef utility::pointer::shared_ptr< MPI_WorkUnitManager > protocols::wum::MPI_WorkUnitManagerOP

typedef utility::pointer::shared_ptr< SilentStructStore const > protocols::wum::SilentStructStoreCOP

typedef utility::pointer::shared_ptr< SilentStructStore > protocols::wum::SilentStructStoreOP

typedef utility::pointer::shared_ptr< WorkUnit_MoverWrapper const > protocols::wum::WorkUnit_MoverWrapperCOP

typedef utility::pointer::shared_ptr< WorkUnit_MoverWrapper > protocols::wum::WorkUnit_MoverWrapperOP

typedef utility::pointer::shared_ptr< WorkUnit_SilentStructStore const > protocols::wum::WorkUnit_SilentStructStoreCOP

typedef utility::pointer::shared_ptr< WorkUnit_SilentStructStore > protocols::wum::WorkUnit_SilentStructStoreOP

typedef utility::pointer::shared_ptr< WorkUnit_Wait const > protocols::wum::WorkUnit_WaitCOP

typedef utility::pointer::shared_ptr< WorkUnit_Wait > protocols::wum::WorkUnit_WaitOP

typedef utility::pointer::shared_ptr< WorkUnitBase const > protocols::wum::WorkUnitBaseCOP

typedef utility::pointer::shared_ptr< WorkUnitBase > protocols::wum::WorkUnitBaseOP

typedef const WorkUnitList* protocols::wum::WorkUnitListCAP

@ brief just a prettier name for a pointer to a work unitlist.

typedef utility::pointer::shared_ptr< WorkUnitManager const > protocols::wum::WorkUnitManagerCOP

typedef utility::pointer::shared_ptr< WorkUnitManager > protocols::wum::WorkUnitManagerOP

Enumeration Type Documentation

enum protocols::wum::WUM_MPI_TAGS

Enumerator
WUM_MPI_REQUEST_WU
WUM_MPI_SEND_WU
WUM_MPI_DATA_BLOCK
WUM_MPI_SPINDOWN
WUM_MPI_end

Function Documentation

std::string protocols::wum::encode_alphanum	(	unsigned long	number,
		int	pad_width = 0,
		char	pad_char = '0'
	)

Referenced by generate_unique_structure_id().

std::string protocols::wum::generate_unique_structure_id

(

)

References encode_alphanum(), log(), mpi_npes(), and mpi_rank().

Referenced by protocols::loophash::WorkUnit_LoopHash::run().

core::Real protocols::wum::get_time

(

)

Get a time in seconds. If MPI is enabled you'll get an accuracy of microsecs.

Referenced by protocols::wum::MPI_WorkUnitManager::receive_MPI_workunit(), protocols::wum::MPI_WorkUnitManager::send_MPI_workunit(), and protocols::wum::MPI_WorkUnitManager::start_timer().

int protocols::wum::mpi_npes

(

)

Helper function - returns total number of nodes.

References utility_exit_with_message.

Referenced by generate_unique_structure_id(), protocols::wum::MPI_WorkUnitManager::MPI_WorkUnitManager(), and protocols::wum::MPI_WorkUnitManager::send_MPI_workunit().

int protocols::wum::mpi_rank

(

)

Helper function - returns rank of the current node.

References mpi_rank(), and utility_exit_with_message.

Referenced by protocols::wum::MPI_WorkUnitManager_Slave::go(), protocols::wum::WorkUnitBase::in_blacklist(), protocols::wum::MPI_WorkUnitManager::MPI_WorkUnitManager(), protocols::wum::MPI_WorkUnitManager_Slave::process_inbound_wus(), protocols::wum::MPI_WorkUnitManager_Slave::request_new_jobs(), and protocols::wum::MPI_WorkUnitManager::send_MPI_workunit().

static thread_local basic::Tracer protocols::wum::TR ( "MoverList"  )

static

Referenced by protocols::wum::DatabaseEntryWorkUnit::deserialize(), protocols::wum::MoverList::get_mover(), protocols::wum::WorkUnitList::get_work_unit(), protocols::wum::WorkUnitBase::raw_data_dump(), protocols::wum::WorkUnitBase::raw_data_load(), protocols::wum::WorkUnitBase::raw_data_size(), protocols::wum::WorkUnitManager::read_queue(), protocols::wum::WorkUnitManager::read_queues_from_file(), protocols::wum::WorkUnitManager::read_work_unit(), protocols::wum::WorkUnitBase::run(), protocols::wum::WorkUnit_MoverWrapper::run(), protocols::wum::DatabaseEntryWorkUnit::serialize(), protocols::wum::WorkUnitBase::WorkUnitBase(), and protocols::wum::WorkUnitManager::write_work_unit().

static thread_local basic::Tracer protocols::wum::TR ( "WorkUnitList"  )

static

static thread_local basic::Tracer protocols::wum::TR ( "WorkUnitManager"  )

static

static thread_local basic::Tracer protocols::wum::TR ( "WorkUnitBase"  )

static

static thread_local basic::Tracer protocols::wum::TR ( "MPI_WUM_Slave"  )

static

static thread_local basic::Tracer protocols::wum::TR ( "MPI_WUM"  )

static

static thread_local basic::Tracer protocols::wum::TR ( "SilentStructStore"  )

static

Variable Documentation

const unsigned int protocols::wum::WUB_magic_header_integer = 0xAF34B14C

Referenced by protocols::wum::WorkUnitManager::read_work_unit(), and protocols::wum::WorkUnitManager::write_work_unit().