Rosetta
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
protocols::protein_interface_design::filters::FilterScanFilter Class Reference

#include <FilterScan.hh>

Inheritance diagram for protocols::protein_interface_design::filters::FilterScanFilter:
Inheritance graph
[legend]

Public Member Functions

 FilterScanFilter ()
 default ctor More...
 
 ~FilterScanFilter () override
 
bool apply (core::pose::Pose const &pose) const override
 Constructor with a single target residue. More...
 
void report (std::ostream &out, core::pose::Pose const &pose) const override
 
core::Real report_sm (core::pose::Pose const &pose) const override
 used to report filter internals through a score or silent file More...
 
protocols::filters::FilterOP clone () const override
 
protocols::filters::FilterOP fresh_instance () const override
 
core::pack::task::TaskFactoryOP task_factory () const
 Undefined, commenting out to fix PyRosetta build core::Real compute( core::pose::Pose const & pose ) const;. More...
 
void task_factory (core::pack::task::TaskFactoryOP task_factory)
 
void resfile_name (std::string const &resfile_name)
 
void score_log_file (std::string const &score_log_file)
 
std::string resfile_name () const
 
std::string score_log_file () const
 
protocols::filters::FilterOP triage_filter () const
 
void triage_filter (protocols::filters::FilterOP filter)
 
protocols::filters::FilterOP filter () const
 
void filter (protocols::filters::FilterOP filter)
 
std::string resfile_general_property () const
 
void resfile_general_property (std::string const &)
 
void relax_mover (protocols::moves::MoverOP mover)
 
protocols::moves::MoverOP relax_mover () const
 
core::scoring::ScoreFunctionOP scorefxn () const
 
void scorefxn (core::scoring::ScoreFunctionOP scorefxn)
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
 Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing. More...
 
bool unbound () const
 
void unbound (bool const u)
 
core::Size jump () const
 
void jump (core::Size const j)
 
bool delta () const
 
void delta (bool const d)
 
bool report_all () const
 
void report_all (bool const ra)
 
void dump_pdb (bool const d)
 
bool dump_pdb () const
 
bool rtmin () const
 
void rtmin (bool const r)
 
void single_substitution (core::pose::Pose &pose, core::Size const resi, core::chemical::AA const target_aa) const
 introduces a single-point subsitution and then performs the repack, rtmin, and relax moves that are requested. More...
 
utility::vector1< protocols::simple_filters::DeltaFilterOPdelta_filters () const
 
void delta_filters (utility::vector1< protocols::simple_filters::DeltaFilterOP > const &d)
 
std::string dump_pdb_name () const
 
void dump_pdb_name (std::string const &s)
 
bool keep_native () const
 
void keep_native (bool const k)
 
utility::vector1< core::Realdelta_filter_thresholds () const
 
void delta_filter_thresholds (utility::vector1< core::Real > const &)
 
std::string name () const override
 
bool log_pdb_number () const
 
void log_pdb_number (bool const log)
 
std::string log_separator () const
 
void log_separator (std::string const &sep)
 
- Public Member Functions inherited from protocols::filters::Filter
 Filter ()
 
 Filter (std::string const &)
 
 ~Filter () override
 
virtual std::string get_type () const
 
std::string get_user_defined_name () const
 
void set_user_defined_name (std::string const &name)
 
virtual void clear ()
 used to clear internal variables if needed. Using fresh_instance is preferred since it's a pure virtual More...
 
virtual core::Real score (core::pose::Pose &pose)
 
virtual void provide_citation_info (basic::citation_manager::CitationCollectionList &) const
 Provide citations to the passed CitationCollectionList Subclasses should add the info for themselves and any other classes they use. More...
 

Static Public Member Functions

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

Private Types

typedef protocols::filters::Filter parent
 

Private Member Functions

void unbind (core::pose::Pose &) const
 

Private Attributes

core::pack::task::TaskFactoryOP task_factory_
 
protocols::filters::FilterOP triage_filter_
 
protocols::filters::FilterOP filter_
 
std::string score_log_file_
 
std::string resfile_name_
 
std::string resfile_general_property_
 
protocols::moves::MoverOP relax_mover_
 
core::scoring::ScoreFunctionOP scorefxn_
 
bool delta_
 
bool unbound_
 
bool report_all_
 
core::Size jump_
 
bool dump_pdb_
 
bool rtmin_
 
utility::vector1< protocols::simple_filters::DeltaFilterOPdelta_filters_
 
std::string dump_pdb_name_
 
bool keep_native_
 
utility::vector1< core::Realdelta_filter_thresholds_
 
bool log_pdb_number_
 
std::string log_separator_
 

Additional Inherited Members

- Protected Attributes inherited from protocols::filters::Filter
std::string scorename_
 

Member Typedef Documentation

◆ parent

Constructor & Destructor Documentation

◆ FilterScanFilter()

protocols::protein_interface_design::filters::FilterScanFilter::FilterScanFilter ( )

◆ ~FilterScanFilter()

protocols::protein_interface_design::filters::FilterScanFilter::~FilterScanFilter ( )
overridedefault

Member Function Documentation

◆ apply()

bool protocols::protein_interface_design::filters::FilterScanFilter::apply ( core::pose::Pose const &  pose) const
overridevirtual

◆ class_name()

std::string protocols::protein_interface_design::filters::FilterScanFilter::class_name ( )
static

◆ clone()

protocols::filters::FilterOP protocols::protein_interface_design::filters::FilterScanFilter::clone ( ) const
overridevirtual

◆ delta() [1/2]

bool protocols::protein_interface_design::filters::FilterScanFilter::delta ( ) const

References delta_.

Referenced by apply(), and parse_my_tag().

◆ delta() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::delta ( bool const  d)

References delta_.

◆ delta_filter_thresholds() [1/2]

utility::vector1< core::Real > protocols::protein_interface_design::filters::FilterScanFilter::delta_filter_thresholds ( ) const

◆ delta_filter_thresholds() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::delta_filter_thresholds ( utility::vector1< core::Real > const &  v)

◆ delta_filters() [1/2]

utility::vector1< protocols::simple_filters::DeltaFilterOP > protocols::protein_interface_design::filters::FilterScanFilter::delta_filters ( ) const

References delta_filters_.

◆ delta_filters() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::delta_filters ( utility::vector1< protocols::simple_filters::DeltaFilterOP > const &  d)

References delta_filters_.

◆ dump_pdb() [1/2]

bool protocols::protein_interface_design::filters::FilterScanFilter::dump_pdb ( ) const

References dump_pdb_.

Referenced by apply(), and parse_my_tag().

◆ dump_pdb() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::dump_pdb ( bool const  d)

References dump_pdb_.

◆ dump_pdb_name() [1/2]

std::string protocols::protein_interface_design::filters::FilterScanFilter::dump_pdb_name ( ) const
inline

References dump_pdb_name_.

Referenced by apply(), and parse_my_tag().

◆ dump_pdb_name() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::dump_pdb_name ( std::string const &  s)
inline

References dump_pdb_name_.

◆ filter() [1/2]

protocols::filters::FilterOP protocols::protein_interface_design::filters::FilterScanFilter::filter ( ) const

References filter_.

Referenced by apply(), filter(), parse_my_tag(), and triage_filter().

◆ filter() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::filter ( protocols::filters::FilterOP  filter)

References filter(), and filter_.

◆ fresh_instance()

protocols::filters::FilterOP protocols::protein_interface_design::filters::FilterScanFilter::fresh_instance ( ) const
overridevirtual

◆ jump() [1/2]

core::Size protocols::protein_interface_design::filters::FilterScanFilter::jump ( ) const

References jump_.

Referenced by parse_my_tag(), and unbind().

◆ jump() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::jump ( core::Size const  j)

References jump_.

◆ keep_native() [1/2]

bool protocols::protein_interface_design::filters::FilterScanFilter::keep_native ( ) const
inline

References keep_native_.

Referenced by apply(), and parse_my_tag().

◆ keep_native() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::keep_native ( bool const  k)
inline

References keep_native_.

◆ log_pdb_number() [1/2]

bool protocols::protein_interface_design::filters::FilterScanFilter::log_pdb_number ( ) const
inline

References log_pdb_number_.

Referenced by parse_my_tag().

◆ log_pdb_number() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::log_pdb_number ( bool const  log)
inline

References log_pdb_number_.

◆ log_separator() [1/2]

std::string protocols::protein_interface_design::filters::FilterScanFilter::log_separator ( ) const
inline

References log_separator_.

Referenced by parse_my_tag().

◆ log_separator() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::log_separator ( std::string const &  sep)
inline

References log_separator_.

◆ name()

std::string protocols::protein_interface_design::filters::FilterScanFilter::name ( ) const
overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

◆ parse_my_tag()

void protocols::protein_interface_design::filters::FilterScanFilter::parse_my_tag ( utility::tag::TagCOP  ,
basic::datacache::DataMap  
)
overridevirtual

◆ provide_xml_schema()

void protocols::protein_interface_design::filters::FilterScanFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static

◆ relax_mover() [1/2]

protocols::moves::MoverOP protocols::protein_interface_design::filters::FilterScanFilter::relax_mover ( ) const

References relax_mover_.

Referenced by parse_my_tag(), and single_substitution().

◆ relax_mover() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::relax_mover ( protocols::moves::MoverOP  mover)

References relax_mover_.

◆ report()

void protocols::protein_interface_design::filters::FilterScanFilter::report ( std::ostream &  out,
core::pose::Pose const &  pose 
) const
overridevirtual

Reimplemented from protocols::filters::Filter.

◆ report_all() [1/2]

bool protocols::protein_interface_design::filters::FilterScanFilter::report_all ( ) const

References report_all_.

Referenced by parse_my_tag().

◆ report_all() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::report_all ( bool const  ra)

References report_all_.

◆ report_sm()

core::Real protocols::protein_interface_design::filters::FilterScanFilter::report_sm ( core::pose::Pose const &  ) const
overridevirtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

Referenced by apply().

◆ resfile_general_property() [1/2]

std::string protocols::protein_interface_design::filters::FilterScanFilter::resfile_general_property ( ) const

◆ resfile_general_property() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::resfile_general_property ( std::string const &  resfile_general_property)

◆ resfile_name() [1/2]

std::string protocols::protein_interface_design::filters::FilterScanFilter::resfile_name ( ) const

◆ resfile_name() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::resfile_name ( std::string const &  resfile_name)

References resfile_name(), and resfile_name_.

◆ rtmin() [1/2]

bool protocols::protein_interface_design::filters::FilterScanFilter::rtmin ( ) const
inline

References rtmin_.

Referenced by parse_my_tag(), and single_substitution().

◆ rtmin() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::rtmin ( bool const  r)
inline

References rtmin_.

◆ score_log_file() [1/2]

std::string protocols::protein_interface_design::filters::FilterScanFilter::score_log_file ( ) const

References score_log_file_.

Referenced by apply(), parse_my_tag(), and score_log_file().

◆ score_log_file() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::score_log_file ( std::string const &  score_log_file)

◆ scorefxn() [1/2]

core::scoring::ScoreFunctionOP protocols::protein_interface_design::filters::FilterScanFilter::scorefxn ( ) const

◆ scorefxn() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::scorefxn ( core::scoring::ScoreFunctionOP  scorefxn)

References scorefxn(), and scorefxn_.

◆ single_substitution()

void protocols::protein_interface_design::filters::FilterScanFilter::single_substitution ( core::pose::Pose pose,
core::Size const  resi,
core::chemical::AA const  target_aa 
) const

◆ task_factory() [1/2]

core::pack::task::TaskFactoryOP protocols::protein_interface_design::filters::FilterScanFilter::task_factory ( ) const

Undefined, commenting out to fix PyRosetta build core::Real compute( core::pose::Pose const & pose ) const;.

References task_factory_.

Referenced by apply(), parse_my_tag(), single_substitution(), and task_factory().

◆ task_factory() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::task_factory ( core::pack::task::TaskFactoryOP  task_factory)

References task_factory(), and task_factory_.

◆ triage_filter() [1/2]

protocols::filters::FilterOP protocols::protein_interface_design::filters::FilterScanFilter::triage_filter ( ) const

References triage_filter_.

Referenced by apply(), and parse_my_tag().

◆ triage_filter() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::triage_filter ( protocols::filters::FilterOP  filter)

References filter(), and triage_filter_.

◆ unbind()

void protocols::protein_interface_design::filters::FilterScanFilter::unbind ( core::pose::Pose pose) const
private

◆ unbound() [1/2]

bool protocols::protein_interface_design::filters::FilterScanFilter::unbound ( ) const

References unbound_.

Referenced by parse_my_tag(), and unbind().

◆ unbound() [2/2]

void protocols::protein_interface_design::filters::FilterScanFilter::unbound ( bool const  u)

Member Data Documentation

◆ delta_

bool protocols::protein_interface_design::filters::FilterScanFilter::delta_
private

Referenced by delta().

◆ delta_filter_thresholds_

utility::vector1< core::Real > protocols::protein_interface_design::filters::FilterScanFilter::delta_filter_thresholds_
private

◆ delta_filters_

utility::vector1< protocols::simple_filters::DeltaFilterOP > protocols::protein_interface_design::filters::FilterScanFilter::delta_filters_
private

◆ dump_pdb_

bool protocols::protein_interface_design::filters::FilterScanFilter::dump_pdb_
private

Referenced by dump_pdb().

◆ dump_pdb_name_

std::string protocols::protein_interface_design::filters::FilterScanFilter::dump_pdb_name_
private

Referenced by apply(), dump_pdb_name(), and parse_my_tag().

◆ filter_

protocols::filters::FilterOP protocols::protein_interface_design::filters::FilterScanFilter::filter_
private

Referenced by filter().

◆ jump_

core::Size protocols::protein_interface_design::filters::FilterScanFilter::jump_
private

Referenced by jump().

◆ keep_native_

bool protocols::protein_interface_design::filters::FilterScanFilter::keep_native_
private

Referenced by keep_native().

◆ log_pdb_number_

bool protocols::protein_interface_design::filters::FilterScanFilter::log_pdb_number_
private

Referenced by apply(), and log_pdb_number().

◆ log_separator_

std::string protocols::protein_interface_design::filters::FilterScanFilter::log_separator_
private

Referenced by apply(), and log_separator().

◆ relax_mover_

protocols::moves::MoverOP protocols::protein_interface_design::filters::FilterScanFilter::relax_mover_
private

Referenced by relax_mover().

◆ report_all_

bool protocols::protein_interface_design::filters::FilterScanFilter::report_all_
private

Referenced by apply(), and report_all().

◆ resfile_general_property_

std::string protocols::protein_interface_design::filters::FilterScanFilter::resfile_general_property_
private

◆ resfile_name_

std::string protocols::protein_interface_design::filters::FilterScanFilter::resfile_name_
private

Referenced by resfile_name().

◆ rtmin_

bool protocols::protein_interface_design::filters::FilterScanFilter::rtmin_
private

Referenced by rtmin().

◆ score_log_file_

std::string protocols::protein_interface_design::filters::FilterScanFilter::score_log_file_
private

Referenced by score_log_file().

◆ scorefxn_

core::scoring::ScoreFunctionOP protocols::protein_interface_design::filters::FilterScanFilter::scorefxn_
private

Referenced by scorefxn().

◆ task_factory_

core::pack::task::TaskFactoryOP protocols::protein_interface_design::filters::FilterScanFilter::task_factory_
private

Referenced by task_factory().

◆ triage_filter_

protocols::filters::FilterOP protocols::protein_interface_design::filters::FilterScanFilter::triage_filter_
private

Referenced by triage_filter().

◆ unbound_

bool protocols::protein_interface_design::filters::FilterScanFilter::unbound_
private

Referenced by unbound().


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