protocols::jd2::JobOutputterFactory Class Reference

#include <JobOutputterFactory.hh>

Collaboration diagram for protocols::jd2::JobOutputterFactory:

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 ()

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

Private Attributes
JobOutputterMap	job_outputter_creator_map_

Static Private Attributes
static JobOutputterFactory *	instance_

Detailed Description

Definition at line 51 of file JobOutputterFactory.hh.

Member Typedef Documentation

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

Definition at line 54 of file JobOutputterFactory.hh.

Constructor & Destructor Documentation

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

virtual

Definition at line 39 of file JobOutputterFactory.cc.

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

private

Definition at line 36 of file JobOutputterFactory.cc.

Referenced by get_instance().

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

private

Member Function Documentation

void protocols::jd2::JobOutputterFactory::factory_register

(

JobOutputterCreatorOP

creator)

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

Definition at line 52 of file JobOutputterFactory.cc.

References job_outputter_creator_map_.

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

static

Definition at line 42 of file JobOutputterFactory.cc.

References instance_, and JobOutputterFactory().

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

Definition at line 64 of file JobOutputterFactory.cc.

References job_outputter_creator_map_, and protocols::jd2::TR().

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.

Definition at line 89 of file JobOutputterFactory.cc.

References get_JobOutputter_from_string().

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)

Definition at line 113 of file JobOutputterFactory.cc.

References get_JobOutputter_from_string().

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

private

Member Data Documentation

JobOutputterFactory * protocols::jd2::JobOutputterFactory::instance_

staticprivate

Definition at line 80 of file JobOutputterFactory.hh.

Referenced by get_instance().

JobOutputterMap protocols::jd2::JobOutputterFactory::job_outputter_creator_map_

private

Definition at line 82 of file JobOutputterFactory.hh.

Referenced by factory_register(), and get_JobOutputter_from_string().

---

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

• src/protocols/jd2/JobOutputterFactory.hh
• src/protocols/jd2/JobOutputterFactory.cc