#include <FilterFactory.hh>
Public Types | |
| typedef std::map< std::string, FilterCreatorOP > | FilterMap |
| typedef utility::tag::Tag | Tag |
| typedef utility::tag::TagCOP | TagCOP |
Public Member Functions | |
| virtual | ~FilterFactory () |
| void | factory_register (FilterCreatorOP creator) |
| add a Filter prototype, using its default type name as the map key More... | |
| bool | filter_exists (std::string const &filter_name) const |
| Is there a filter with the given name that's known to Rosetta? More... | |
| void | provide_xml_schema (std::string const &filter_name, utility::tag::XMLSchemaDefinition &xsd) const |
| Get the XML schema for a given filter. More... | |
| FilterOP | newFilter (std::string const &) const |
| Create a filter given its identifying string. More... | |
| FilterOP | newFilter (TagCOP, basic::datacache::DataMap &, std::string user_defined_name="") const |
| return new Filter by Tag parsing; the identifying string for the Filter is in the Tag More... | |
| FilterMap const & | filter_creator_map () const |
| Read access to the set of all FilterCreators; for unit testing purposes. More... | |
| void | define_filter_xml_schema (utility::tag::XMLSchemaDefinition &xsd) const |
| std::string | get_citation_humanreadable (std::string const &filter_name) const |
| Get a human-readable listing of the citations for a given filter, by filter name. More... | |
Static Public Member Functions | |
| static std::string | filter_xml_schema_group_name () |
Private Member Functions | |
| FilterFactory () | |
| FilterFactory (FilterFactory const &)=delete | |
| FilterFactory const & | operator= (FilterFactory const &)=delete |
Private Attributes | |
| FilterMap | filter_creator_map_ |
Friends | |
| class | utility::SingletonBase< FilterFactory > |
Member Typedef Documentation
◆ FilterMap
| typedef std::map< std::string, FilterCreatorOP > protocols::filters::FilterFactory::FilterMap |
◆ Tag
| typedef utility::tag::Tag protocols::filters::FilterFactory::Tag |
◆ TagCOP
| typedef utility::tag::TagCOP protocols::filters::FilterFactory::TagCOP |
Constructor & Destructor Documentation
◆ ~FilterFactory()
|
virtualdefault |
◆ FilterFactory() [1/2]
|
privatedefault |
◆ FilterFactory() [2/2]
|
privatedelete |
Member Function Documentation
◆ define_filter_xml_schema()
| void protocols::filters::FilterFactory::define_filter_xml_schema | ( | utility::tag::XMLSchemaDefinition & | xsd | ) | const |
◆ factory_register()
| 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_.
◆ filter_creator_map()
| FilterFactory::FilterMap const & protocols::filters::FilterFactory::filter_creator_map | ( | ) | const |
Read access to the set of all FilterCreators; for unit testing purposes.
References filter_creator_map_.
◆ filter_exists()
| bool protocols::filters::FilterFactory::filter_exists | ( | std::string const & | filter_name | ) | const |
Is there a filter with the given name that's known to Rosetta?
References filter_creator_map_.
Referenced by protocols::rosetta_scripts::print_information().
◆ filter_xml_schema_group_name()
|
static |
Referenced by define_filter_xml_schema(), protocols::pose_selectors::Filter::provide_xml_schema(), protocols::pose_reporters::FilterReporter::provide_xml_schema(), protocols::rosetta_scripts::ParsedProtocol::provide_xml_schema(), and protocols::rosetta_scripts::RosettaScriptsSchemaValidator::write_ROSETTASCRIPTS_complex_type().
◆ get_citation_humanreadable()
| std::string protocols::filters::FilterFactory::get_citation_humanreadable | ( | std::string const & | filter_name | ) | const |
Get a human-readable listing of the citations for a given filter, by filter name.
Returns an empty string if there are no citations.
References newFilter().
Referenced by protocols::rosetta_scripts::print_information().
◆ newFilter() [1/2]
| FilterOP protocols::filters::FilterFactory::newFilter | ( | std::string const & | filter_type | ) | const |
Create a filter given its identifying string.
return new Filter by key lookup in filter_prototype_map_ (new Filter parses Tag if provided)
References filter_creator_map_, and protocols::filters::TR().
Referenced by protocols::multistage_rosetta_scripts::MRSJobQueen::determine_validity_of_stage_tags(), protocols::multistage_rosetta_scripts::TagManager::generate_data_for_input_pose_id(), get_citation_humanreadable(), newFilter(), and protocols::multistage_rosetta_scripts::MRSJob::parse_my_tag().
◆ newFilter() [2/2]
| FilterOP protocols::filters::FilterFactory::newFilter | ( | TagCOP | tag, |
| basic::datacache::DataMap & | data, | ||
| std::string | user_defined_name = "" |
||
| ) | const |
return new Filter by Tag parsing; the identifying string for the Filter is in the Tag
return new Filter by Tag parsing
References newFilter().
◆ operator=()
|
privatedelete |
◆ provide_xml_schema()
| void protocols::filters::FilterFactory::provide_xml_schema | ( | std::string const & | filter_name, |
| utility::tag::XMLSchemaDefinition & | xsd | ||
| ) | const |
Get the XML schema for a given filter.
Throws an error if the filter is unknown to Rosetta.
References filter_creator_map_, and protocols::filters::TR().
Referenced by protocols::rosetta_scripts::print_information().
Friends And Related Function Documentation
◆ utility::SingletonBase< FilterFactory >
|
friend |
Member Data Documentation
◆ filter_creator_map_
|
private |
Referenced by define_filter_xml_schema(), factory_register(), filter_creator_map(), filter_exists(), newFilter(), and provide_xml_schema().
The documentation for this class was generated from the following files:
- src/protocols/filters/FilterFactory.hh
- src/protocols/filters/FilterFactory.cc
