core::pack::task::operation::TaskOperationFactory Class Reference

#include <TaskOperationFactory.hh>

Collaboration diagram for core::pack::task::operation::TaskOperationFactory:

Public Types
typedef utility::vector1 < TaskOperationOP >	TaskOperationOPs
typedef std::map< std::string, TaskOperationCreatorOP >	TaskOperationCreatorMap
typedef utility::tag::Tag	Tag
typedef utility::tag::TagPtr	TagPtr

Public Member Functions
void	factory_register (TaskOperationCreatorOP)
void	add_creator (TaskOperationCreatorOP)
	add a prototype, using its default type name as the map key More...
bool	has_type (std::string const &) const
void	add_creator (ResLvlTaskOperationCreatorOP)
	pass through to child factories More...
void	add_creator (ResFilterCreatorOP)
	adds a ResFilter prototype creator to the child ResFilterFactory More...
TaskOperationOP	newTaskOperation (std::string const &, TagPtr=new Tag) const
	return new TaskOperation by key lookup in task_operation_creator_map_ (new TaskOperation parses Tag if provided) More...
void	newTaskOperations (TaskOperationOPs &, TagPtr) const
	fills vector with new TaskOperations from nested "TASKOPERATIONS" TagPtr More...
void	newTaskOperations (TaskOperationOPs &, std::string const &) const
	fills vector with new TaskOperations from xml-like tag file More...

Static Public Member Functions
static TaskOperationFactory *	get_instance ()

Private Member Functions
	TaskOperationFactory ()
	the default TaskOperations are now initialized in core/init.cc via the registrator/creator scheme More...
virtual	~TaskOperationFactory ()

Private Attributes
TaskOperationCreatorMap	task_operation_creator_map_

Static Private Attributes
static TaskOperationFactory *	instance_

Detailed Description

Definition at line 44 of file TaskOperationFactory.hh.

Member Typedef Documentation

typedef utility::tag::Tag core::pack::task::operation::TaskOperationFactory::Tag

Definition at line 49 of file TaskOperationFactory.hh.

typedef utility::tag::TagPtr core::pack::task::operation::TaskOperationFactory::TagPtr

Definition at line 50 of file TaskOperationFactory.hh.

typedef std::map< std::string, TaskOperationCreatorOP > core::pack::task::operation::TaskOperationFactory::TaskOperationCreatorMap

Definition at line 48 of file TaskOperationFactory.hh.

typedef utility::vector1< TaskOperationOP > core::pack::task::operation::TaskOperationFactory::TaskOperationOPs

Definition at line 47 of file TaskOperationFactory.hh.

Constructor & Destructor Documentation

core::pack::task::operation::TaskOperationFactory::TaskOperationFactory ( )

private

the default TaskOperations are now initialized in core/init.cc via the registrator/creator scheme

Definition at line 56 of file TaskOperationFactory.cc.

Referenced by get_instance().

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

privatevirtual

Definition at line 53 of file TaskOperationFactory.cc.

Member Function Documentation

void core::pack::task::operation::TaskOperationFactory::add_creator

(

TaskOperationCreatorOP

creator)

add a prototype, using its default type name as the map key

add a TaskOperation prototype creator

Definition at line 69 of file TaskOperationFactory.cc.

References task_operation_creator_map_.

Referenced by factory_register().

void core::pack::task::operation::TaskOperationFactory::add_creator

(

ResLvlTaskOperationCreatorOP

creator)

pass through to child factories

adds a ResLvlTaskOperation prototype creator to the child ResLvlTaskOperationFactory

Definition at line 82 of file TaskOperationFactory.cc.

References core::pack::task::operation::ResLvlTaskOperationFactory::add_creator(), and core::pack::task::operation::ResLvlTaskOperationFactory::get_instance().

void core::pack::task::operation::TaskOperationFactory::add_creator

(

ResFilterCreatorOP

creator)

adds a ResFilter prototype creator to the child ResFilterFactory

Definition at line 89 of file TaskOperationFactory.cc.

References core::pack::task::operation::ResFilterFactory::add_creator(), and core::pack::task::operation::ResFilterFactory::get_instance().

void core::pack::task::operation::TaskOperationFactory::factory_register

(

TaskOperationCreatorOP

creator)

Definition at line 59 of file TaskOperationFactory.cc.

References add_creator(), and task_operation_creator_map_.

TaskOperationFactory * core::pack::task::operation::TaskOperationFactory::get_instance ( )

static

Definition at line 45 of file TaskOperationFactory.cc.

References instance_, and TaskOperationFactory().

Referenced by protocols::jd2::parser::TaskOperationLoader::load_data(), protocols::flxbb::LayerDesignOperation::parse_tag(), protocols::optimize_weights::IterativeOptEDriver::read_tagfile_to_taskfactory(), and protocols::match::TaskOperationMPM::TaskOperationMPM().

bool core::pack::task::operation::TaskOperationFactory::has_type

(

std::string const &

type)

const

Definition at line 75 of file TaskOperationFactory.cc.

References task_operation_creator_map_.

Referenced by protocols::flxbb::LayerDesignOperation::parse_tag().

TaskOperationOP core::pack::task::operation::TaskOperationFactory::newTaskOperation	(	std::string const &	type,
		TagPtr	tag = new Tag
	)		const

return new TaskOperation by key lookup in task_operation_creator_map_ (new TaskOperation parses Tag if provided)

Example Tag syntax for parser as of Summer 2009

<ReadResfile name="rrf" filename="myresfile/">

or

<OperateOnCertainResidues name="PROTEINnopack"> <PreventRepackingRLT> <ResidueHasProperty property="PROTEIN/"> </OperateOnCertainResidues>

Definition at line 109 of file TaskOperationFactory.cc.

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

Referenced by newTaskOperations(), protocols::flxbb::LayerDesignOperation::parse_tag(), and protocols::match::TaskOperationMPM::TaskOperationMPM().

void core::pack::task::operation::TaskOperationFactory::newTaskOperations	(	TaskOperationOPs &	tops,
		TagPtr	tag
	)		const

fills vector with new TaskOperations from nested "TASKOPERATIONS" TagPtr

recurse tag file to find TASKOPERATIONS definitions

Definition at line 132 of file TaskOperationFactory.cc.

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

Referenced by newTaskOperations(), and protocols::optimize_weights::IterativeOptEDriver::read_tagfile_to_taskfactory().

void core::pack::task::operation::TaskOperationFactory::newTaskOperations	(	TaskOperationOPs &	tops,
		std::string const &	tagfilename
	)		const

fills vector with new TaskOperations from xml-like tag file

Definition at line 155 of file TaskOperationFactory.cc.

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

Member Data Documentation

TaskOperationFactory * core::pack::task::operation::TaskOperationFactory::instance_

staticprivate

Definition at line 77 of file TaskOperationFactory.hh.

Referenced by get_instance().

TaskOperationCreatorMap core::pack::task::operation::TaskOperationFactory::task_operation_creator_map_

private

Definition at line 78 of file TaskOperationFactory.hh.

Referenced by add_creator(), factory_register(), has_type(), and newTaskOperation().

---

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

• src/core/pack/task/operation/TaskOperationFactory.hh
• src/core/pack/task/operation/TaskOperationFactory.cc