protocols::jd3::pose_inputters::PoseInputterFactory Class Reference

#include <PoseInputterFactory.hh>

Inheritance diagram for protocols::jd3::pose_inputters::PoseInputterFactory:

Public Types
typedef std::map< std::string, PoseInputterCreatorOP >	PoseInputterMap
typedef std::list< PoseInputterCreatorCOP >	CreatorList
typedef utility::vector1< std::pair< PoseInputSourceOP, PoseInputterOP > >	PoseInputSourcesAndInputters
typedef utility::tag::Tag	Tag
typedef utility::tag::TagCOP	TagCOP

Public Member Functions
void	factory_register (PoseInputterCreatorOP creator)
	add a PoseInputter prototype, using its default type name as the map key More...
PoseInputterOP	new_pose_inputter (std::string const &) const
	Create a pose inputter given its identifying string, e.g. the name of an XML element. More...
PoseInputSourcesAndInputters	pose_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 PoseInputters. The order in which the PoseInputSources are reported are sorted by alphabetically by the keys of the PoseInputters (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 PoseInputterCreators 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_pose_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 &	pose_inputter_creators () const

Static Public Member Functions
static std::string	pose_inputter_xml_schema_group_name ()
static std::string	complex_type_name_for_pose_inputter (std::string const &inputter_key)

Private Member Functions
	PoseInputterFactory ()
	PoseInputterFactory (PoseInputterFactory const &)=delete
PoseInputterFactory const &	operator= (PoseInputterFactory const &)=delete

Private Attributes
PoseInputterMap	pose_inputter_creator_map_
CreatorList	creator_list_
bool	throw_on_double_registration_

Friends
class	utility::SingletonBase< PoseInputterFactory >

Member Typedef Documentation

CreatorList

typedef std::list< PoseInputterCreatorCOP > protocols::jd3::pose_inputters::PoseInputterFactory::CreatorList

PoseInputSourcesAndInputters

typedef utility::vector1< std::pair< PoseInputSourceOP, PoseInputterOP > > protocols::jd3::pose_inputters::PoseInputterFactory::PoseInputSourcesAndInputters

PoseInputterMap

typedef std::map< std::string, PoseInputterCreatorOP > protocols::jd3::pose_inputters::PoseInputterFactory::PoseInputterMap

Tag

typedef utility::tag::Tag protocols::jd3::pose_inputters::PoseInputterFactory::Tag

TagCOP

typedef utility::tag::TagCOP protocols::jd3::pose_inputters::PoseInputterFactory::TagCOP

Constructor & Destructor Documentation

PoseInputterFactory() [1/2]

protocols::jd3::pose_inputters::PoseInputterFactory::PoseInputterFactory ( )

private

PoseInputterFactory() [2/2]

protocols::jd3::pose_inputters::PoseInputterFactory::PoseInputterFactory ( PoseInputterFactory const &  )

privatedelete

Member Function Documentation

complex_type_name_for_pose_inputter()

std::string protocols::jd3::pose_inputters::PoseInputterFactory::complex_type_name_for_pose_inputter ( std::string const &  inputter_key )

static

Referenced by define_pose_inputter_xml_schema(), protocols::jd3::standard::StandardJobQueen::job_definition_xsd(), and protocols::jd3::pose_inputters::pose_inputter_xsd_type_definition_w_attributes().

define_pose_inputter_xml_schema()

void protocols::jd3::pose_inputters::PoseInputterFactory::define_pose_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 complex_type_name_for_pose_inputter(), pose_inputter_creator_map_, and pose_inputter_xml_schema_group_name().

factory_register()

void protocols::jd3::pose_inputters::PoseInputterFactory::factory_register

(

PoseInputterCreatorOP

creator

)

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

References creator_list_, pose_inputter_creator_map_, and throw_on_double_registration_.

list_options_read()

void protocols::jd3::pose_inputters::PoseInputterFactory::list_options_read

(

utility::options::OptionKeyList &

read_options

)

const

References creator_list_.

new_pose_inputter()

PoseInputterOP protocols::jd3::pose_inputters::PoseInputterFactory::new_pose_inputter

(

std::string const &

pose_inputter_type

)

const

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

return new PoseInputter by key lookup in pose_inputter_prototype_map_ (new PoseInputter parses Tag if provided)

References pose_inputter_creator_map_, and protocols::jd3::pose_inputters::TR().

operator=()

PoseInputterFactory const& protocols::jd3::pose_inputters::PoseInputterFactory::operator= ( PoseInputterFactory const &  )

privatedelete

pose_inputs_from_command_line()

PoseInputSourcesAndInputters protocols::jd3::pose_inputters::PoseInputterFactory::pose_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 PoseInputters. The order in which the PoseInputSources are reported are sorted by alphabetically by the keys of the PoseInputters (e.g. "PDB" will precede "Silent").

References pose_inputter_creator_map_.

pose_inputter_creators()

PoseInputterFactory::CreatorList const & protocols::jd3::pose_inputters::PoseInputterFactory::pose_inputter_creators

(

)

const

References creator_list_.

pose_inputter_xml_schema_group_name()

std::string protocols::jd3::pose_inputters::PoseInputterFactory::pose_inputter_xml_schema_group_name ( )

static

Referenced by define_pose_inputter_xml_schema(), and protocols::jd3::standard::StandardJobQueen::job_definition_xsd().

set_throw_on_double_registration()

void protocols::jd3::pose_inputters::PoseInputterFactory::set_throw_on_double_registration

(

)

Should the Factory throw an exception or call utility::exit when it encounters the second of two PoseInputterCreators 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

utility::SingletonBase< PoseInputterFactory >

friend class utility::SingletonBase< PoseInputterFactory >

friend

Member Data Documentation

creator_list_

CreatorList protocols::jd3::pose_inputters::PoseInputterFactory::creator_list_

private

Referenced by factory_register(), list_options_read(), and pose_inputter_creators().

pose_inputter_creator_map_

PoseInputterMap protocols::jd3::pose_inputters::PoseInputterFactory::pose_inputter_creator_map_

private

Referenced by define_pose_inputter_xml_schema(), factory_register(), new_pose_inputter(), and pose_inputs_from_command_line().

throw_on_double_registration_

bool protocols::jd3::pose_inputters::PoseInputterFactory::throw_on_double_registration_

private

Referenced by factory_register(), and set_throw_on_double_registration().

---

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

• src/protocols/jd3/pose_inputters/PoseInputterFactory.hh
• src/protocols/jd3/pose_inputters/PoseInputterFactory.cc