#include <FeaturesReporter.hh>

Inheritance diagram for protocols::features::FeaturesReporter:

Collaboration diagram for protocols::features::FeaturesReporter:

Public Member Functions
virtual	~FeaturesReporter ()
	Automatically generated virtual destructor for class deriving directly from ReferenceCount. More...

virtual std::string	type_name () const

virtual std::string	schema () const
	return sql statements that sets up the appropriate tables to contain the features. This should be removed once everything has been moved to the schema generator More...

virtual utility::vector1 < std::string >	features_reporter_dependencies () const
	return the set of features reporters that are required to also already be extracted by the time this one is used. More...

virtual void	write_schema_to_db (utility::sql_database::sessionOP db_session) const =0
	Define the schema and write it to the database. This is most easily achieved using the schema_generator. Once everything has converted to the schema generator this should be made a pure virtual. More...

core::Size	report_features (core::pose::Pose const &, boost::uuids::uuid, utility::sql_database::sessionOP)
	collect all the feature data for the pose. More...

virtual core::Size	report_features (core::pose::Pose const &, utility::vector1< bool > const &, boost::uuids::uuid, utility::sql_database::sessionOP)=0
	collect all the feature data for the pose. More...

virtual void	parse_my_tag (utility::tag::TagPtr const tag, protocols::moves::DataMap &, protocols::filters::Filters_map const &, protocols::moves::Movers_map const &, core::pose::Pose const &)

virtual void	load_into_pose (utility::sql_database::sessionOP, boost::uuids::uuid, core::pose::Pose &)

virtual void	delete_record (boost::uuids::uuid, utility::sql_database::sessionOP)

Protected Member Functions
std::string	find_tag (core::pose::Pose const &pose) const

void	delete_records_from_table (std::string const &table_name, boost::uuids::uuid struct_id, utility::sql_database::sessionOP db_session)
	a helper function for deleting data associated with a given structure from feature database WARNING table_name must be sanitized! More...

Detailed Description

Definition at line 49 of file FeaturesReporter.hh.

Constructor & Destructor Documentation

protocols::features::FeaturesReporter::~FeaturesReporter ( )

virtual

Automatically generated virtual destructor for class deriving directly from ReferenceCount.

Auto-generated virtual destructor

Definition at line 57 of file FeaturesReporter.cc.

Member Function Documentation

virtual void protocols::features::FeaturesReporter::delete_record	(	boost::uuids::uuid	,
		utility::sql_database::sessionOP
	)

inlinevirtual

Definition at line 121 of file FeaturesReporter.hh.

void protocols::features::FeaturesReporter::delete_records_from_table	(	std::string const &	table_name,
		boost::uuids::uuid	struct_id,
		utility::sql_database::sessionOP	db_session
	)

protected

a helper function for deleting data associated with a given structure from feature database WARNING table_name must be sanitized!

Definition at line 166 of file FeaturesReporter.cc.

Referenced by protocols::features::ResidueFeatures::delete_record(), and protocols::features::UnrecognizedAtomFeatures::delete_record().

virtual utility::vector1<std::string> protocols::features::FeaturesReporter::features_reporter_dependencies ( ) const

inlinevirtual

return the set of features reporters that are required to also already be extracted by the time this one is used.

Definition at line 71 of file FeaturesReporter.hh.

string protocols::features::FeaturesReporter::find_tag ( core::pose::Pose const & pose) const

protected

Definition at line 146 of file FeaturesReporter.cc.

References protocols::jd2::JobDistributor::current_output_name(), core::pose::Pose::data(), protocols::jd2::JobDistributor::get_instance(), core::pose::datacache::CacheableDataType::JOBDIST_OUTPUT_TAG, core::pose::Pose::pdb_info(), and protocols::kinmatch::str().

Referenced by protocols::features::ProteinRMSDFeatures::report_features().

virtual void protocols::features::FeaturesReporter::load_into_pose	(	utility::sql_database::sessionOP	,
		boost::uuids::uuid	,
		core::pose::Pose &
	)

inlinevirtual

Reimplemented in protocols::features::StructureFeatures, protocols::features::ProteinResidueConformationFeatures, protocols::features::ResidueConformationFeatures, protocols::features::PoseCommentsFeatures, protocols::features::PoseConformationFeatures, protocols::features::PdbDataFeatures, and protocols::features::JobDataFeatures.

Definition at line 114 of file FeaturesReporter.hh.

void protocols::features::FeaturesReporter::parse_my_tag	(	utility::tag::TagPtr const	tag,
		protocols::moves::DataMap &	,
		protocols::filters::Filters_map const &	,
		protocols::moves::Movers_map const &	,
		core::pose::Pose const &
	)

virtual

Definition at line 134 of file FeaturesReporter.cc.

core::Size protocols::features::FeaturesReporter::report_features	(	core::pose::Pose const &	,
		boost::uuids::uuid	,
		utility::sql_database::sessionOP
	)

collect all the feature data for the pose.

virtual core::Size protocols::features::FeaturesReporter::report_features	(	core::pose::Pose const &	,
		utility::vector1< bool > const &	,
		boost::uuids::uuid	,
		utility::sql_database::sessionOP
	)

pure virtual

collect all the feature data for the pose.

virtual std::string protocols::features::FeaturesReporter::schema ( ) const

inlinevirtual

return sql statements that sets up the appropriate tables to contain the features. This should be removed once everything has been moved to the schema generator

Definition at line 65 of file FeaturesReporter.hh.

Referenced by write_schema_to_db().

virtual std::string protocols::features::FeaturesReporter::type_name ( ) const

inlinevirtual

Definition at line 56 of file FeaturesReporter.hh.

Referenced by write_schema_to_db().

void protocols::features::FeaturesReporter::write_schema_to_db ( utility::sql_database::sessionOP db_session) const

pure virtual

Define the schema and write it to the database. This is most easily achieved using the schema_generator. Once everything has converted to the schema generator this should be made a pure virtual.

Definition at line 84 of file FeaturesReporter.cc.

References schema(), and type_name().

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

src/protocols/features/FeaturesReporter.hh
src/protocols/features/FeaturesReporter.cc

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation