protocols::filters::FilterFactory Class Reference

#include <FilterFactory.hh>

Public Types
typedef std::map< std::string, FilterCreatorOP >	FilterMap
typedef utility::tag::Tag	Tag
typedef utility::tag::TagCOP	TagCOP
typedef core::pose::Pose	Pose

Public Member Functions
virtual	~FilterFactory ()
void	factory_register (FilterCreatorOP creator)
	add a Filter prototype, using its default type name as the map key More...
FilterOP	newFilter (std::string const &)
	Create a mover given its identifying string. More...
FilterOP	newFilter (TagCOP, basic::datacache::DataMap &, protocols::filters::Filters_map const &, protocols::moves::Movers_map const &, Pose const &)
	return new Mover by Tag parsing; the identifying string for the Mover is in the Tag More...

Static Public Member Functions
static FilterFactory *	get_instance ()
	static function to get the instance of ( pointer to) this singleton class More...

Private Member Functions
	FilterFactory ()
	FilterFactory (FilterFactory const &)
FilterFactory const &	operator= (FilterFactory const &)

Static Private Member Functions
static FilterFactory *	create_singleton_instance ()
	private singleton creation function to be used with utility::thread::threadsafe_singleton More...

Private Attributes
FilterMap	filter_creator_map_

Static Private Attributes
static FilterFactory *	instance_

Member Typedef Documentation

typedef std::map< std::string, FilterCreatorOP > protocols::filters::FilterFactory::FilterMap

typedef core::pose::Pose protocols::filters::FilterFactory::Pose

typedef utility::tag::Tag protocols::filters::FilterFactory::Tag

typedef utility::tag::TagCOP protocols::filters::FilterFactory::TagCOP

Constructor & Destructor Documentation

protocols::filters::FilterFactory::~FilterFactory ( )

virtual

protocols::filters::FilterFactory::FilterFactory ( )

private

Referenced by create_singleton_instance().

protocols::filters::FilterFactory::FilterFactory ( FilterFactory const &  )

private

Member Function Documentation

FilterFactory * protocols::filters::FilterFactory::create_singleton_instance ( )

staticprivate

private singleton creation function to be used with utility::thread::threadsafe_singleton

References FilterFactory().

Referenced by get_instance().

void protocols::filters::FilterFactory::factory_register

(

FilterCreatorOP

creator

)

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

References filter_creator_map_, runtime_assert, and utility_exit_with_message.

FilterFactory * protocols::filters::FilterFactory::get_instance ( )

static

static function to get the instance of ( pointer to) this singleton class

References create_singleton_instance(), instance_, and utility::thread::safely_create_singleton().

Referenced by protocols::rosetta_scripts::RosettaScriptsParser::instantiate_filter(), protocols::pose_reporters::FilterReporter::parse_my_tag(), and protocols::pose_selectors::Filter::parse_my_tag().

FilterOP protocols::filters::FilterFactory::newFilter

(

std::string const &

filter_type

)

Create a mover given its identifying string.

return new Filter by key lookup in filter_prototype_map_ (new Filter parses Tag if provided)

References filter_creator_map_, protocols::filters::TR, and utility_exit_with_message.

Referenced by newFilter(), protocols::pose_reporters::FilterReporter::parse_my_tag(), and protocols::pose_selectors::Filter::parse_my_tag().

FilterOP protocols::filters::FilterFactory::newFilter	(	TagCOP	tag,
		basic::datacache::DataMap &	data,
		protocols::filters::Filters_map const &	filters,
		protocols::moves::Movers_map const &	movers,
		Pose const &	pose
	)

return new Mover by Tag parsing; the identifying string for the Mover is in the Tag

return new Filter by Tag parsing

References protocols::filters::Filter::clone(), filter, newFilter(), protocols::filters::OR, protocols::filters::Filter::parse_my_tag(), runtime_assert, protocols::filters::Filter::set_user_defined_name(), and utility_exit_with_message.

FilterFactory const& protocols::filters::FilterFactory::operator= ( FilterFactory const &  )

private

Member Data Documentation

FilterMap protocols::filters::FilterFactory::filter_creator_map_

private

Referenced by factory_register(), and newFilter().

FilterFactory * protocols::filters::FilterFactory::instance_

staticprivate

Referenced by get_instance().

---

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

• src/protocols/filters/FilterFactory.hh
• src/protocols/filters/FilterFactory.cc