Rosetta
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::antibody::clusters::CDRClusterFeatures Class Reference

#include <CDRClusterFeatures.hh>

Inheritance diagram for protocols::antibody::clusters::CDRClusterFeatures:
Inheritance graph
[legend]

Public Member Functions

 CDRClusterFeatures ()
 
 ~CDRClusterFeatures () override
 
void write_schema_to_db (utility::sql_database::sessionOP db_session) const override
 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...
 
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 &pose, utility::vector1< bool > const &residues, features::StructureID struct_id, utility::sql_database::sessionOP db_session) override
 collect all the feature data for the pose. More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
 Specify specific CDRs to load and analyze, with cdr_definition and scheme. More...
 
void set_cdrs_to_use (utility::vector1< CDRNameEnum > cdrs)
 Limit CDRs being analyzed. More...
 
void set_numbering_scheme (AntibodyNumberingSchemeEnum const &numbering_scheme)
 set the numbering scheme used by the pose. More...
 
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 load_into_pose (utility::sql_database::sessionOP, StructureID, core::pose::Pose &)
 
virtual void delete_record (StructureID, utility::sql_database::sessionOP)
 
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)
 

Private Attributes

utility::vector1< CDRNameEnumcdrs_
 
AntibodyNumberingSchemeEnum numbering_scheme_
 

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

◆ CDRClusterFeatures()

protocols::antibody::clusters::CDRClusterFeatures::CDRClusterFeatures ( )

References cdrs_.

◆ ~CDRClusterFeatures()

protocols::antibody::clusters::CDRClusterFeatures::~CDRClusterFeatures ( )
overridedefault

Member Function Documentation

◆ class_name()

std::string protocols::antibody::clusters::CDRClusterFeatures::class_name ( )
static

◆ features_reporter_dependencies()

utility::vector1< std::string > protocols::antibody::clusters::CDRClusterFeatures::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.

◆ parse_my_tag()

void protocols::antibody::clusters::CDRClusterFeatures::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap  
)
overridevirtual

Specify specific CDRs to load and analyze, with cdr_definition and scheme.

Reimplemented from protocols::features::FeaturesReporter.

References cdrs_, and set_numbering_scheme().

◆ provide_xml_schema()

void protocols::antibody::clusters::CDRClusterFeatures::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static

◆ report_features()

core::Size protocols::antibody::clusters::CDRClusterFeatures::report_features ( core::pose::Pose const &  ,
utility::vector1< bool > const &  ,
features::StructureID  ,
utility::sql_database::sessionOP   
)
overridevirtual

collect all the feature data for the pose.

Implements protocols::features::FeaturesReporter.

References cdrs_, protocols::antibody::North, and numbering_scheme_.

◆ set_cdrs_to_use()

void protocols::antibody::clusters::CDRClusterFeatures::set_cdrs_to_use ( utility::vector1< CDRNameEnum cdrs)

Limit CDRs being analyzed.

References cdrs_.

◆ set_numbering_scheme()

void protocols::antibody::clusters::CDRClusterFeatures::set_numbering_scheme ( AntibodyNumberingSchemeEnum const &  numbering_scheme)

set the numbering scheme used by the pose.

References numbering_scheme_.

Referenced by parse_my_tag().

◆ type_name()

std::string protocols::antibody::clusters::CDRClusterFeatures::type_name ( ) const
overridevirtual

Reimplemented from protocols::features::FeaturesReporter.

References class_name().

◆ write_schema_to_db()

void protocols::antibody::clusters::CDRClusterFeatures::write_schema_to_db ( utility::sql_database::sessionOP  db_session) const
overridevirtual

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.

Implements protocols::features::FeaturesReporter.

Member Data Documentation

◆ cdrs_

utility::vector1< CDRNameEnum > protocols::antibody::clusters::CDRClusterFeatures::cdrs_
private

◆ numbering_scheme_

AntibodyNumberingSchemeEnum protocols::antibody::clusters::CDRClusterFeatures::numbering_scheme_
private

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