#include <JobOutputterFactory.hh>

Public Types
typedef std::map< std::string, JobOutputterCreatorOP >	JobOutputterMap

Public Member Functions
virtual	~JobOutputterFactory ()

void	factory_register (JobOutputterCreatorOP creator)
	add a JobOutputter prototype, using its default type name as the map key More...

JobOutputterOP	get_new_JobOutputter ()
	return JobOutputter defined by output parameters (contained in option system and #defines for MPI, etc) More...

JobOutputterOP	get_new_JobOutputter (JobOutputterOP default_jobout)
	return JobOutputter defined by output parameters (contained in option system and #defines for MPI, etc). The difference is that if the option system, etc, says nothing about output (which as of this writing defaults to PDBJobOutputter), this function leaves the input Outputter unchanged. This allows overriding the default outputter choice in your executable (without abusing the mutability of the options system) More...

Static Public Member Functions
static JobOutputterFactory *	get_instance ()
	static function to get the instance of ( pointer to) this singleton class More...

Private Member Functions
JobOutputterOP	get_JobOutputter_from_string (std::string const &job_outputter_type)

	JobOutputterFactory ()

	JobOutputterFactory (JobOutputterFactory const &)

JobOutputterFactory const &	operator= (JobOutputterFactory const &)

Static Private Member Functions
static JobOutputterFactory *	create_singleton_instance ()
	private singleton creation function to be used with utility::thread::threadsafe_singleton More...

Private Attributes
JobOutputterMap	job_outputter_creator_map_

Static Private Attributes
static JobOutputterFactory *	instance_

Member Typedef Documentation

typedef std::map< std::string, JobOutputterCreatorOP > protocols::jd2::JobOutputterFactory::JobOutputterMap

Constructor & Destructor Documentation

protocols::jd2::JobOutputterFactory::~JobOutputterFactory ( )

virtual

protocols::jd2::JobOutputterFactory::JobOutputterFactory ( )

private

Referenced by create_singleton_instance().

protocols::jd2::JobOutputterFactory::JobOutputterFactory ( JobOutputterFactory const & )

private

Member Function Documentation

JobOutputterFactory * protocols::jd2::JobOutputterFactory::create_singleton_instance ( )

staticprivate

private singleton creation function to be used with utility::thread::threadsafe_singleton

References JobOutputterFactory().

Referenced by get_instance().

void protocols::jd2::JobOutputterFactory::factory_register ( JobOutputterCreatorOP creator )

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

References job_outputter_creator_map_, runtime_assert, and utility_exit_with_message.

JobOutputterFactory * protocols::jd2::JobOutputterFactory::get_instance ( )

static

static function to get the instance of ( pointer to) this singleton class

References create_singleton_instance(), instance_, and utility::thread::safely_create_singleton().

Referenced by protocols::jd2::JobDistributorFactory::create_job_outputter().

JobOutputterOP protocols::jd2::JobOutputterFactory::get_JobOutputter_from_string ( std::string const & job_outputter_type )

private

return get_JobOutputter_from_string( "JobOutputter by key lookup in map

References job_outputter_creator_map_, protocols::jd2::TR, and utility_exit_with_message.

Referenced by get_new_JobOutputter().

JobOutputterOP protocols::jd2::JobOutputterFactory::get_new_JobOutputter ( )

return JobOutputter defined by output parameters (contained in option system and #defines for MPI, etc)

return new JobOutputter from logic of option system plus compilation options. All the logic for determining job output type lives here.

References basic::options::OptionKeys::out::file::atom_tree_diff, basic::options::OptionKeys::jd2::enzdes_out, get_JobOutputter_from_string(), basic::options::OptionKeys::jd2::no_output, basic::options::OptionKeys::out::nooutput, basic::options::option, basic::options::OptionKeys::out::file::score_only, basic::options::OptionKeys::out::file::silent, basic::options::OptionKeys::out::use_database, and user.

Referenced by protocols::jd2::JobDistributorFactory::create_job_outputter().

JobOutputterOP protocols::jd2::JobOutputterFactory::get_new_JobOutputter ( JobOutputterOP default_jobout )

return JobOutputter defined by output parameters (contained in option system and #defines for MPI, etc). The difference is that if the option system, etc, says nothing about output (which as of this writing defaults to PDBJobOutputter), this function leaves the input Outputter unchanged. This allows overriding the default outputter choice in your executable (without abusing the mutability of the options system)

References basic::options::OptionKeys::out::file::atom_tree_diff, basic::options::OptionKeys::jd2::enzdes_out, get_JobOutputter_from_string(), basic::options::OptionKeys::jd2::no_output, basic::options::OptionKeys::out::nooutput, basic::options::option, basic::options::OptionKeys::out::pdb, basic::options::OptionKeys::out::file::score_only, basic::options::OptionKeys::out::file::silent, basic::options::OptionKeys::out::use_database, and user.