Rosetta  2021.16
 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::jd3::chunk_library_inputters::ChunkLibraryInputterFactory Class Reference

#include <ChunkLibraryInputterFactory.hh>

Inheritance diagram for protocols::jd3::chunk_library_inputters::ChunkLibraryInputterFactory:
Inheritance graph
[legend]

Public Types

typedef std::map< std::string,
ChunkLibraryInputterCreatorOP
ChunkLibraryInputterMap
 
typedef std::list
< ChunkLibraryInputterCreatorCOP
CreatorList
 
typedef utility::vector1
< std::pair
< ChunkLibraryInputSourceOP,
ChunkLibraryInputterOP > > 
ChunkLibraryInputSourcesAndInputters
 
typedef utility::tag::Tag Tag
 
typedef utility::tag::TagCOP TagCOP
 

Public Member Functions

void factory_register (ChunkLibraryInputterCreatorOP creator)
 add a ChunkLibraryInputter prototype, using its default type name as the map key More...
 
ChunkLibraryInputterOP new_chunk_library_inputter (std::string const &) const
 Create a pose inputter given its identifying string, e.g. the name of an XML element. More...
 
ChunkLibraryInputSourcesAndInputters chunk_library_inputs_from_command_line () const
 Read the command line (i.e. in the absence of a job-definition file) to determine the set of input poses. Note that this reads from the global options system and does not read per-job options – this is necessary because there isn't a job-definition file from which to read per-job options. Note also that this will read all options on the command line, possibly from different ChunkLibraryInputters. The order in which the ChunkLibraryInputSources are reported are sorted by alphabetically by the keys of the ChunkLibraryInputters (e.g. "PDB" will precede "Silent"). More...
 
void set_throw_on_double_registration ()
 Should the Factory throw an exception or call utility::exit when it encounters the second of two ChunkLibraryInputterCreators with the same keyname? It's default behavior is to call utility::exit, but this method allows you to set it so that it will throw an exception instead (which is unit testable). More...
 
void define_chunk_library_inputter_xml_schema (utility::tag::XMLSchemaDefinition &xsd) const
 The ResidueSelectorFactory is the point of entry for the definition of the XML Schemas for every ResidueSelector that may be instantiated from a file. It is responsible for defining an xs:group named "residue_selector" listing each of the residue-selector-complex types that may be initialized using the ResidueSelectorFactory and to iterate across each of the ResidueSelectorCreators it contains asking them for the XML schema of the ResidueSelector they are responsible for creating. More...
 
void list_options_read (utility::options::OptionKeyList &read_options) const
 
CreatorList const & chunk_library_inputter_creators () const
 

Static Public Member Functions

static std::string chunk_library_inputter_xml_schema_group_name ()
 
static std::string complex_type_name_for_chunk_library_inputter (std::string const &inputter_key)
 

Private Member Functions

 ChunkLibraryInputterFactory ()
 
 ChunkLibraryInputterFactory (ChunkLibraryInputterFactory const &)=delete
 
ChunkLibraryInputterFactory const & operator= (ChunkLibraryInputterFactory const &)=delete
 

Private Attributes

ChunkLibraryInputterMap chunk_library_inputter_creator_map_
 
CreatorList creator_list_
 
bool throw_on_double_registration_
 

Friends

class utility::SingletonBase< ChunkLibraryInputterFactory >
 

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::jd3::chunk_library_inputters::ChunkLibraryInputterFactory::ChunkLibraryInputterFactory ( )
private
protocols::jd3::chunk_library_inputters::ChunkLibraryInputterFactory::ChunkLibraryInputterFactory ( ChunkLibraryInputterFactory const &  )
privatedelete

Member Function Documentation

ChunkLibraryInputterFactory::ChunkLibraryInputSourcesAndInputters protocols::jd3::chunk_library_inputters::ChunkLibraryInputterFactory::chunk_library_inputs_from_command_line ( ) const

Read the command line (i.e. in the absence of a job-definition file) to determine the set of input poses. Note that this reads from the global options system and does not read per-job options – this is necessary because there isn't a job-definition file from which to read per-job options. Note also that this will read all options on the command line, possibly from different ChunkLibraryInputters. The order in which the ChunkLibraryInputSources are reported are sorted by alphabetically by the keys of the ChunkLibraryInputters (e.g. "PDB" will precede "Silent").

References chunk_library_inputter_creator_map_.

ChunkLibraryInputterFactory::CreatorList const & protocols::jd3::chunk_library_inputters::ChunkLibraryInputterFactory::chunk_library_inputter_creators ( ) const

References creator_list_.

std::string protocols::jd3::chunk_library_inputters::ChunkLibraryInputterFactory::chunk_library_inputter_xml_schema_group_name ( )
static
std::string protocols::jd3::chunk_library_inputters::ChunkLibraryInputterFactory::complex_type_name_for_chunk_library_inputter ( std::string const &  inputter_key)
static
void protocols::jd3::chunk_library_inputters::ChunkLibraryInputterFactory::define_chunk_library_inputter_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd) const

The ResidueSelectorFactory is the point of entry for the definition of the XML Schemas for every ResidueSelector that may be instantiated from a file. It is responsible for defining an xs:group named "residue_selector" listing each of the residue-selector-complex types that may be initialized using the ResidueSelectorFactory and to iterate across each of the ResidueSelectorCreators it contains asking them for the XML schema of the ResidueSelector they are responsible for creating.

References chunk_library_inputter_creator_map_, chunk_library_inputter_xml_schema_group_name(), and complex_type_name_for_chunk_library_inputter().

void protocols::jd3::chunk_library_inputters::ChunkLibraryInputterFactory::factory_register ( ChunkLibraryInputterCreatorOP  creator)

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

References chunk_library_inputter_creator_map_, creator_list_, and throw_on_double_registration_.

void protocols::jd3::chunk_library_inputters::ChunkLibraryInputterFactory::list_options_read ( utility::options::OptionKeyList &  read_options) const

References creator_list_.

ChunkLibraryInputterOP protocols::jd3::chunk_library_inputters::ChunkLibraryInputterFactory::new_chunk_library_inputter ( std::string const &  chunk_library_inputter_type) const

Create a pose inputter given its identifying string, e.g. the name of an XML element.

return new ChunkLibraryInputter by key lookup in chunk_library_inputter_prototype_map_ (new ChunkLibraryInputter parses Tag if provided)

References chunk_library_inputter_creator_map_, and protocols::jd3::chunk_library_inputters::TR().

ChunkLibraryInputterFactory const& protocols::jd3::chunk_library_inputters::ChunkLibraryInputterFactory::operator= ( ChunkLibraryInputterFactory const &  )
privatedelete
void protocols::jd3::chunk_library_inputters::ChunkLibraryInputterFactory::set_throw_on_double_registration ( )

Should the Factory throw an exception or call utility::exit when it encounters the second of two ChunkLibraryInputterCreators with the same keyname? It's default behavior is to call utility::exit, but this method allows you to set it so that it will throw an exception instead (which is unit testable).

References throw_on_double_registration_.

Friends And Related Function Documentation

friend class utility::SingletonBase< ChunkLibraryInputterFactory >
friend

Member Data Documentation

ChunkLibraryInputterMap protocols::jd3::chunk_library_inputters::ChunkLibraryInputterFactory::chunk_library_inputter_creator_map_
private
CreatorList protocols::jd3::chunk_library_inputters::ChunkLibraryInputterFactory::creator_list_
private
bool protocols::jd3::chunk_library_inputters::ChunkLibraryInputterFactory::throw_on_double_registration_
private

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