Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
protocols::filters::FilterFactory Class Reference

#include <FilterFactory.hh>

Inheritance diagram for protocols::filters::FilterFactory:
Inheritance graph
[legend]

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
 

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

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

Constructor & Destructor Documentation

protocols::filters::FilterFactory::~FilterFactory ( )
virtualdefault
protocols::filters::FilterFactory::FilterFactory ( )
privatedefault
protocols::filters::FilterFactory::FilterFactory ( FilterFactory const &  )
privatedelete

Member Function Documentation

void protocols::filters::FilterFactory::define_filter_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd) const
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_.

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_.

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?

Author
Vikram K. Mulligan (vmull.nosp@m.ig@u.nosp@m.w.edu)

References filter_creator_map_.

Referenced by protocols::rosetta_scripts::print_information().

std::string protocols::filters::FilterFactory::filter_xml_schema_group_name ( )
static
FilterOP protocols::filters::FilterFactory::newFilter ( std::string const &  filter_type) const
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().

FilterFactory const& protocols::filters::FilterFactory::operator= ( FilterFactory const &  )
privatedelete
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.

Author
Vikram K. Mulligan (vmull.nosp@m.ig@u.nosp@m.w.edu)

References filter_creator_map_, and protocols::filters::TR().

Referenced by protocols::rosetta_scripts::print_information().

Friends And Related Function Documentation

friend class utility::SingletonBase< FilterFactory >
friend

Member Data Documentation

FilterMap protocols::filters::FilterFactory::filter_creator_map_
private

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