A task operation that restricts the number of threads allowed for interaction graph computation. More...

#include <RestrictInteractionGraphThreadsOperation.hh>

Inheritance diagram for core::pack::task::operation::RestrictInteractionGraphThreadsOperation:

Public Member Functions
	RestrictInteractionGraphThreadsOperation ()
	Default constructor. More...

	RestrictInteractionGraphThreadsOperation (core::Size const thread_limit_in)
	Initialization constructor. More...

	RestrictInteractionGraphThreadsOperation (RestrictInteractionGraphThreadsOperation const &src)
	Default copy constructor. More...

	~RestrictInteractionGraphThreadsOperation () override
	Destructor. More...

core::pack::task::operation::TaskOperationOP	clone () const override
	Clone operation: make a copy of this object, and return a smart pointer to the copy. More...

void	parse_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
	Configure from a RosettaScripts XML tag. More...

void	apply (core::pose::Pose const &pose, core::pack::task::PackerTask &task) const override
	Alter a PackerTask by reducing the number of allowed threads for packer setup to the number specified by this TaskOperation. More...

void	set_thread_limit (core::Size const setting)
	Set the maximum number of threads that this TaskOperation will allow for packer setup. More...

core::Size	thread_limit () const
	Get the maximum number of threads that this TaskOperation will allow for packer setup. More...

Public Member Functions inherited from core::pack::task::operation::TaskOperation
	~TaskOperation () override

virtual void	provide_citation_info (basic::citation_manager::CitationCollectionList &) const
	Provide citations to the passed CitationCollectionList Subclasses should add the info for themselves and any other classes they use. More...

Static Public Member Functions
static std::string	keyname ()
	Return the name used to construct this TaskOperation from an XML file. More...

static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
	Describe the format of XML file used to initialize this TaskOperation. More...

Private Attributes
core::Size	num_threads_ = 0
	The number of threads to limit the packer to using. If this is set to zero, this operation does nothing. Otherwise, it reduces the allowed number of threads to the specified value. If the allowed number of threads is less than the specified value, it does nothing. More...

Additional Inherited Members
Public Types inherited from core::pack::task::operation::TaskOperation
typedef utility::tag::TagCOP	TagCOP

typedef basic::datacache::DataMap	DataMap

typedef pose::Pose	Pose

Detailed Description

A task operation that restricts the number of threads allowed for interaction graph computation.

Constructor & Destructor Documentation

core::pack::task::operation::RestrictInteractionGraphThreadsOperation::RestrictInteractionGraphThreadsOperation ( )

default

Default constructor.

core::pack::task::operation::RestrictInteractionGraphThreadsOperation::RestrictInteractionGraphThreadsOperation ( core::Size const thread_limit_in )

Initialization constructor.

Parameters

[in] thread_limit_in The number of threads to limit the packer to using. If this is set to zero, this operation does nothing. Otherwise, it reduces the allowed number of threads to the specified value. If the allowed number of threads is less than the specified value, it does nothing.

core::pack::task::operation::RestrictInteractionGraphThreadsOperation::RestrictInteractionGraphThreadsOperation ( RestrictInteractionGraphThreadsOperation const & src )

default

Default copy constructor.

core::pack::task::operation::RestrictInteractionGraphThreadsOperation::~RestrictInteractionGraphThreadsOperation ( )

override

Destructor.

Member Function Documentation

void core::pack::task::operation::RestrictInteractionGraphThreadsOperation::apply	(	core::pose::Pose const &	pose,
		core::pack::task::PackerTask &	task
	)		const

overridevirtual

Alter a PackerTask by reducing the number of allowed threads for packer setup to the number specified by this TaskOperation.

Does nothing if this TaskOperation's allowed threads are set to zero or if the number already allowed in the PackerTask is less than the number allowed by the TaskOperation.

Implements core::pack::task::operation::TaskOperation.

References core::pack::task::PackerTask::limit_ig_setup_threads(), and thread_limit().

TaskOperationOP core::pack::task::operation::RestrictInteractionGraphThreadsOperation::clone ( ) const

overridevirtual

Clone operation: make a copy of this object, and return a smart pointer to the copy.

Implements core::pack::task::operation::TaskOperation.

std::string core::pack::task::operation::RestrictInteractionGraphThreadsOperation::keyname ( )

static

Return the name used to construct this TaskOperation from an XML file.

Referenced by core::pack::task::operation::RestrictInteractionGraphThreadsOperationCreator::keyname(), and provide_xml_schema().

void core::pack::task::operation::RestrictInteractionGraphThreadsOperation::parse_tag	(	utility::tag::TagCOP	tag,
		basic::datacache::DataMap &
	)

overridevirtual

Configure from a RosettaScripts XML tag.

Reimplemented from core::pack::task::operation::TaskOperation.

References set_thread_limit(), and thread_limit().

void core::pack::task::operation::RestrictInteractionGraphThreadsOperation::provide_xml_schema ( utility::tag::XMLSchemaDefinition & xsd )

static

Describe the format of XML file used to initialize this TaskOperation.

References keyname(), and core::pack::task::operation::task_op_schema_w_attributes().

Referenced by core::pack::task::operation::RestrictInteractionGraphThreadsOperationCreator::provide_xml_schema().

void core::pack::task::operation::RestrictInteractionGraphThreadsOperation::set_thread_limit ( core::Size const setting )

Set the maximum number of threads that this TaskOperation will allow for packer setup.

Set this to zero to indicate no limit.

References num_threads_, and core::pack::task::operation::TR().

Referenced by parse_tag().

core::Size core::pack::task::operation::RestrictInteractionGraphThreadsOperation::thread_limit ( ) const

inline

Get the maximum number of threads that this TaskOperation will allow for packer setup.

Zero indicates no limit.

References num_threads_.

Referenced by apply(), and parse_tag().

Member Data Documentation

core::Size core::pack::task::operation::RestrictInteractionGraphThreadsOperation::num_threads_ = 0

private

The number of threads to limit the packer to using. If this is set to zero, this operation does nothing. Otherwise, it reduces the allowed number of threads to the specified value. If the allowed number of threads is less than the specified value, it does nothing.

Referenced by set_thread_limit(), and thread_limit().

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

src/core/pack/task/operation/RestrictInteractionGraphThreadsOperation.hh
src/core/pack/task/operation/RestrictInteractionGraphThreadsOperation.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation