Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Typedefs | Enumerations | Functions
core::select::movemap Namespace Reference

Classes

class  MoveMapFactory
 

Typedefs

typedef
utility::pointer::shared_ptr
< MoveMapFactory
MoveMapFactoryOP
 
typedef
utility::pointer::shared_ptr
< MoveMapFactory const > 
MoveMapFactoryCOP
 

Enumerations

enum  move_map_action { mm_disable = 0, mm_enable = 1 }
 Are we turning on or turning off these torsions? More...
 

Functions

std::string movemap_factory_category ()
 Category in the DataMap in which the utility functions below will go hunting for a particular MoveMapFactory. More...
 
std::string default_movemap_factory_attribute_name ()
 
MoveMapFactoryOP parse_movemap_factory (utility::tag::TagCOP tag, basic::datacache::DataMap const &data)
 returns a movemap factory given a tag and datamap More...
 
MoveMapFactoryOP parse_movemap_factory (utility::tag::TagCOP tag, basic::datacache::DataMap const &data, std::string const &attribute_name)
 returns a movemap factory given a tag and datamap More...
 
void attributes_for_parse_movemap_factory_default_attr_name (utility::tag::AttributeList &attlist, std::string const &documentation_string)
 Companion function for parse_movemap_factory. This uses the default movemap factory attribute name. More...
 
void attributes_for_parse_movemap_factory (utility::tag::AttributeList &attlist, std::string const &attribute_name, std::string const &documentation_string)
 Companion function for parse_movemap where a non-default attribute name is used (e.g. you might want two move-map factories given by attributes "mmf1" and "mmf2") More...
 
void attributes_for_parse_movemap_factory_when_required_default_name (utility::tag::AttributeList &attlist, std::string const &documentation_string)
 Companion function for parse_movemap to be used when it is unacceptible for the parse_movemap function to return a null pointer. More...
 
void attributes_for_parse_movemap_factory_when_required (utility::tag::AttributeList &attlist, std::string const &attribute_name, std::string const &documentation_string)
 Companion function for parse_movemap to be used when it is unacceptible for the parse_movemap function to return a null pointer. More...
 
MoveMapFactoryOP get_movemap_factory (std::string const &factory_name, basic::datacache::DataMap const &data)
 returns a MoveMapFactory given the factory's name and the datamap holding it More...
 

Typedef Documentation

typedef utility::pointer::shared_ptr< MoveMapFactory const > core::select::movemap::MoveMapFactoryCOP
typedef utility::pointer::shared_ptr< MoveMapFactory > core::select::movemap::MoveMapFactoryOP

Enumeration Type Documentation

Are we turning on or turning off these torsions?

Enumerator
mm_disable 
mm_enable 

Function Documentation

void core::select::movemap::attributes_for_parse_movemap_factory ( utility::tag::AttributeList &  attlist,
std::string const &  attribute_name,
std::string const &  documentation_string 
)

Companion function for parse_movemap where a non-default attribute name is used (e.g. you might want two move-map factories given by attributes "mmf1" and "mmf2")

Companion function for parse_movemap where a non-default attribute name is used (e.g. you might want two move-map factories given by attributes "mmf1" and "mmf2") If no documentation string is provided, a default documentation string is used.

Referenced by attributes_for_parse_movemap_factory_default_attr_name(), and protocols::fold_from_loops::movers::DisplayPoseLabelsMover::provide_xml_schema().

void core::select::movemap::attributes_for_parse_movemap_factory_default_attr_name ( utility::tag::AttributeList &  attlist,
std::string const &  documentation_string 
)

Companion function for parse_movemap_factory. This uses the default movemap factory attribute name.

Companion function for parse_movemap_factory. This uses the default movemap factory attribute name If no documentation string is provided, a default documentation string is used.

References attributes_for_parse_movemap_factory(), and default_movemap_factory_attribute_name().

Referenced by protocols::relax::FastRelax::complex_type_generator_for_fast_relax(), protocols::minimization_packing::MinMover::complex_type_generator_for_min_mover(), and protocols::carbohydrates::RingPlaneFlipMover::provide_xml_schema().

void core::select::movemap::attributes_for_parse_movemap_factory_when_required ( utility::tag::AttributeList &  attlist,
std::string const &  attribute_name,
std::string const &  documentation_string 
)

Companion function for parse_movemap to be used when it is unacceptible for the parse_movemap function to return a null pointer.

Companion function for parse_movemap to be used when it is unacceptible for the parse_movemap function to return a null pointer If no documentation string is provided, a default documentation string is used.

Referenced by attributes_for_parse_movemap_factory_when_required_default_name(), and protocols::fold_from_loops::movers::MoveMapFactoryToNamedMoveMapMover::provide_xml_schema().

void core::select::movemap::attributes_for_parse_movemap_factory_when_required_default_name ( utility::tag::AttributeList &  attlist,
std::string const &  documentation_string 
)

Companion function for parse_movemap to be used when it is unacceptible for the parse_movemap function to return a null pointer.

Companion function for parse_movemap to be used when it is unacceptible for the parse_movemap function to return a null pointer If no documentation string is provided, a default documentation string is used.

References attributes_for_parse_movemap_factory_when_required(), and default_movemap_factory_attribute_name().

std::string core::select::movemap::default_movemap_factory_attribute_name ( )
MoveMapFactoryOP core::select::movemap::get_movemap_factory ( std::string const &  factory_name,
basic::datacache::DataMap const &  data 
)

returns a MoveMapFactory given the factory's name and the datamap holding it

Looks for the factory in the datamap Returns a ptr to it

Exceptions
utility::excn::EXCN_Msg_Exceptionif selector is not found in datamap

References movemap_factory_category(), and TR().

Referenced by parse_movemap_factory(), and protocols::rosetta_scripts::parse_movemap_factory_legacy().

std::string core::select::movemap::movemap_factory_category ( )

Category in the DataMap in which the utility functions below will go hunting for a particular MoveMapFactory.

Referenced by get_movemap_factory(), protocols::parser::MoveMapFactoryLoader::mmf_cat_in_datamap(), and protocols::rosetta_scripts::parse_movemap_factory_legacy().

MoveMapFactoryOP core::select::movemap::parse_movemap_factory ( utility::tag::TagCOP  tag,
basic::datacache::DataMap const &  data 
)
MoveMapFactoryOP core::select::movemap::parse_movemap_factory ( utility::tag::TagCOP  tag,
basic::datacache::DataMap const &  data,
std::string const &  attribute_name 
)

returns a movemap factory given a tag and datamap

Looks for the attribute with name attrname in tag. If that option isn't found, it returns a NULL ptr If that option is found, it calls get_movemap_factory()

References get_movemap_factory().