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::moves::MoverFactory Class Reference

#include <MoverFactory.hh>

Inheritance diagram for protocols::moves::MoverFactory:
Inheritance graph
[legend]

Public Types

typedef std::map< std::string,
MoverCreatorOP
MoverMap
 
typedef utility::tag::Tag Tag
 
typedef utility::tag::TagCOP TagCOP
 

Public Member Functions

virtual ~MoverFactory ()
 
void factory_register (MoverCreatorOP creator)
 add a Mover prototype, using its default type name as the map key More...
 
bool mover_exists (std::string const &mover_name) const
 Is there a mover with the given name that's known to Rosetta? More...
 
void provide_xml_schema (std::string const &mover_name, utility::tag::XMLSchemaDefinition &xsd) const
 Get the XML schema for a given mover. More...
 
MoverOP newMover (std::string const &) const
 Create a mover given its identifying string. More...
 
MoverOP newMover (TagCOP, basic::datacache::DataMap &) const
 return new Mover by Tag parsing; the identifying string for the Mover is in the Tag More...
 
MoverMap const & mover_creator_map () const
 Read access to the set of all MoverCreators; for unit testing purposes. More...
 
void define_mover_xml_schema (utility::tag::XMLSchemaDefinition &xsd) const
 

Static Public Member Functions

static std::string mover_xml_schema_group_name ()
 

Private Member Functions

 MoverFactory ()
 
 MoverFactory (MoverFactory const &)=delete
 
MoverFactory const & operator= (MoverFactory const &)=delete
 

Private Attributes

MoverMap mover_creator_map_
 
std::set< std::string > forbidden_names_
 

Friends

class utility::SingletonBase< MoverFactory >
 

Member Typedef Documentation

typedef std::map< std::string, MoverCreatorOP > protocols::moves::MoverFactory::MoverMap
typedef utility::tag::Tag protocols::moves::MoverFactory::Tag
typedef utility::tag::TagCOP protocols::moves::MoverFactory::TagCOP

Constructor & Destructor Documentation

protocols::moves::MoverFactory::~MoverFactory ( )
virtualdefault
protocols::moves::MoverFactory::MoverFactory ( )
private

References forbidden_names_.

protocols::moves::MoverFactory::MoverFactory ( MoverFactory const &  )
privatedelete

Member Function Documentation

void protocols::moves::MoverFactory::define_mover_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd) const
void protocols::moves::MoverFactory::factory_register ( MoverCreatorOP  creator)

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

References forbidden_names_, and mover_creator_map_.

MoverFactory::MoverMap const & protocols::moves::MoverFactory::mover_creator_map ( ) const

Read access to the set of all MoverCreators; for unit testing purposes.

References mover_creator_map_.

Referenced by protocols::canonical_sampling::MetropolisHastingsMover::parse_my_tag().

bool protocols::moves::MoverFactory::mover_exists ( std::string const &  mover_name) const

Is there a mover with the given name that's known to Rosetta?

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

References mover_creator_map_.

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

std::string protocols::moves::MoverFactory::mover_xml_schema_group_name ( )
static
MoverOP protocols::moves::MoverFactory::newMover ( std::string const &  mover_type) const
MoverOP protocols::moves::MoverFactory::newMover ( TagCOP  tag,
basic::datacache::DataMap &  data 
) const

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

return new Mover by Tag parsing

References newMover().

MoverFactory const& protocols::moves::MoverFactory::operator= ( MoverFactory const &  )
privatedelete
void protocols::moves::MoverFactory::provide_xml_schema ( std::string const &  mover_name,
utility::tag::XMLSchemaDefinition &  xsd 
) const

Get the XML schema for a given mover.

Throws an error if the mover is unknown to Rosetta.

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

References mover_creator_map_, and protocols::moves::TR().

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

Friends And Related Function Documentation

friend class utility::SingletonBase< MoverFactory >
friend

Member Data Documentation

std::set< std::string > protocols::moves::MoverFactory::forbidden_names_
private

Referenced by factory_register(), and MoverFactory().

MoverMap protocols::moves::MoverFactory::mover_creator_map_
private

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