Rosetta 3.4
Public Member Functions
protocols::features::ReportToDB Class Reference

#include <ReportToDB.hh>

Inheritance diagram for protocols::features::ReportToDB:
Inheritance graph
[legend]
Collaboration diagram for protocols::features::ReportToDB:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ReportToDB ()
 ReportToDB (std::string const &name)
 ReportToDB (std::string const &name, std::string const &database_fname, std::string const &sample_source, core::scoring::ScoreFunctionOP scfxn, bool use_transactions=true, core::Size cache_size=2000)
 ReportToDB (ReportToDB const &src)
virtual ~ReportToDB ()
virtual void register_options () const
virtual moves::MoverOP fresh_instance () const
 this is like clone(), except it generates a new mover object freshly created with the default ctor. This function _should_ be pure virtual but that would disrupt the code base; MAKE SURE YOU DEFINE IT if you want to have your mover be a protocol handed to the job distributor (august 08 vintage).
virtual moves::MoverOP clone () const
 clone has to be overridden only if clone invocation is expected.
virtual std::string get_name () const
 Each derived class must specify its name. The class name.
void parse_db_tag_item (utility::tag::TagPtr const tag)
void parse_sample_source_tag_item (utility::tag::TagPtr const tag)
void parse_protocol_id_tag_item (utility::tag::TagPtr const tag)
void parse_db_mode_tag_item (utility::tag::TagPtr const tag)
void parse_separate_db_per_mpi_process_tag_item (utility::tag::TagPtr const tag)
void parse_use_transactions_tag_item (utility::tag::TagPtr const tag)
void parse_cache_size_tag_item (utility::tag::TagPtr const tag)
void parse_my_tag (utility::tag::TagPtr const tag, protocols::moves::DataMap &data, Filters_map const &, protocols::moves::Movers_map const &, core::pose::Pose const &pose)
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing.
void check_features_reporter_dependencies (FeaturesReporterOP test_feature_reporter) const
void initialize_reporters ()
void initialize_database (utility::sql_database::sessionOP db_session)
void write_features_reporters_table (utility::sql_database::sessionOP db_session) const
void apply (Pose &pose)

Constructor & Destructor Documentation

protocols::features::ReportToDB::ReportToDB ( )

References initialize_reporters().

Referenced by clone(), and fresh_instance().

protocols::features::ReportToDB::ReportToDB ( std::string const &  name)
protocols::features::ReportToDB::ReportToDB ( std::string const &  name,
std::string const &  database_fname,
std::string const &  sample_source,
core::scoring::ScoreFunctionOP  scfxn,
bool  use_transactions = true,
core::Size  cache_size = 2000 
)
protocols::features::ReportToDB::ReportToDB ( ReportToDB const &  src)
protocols::features::ReportToDB::~ReportToDB ( ) [virtual]

Member Function Documentation

void protocols::features::ReportToDB::apply ( Pose pose) [virtual]
void protocols::features::ReportToDB::check_features_reporter_dependencies ( FeaturesReporterOP  test_feature_reporter) const
MoverOP protocols::features::ReportToDB::clone ( ) const [virtual]

clone has to be overridden only if clone invocation is expected.

clone is meant to return an OP'ed deep copy of this object. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function.

Reimplemented from protocols::moves::Mover.

References ReportToDB().

MoverOP protocols::features::ReportToDB::fresh_instance ( ) const [virtual]

this is like clone(), except it generates a new mover object freshly created with the default ctor. This function _should_ be pure virtual but that would disrupt the code base; MAKE SURE YOU DEFINE IT if you want to have your mover be a protocol handed to the job distributor (august 08 vintage).

fresh_instance is meant to return a new object of this class, created with the default constructor. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function. This is used by the August 08 job distributor.

Reimplemented from protocols::moves::Mover.

References ReportToDB().

virtual std::string protocols::features::ReportToDB::get_name ( ) const [inline, virtual]

Each derived class must specify its name. The class name.

Implements protocols::moves::Mover.

void protocols::features::ReportToDB::initialize_database ( utility::sql_database::sessionOP  db_session)

References write_features_reporters_table().

Referenced by apply().

void protocols::features::ReportToDB::initialize_reporters ( )

Referenced by ReportToDB().

void protocols::features::ReportToDB::parse_cache_size_tag_item ( utility::tag::TagPtr const  tag)
void protocols::features::ReportToDB::parse_db_mode_tag_item ( utility::tag::TagPtr const  tag)
void protocols::features::ReportToDB::parse_db_tag_item ( utility::tag::TagPtr const  tag)
void protocols::features::ReportToDB::parse_my_tag ( utility::tag::TagPtr const  tag,
protocols::moves::DataMap data,
Filters_map const &  filters,
protocols::moves::Movers_map const &  movers,
core::pose::Pose const &  pose 
) [virtual]

Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing.

Some movers need not be parsed, so we shouldn't stop executions. This, however, calls attention to the lack of this method, which could be due to something as silly as a wrong parameters definition.

Reimplemented from protocols::moves::Mover.

void protocols::features::ReportToDB::parse_protocol_id_tag_item ( utility::tag::TagPtr const  tag)
void protocols::features::ReportToDB::parse_sample_source_tag_item ( utility::tag::TagPtr const  tag)
void protocols::features::ReportToDB::parse_separate_db_per_mpi_process_tag_item ( utility::tag::TagPtr const  tag)
void protocols::features::ReportToDB::parse_use_transactions_tag_item ( utility::tag::TagPtr const  tag)
void protocols::features::ReportToDB::register_options ( ) const [virtual]
void protocols::features::ReportToDB::write_features_reporters_table ( utility::sql_database::sessionOP  db_session) const

Referenced by initialize_database().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines