Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | List of all members
protocols::features::StructureFeatures Class Reference

#include <StructureFeatures.hh>

Inheritance diagram for protocols::features::StructureFeatures:
Inheritance graph
[legend]

Public Member Functions

 StructureFeatures ()
 
void write_schema_to_db (utility::sql_database::sessionOP db_session) const override
 generate the table schemas and write them to the database More...
 
utility::vector1< std::string > features_reporter_dependencies () const override
 return the set of features reporters that are required to also already be extracted by the time this one is used. More...
 
core::Size report_features (core::pose::Pose const &, utility::vector1< bool > const &, StructureID, utility::sql_database::sessionOP) override
 collect all the feature data for the pose More...
 
StructureID report_features (core::Size batch_id, utility::sql_database::sessionOP db_session, std::string const &tag, std::string const &input_tag)
 collect all the feature data for the pose use This version allows the tag and the input tag to be specificed More...
 
void mark_structure_as_sampled (core::Size batch_id, std::string const &tag, std::string const &input_tag, utility::sql_database::sessionOP db_session)
 
void delete_record (StructureID struct_id, utility::sql_database::sessionOP db_session) override
 
void load_into_pose (utility::sql_database::sessionOP db_session, StructureID struct_id, core::pose::Pose &pose) override
 
void load_tag (utility::sql_database::sessionOP db_session, StructureID struct_id, core::pose::Pose &pose)
 
StructureID get_struct_id (utility::sql_database::sessionOP db_session, std::string const &tag, core::Size const &protocol_id)
 
std::string type_name () const override
 
- Public Member Functions inherited from protocols::features::FeaturesReporter
 FeaturesReporter ()
 
 ~FeaturesReporter () override
 Automatically generated virtual destructor for class deriving directly from VirtualBase. More...
 
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...
 
core::Size report_features (core::pose::Pose const &, StructureID, utility::sql_database::sessionOP)
 collect all the feature data for the pose. More...
 
virtual void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &)
 
void set_relevant_residues_mode (RelevantResiduesMode::T setting)
 
RelevantResiduesMode::T get_relevant_residues_mode () const
 
bool check_relevant_residues (utility::vector1< bool > const &relevant_residues, core::Size res1) const
 
bool check_relevant_residues (utility::vector1< bool > const &relevant_residues, core::Size res1, core::Size res2) const
 
bool check_relevant_residues_range (utility::vector1< bool > const &relevant_residues, core::Size res1, core::Size res2) const
 
bool check_relevant_residues (utility::vector1< bool > const &relevant_residues, utility::vector1< core::Size > const &residues) const
 

Static Public Member Functions

static std::string class_name ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 

Additional Inherited Members

- Protected Member Functions inherited from protocols::features::FeaturesReporter
std::string find_tag (core::pose::Pose const &pose) const
 
void delete_records_from_table (std::string const &table_name, StructureID 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...
 
- Protected Attributes inherited from protocols::features::FeaturesReporter
RelevantResiduesMode::T relevant_residues_mode_
 

Constructor & Destructor Documentation

protocols::features::StructureFeatures::StructureFeatures ( )
default

Member Function Documentation

std::string protocols::features::StructureFeatures::class_name ( )
static
void protocols::features::StructureFeatures::delete_record ( StructureID  struct_id,
utility::sql_database::sessionOP  db_session 
)
overridevirtual
utility::vector1< std::string > protocols::features::StructureFeatures::features_reporter_dependencies ( ) const
overridevirtual

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

Reimplemented from protocols::features::FeaturesReporter.

StructureID protocols::features::StructureFeatures::get_struct_id ( utility::sql_database::sessionOP  db_session,
std::string const &  tag,
core::Size const &  protocol_id 
)
void protocols::features::StructureFeatures::load_into_pose ( utility::sql_database::sessionOP  db_session,
StructureID  struct_id,
core::pose::Pose pose 
)
overridevirtual

Reimplemented from protocols::features::FeaturesReporter.

References load_tag().

void protocols::features::StructureFeatures::load_tag ( utility::sql_database::sessionOP  db_session,
StructureID  struct_id,
core::pose::Pose pose 
)
void protocols::features::StructureFeatures::mark_structure_as_sampled ( core::Size  batch_id,
std::string const &  tag,
std::string const &  input_tag,
utility::sql_database::sessionOP  db_session 
)
void protocols::features::StructureFeatures::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
core::Size protocols::features::StructureFeatures::report_features ( core::pose::Pose const &  ,
utility::vector1< bool > const &  ,
StructureID  ,
utility::sql_database::sessionOP   
)
inlineoverridevirtual

collect all the feature data for the pose

Implements protocols::features::FeaturesReporter.

StructureID protocols::features::StructureFeatures::report_features ( core::Size  batch_id,
utility::sql_database::sessionOP  db_session,
std::string const &  tag,
std::string const &  input_tag 
)

collect all the feature data for the pose use This version allows the tag and the input tag to be specificed

std::string protocols::features::StructureFeatures::type_name ( ) const
overridevirtual

Reimplemented from protocols::features::FeaturesReporter.

References class_name().

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

generate the table schemas and write them to the database

Implements protocols::features::FeaturesReporter.

References protocols::mean_field::max(), and protocols::features::TR().


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