Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
protocols::jd2::JobOutputterFactory Class Reference

#include <JobOutputterFactory.hh>

Inheritance diagram for protocols::jd2::JobOutputterFactory:
Inheritance graph
[legend]

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...
 

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_
 

Friends

class utility::SingletonBase< JobOutputterFactory >
 

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::jd2::JobOutputterFactory::~JobOutputterFactory ( )
virtualdefault
protocols::jd2::JobOutputterFactory::JobOutputterFactory ( )
privatedefault
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

References job_outputter_creator_map_.

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_, 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.

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

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

Friends And Related Function Documentation

friend class utility::SingletonBase< JobOutputterFactory >
friend

Member Data Documentation

JobOutputterMap protocols::jd2::JobOutputterFactory::job_outputter_creator_map_
private

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