Rosetta
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::simple_filters::SaveResfileToDiskFilter Class Reference

#include <SaveResfileToDiskFilter.hh>

Inheritance diagram for protocols::simple_filters::SaveResfileToDiskFilter:
Inheritance graph
[legend]

Public Types

typedef protocols::filters::Filter Super
 
typedef protocols::filters::Filter Filter
 
typedef protocols::filters::FilterOP FilterOP
 
typedef core::Real Real
 
typedef core::pose::Pose Pose
 
typedef utility::tag::TagCOP TagCOP
 
typedef basic::datacache::DataMap DataMap
 

Public Member Functions

 SaveResfileToDiskFilter ()
 
 SaveResfileToDiskFilter (core::pack::task::TaskFactoryOP task_factory, utility::vector1< core::Size > const &selected_resis, bool const designable_only, std::string const &resfile_name, std::string const &resfile_suffix, std::string const &resfile_prefix, std::string const &resfile_general_property, std::string const &selected_resis_property)
 
 SaveResfileToDiskFilter (SaveResfileToDiskFilter const &rval)
 
 ~SaveResfileToDiskFilter () override
 
protocols::filters::FilterOP clone () const override
 
protocols::filters::FilterOP fresh_instance () const override
 
void task_factory (core::pack::task::TaskFactoryOP task_factory)
 
void selected_resis (utility::vector1< core::Size > const r)
 
void designable_only (bool const d)
 
void renumber_pdb (bool const r)
 
void resfile_name (std::string const &n)
 
void resfile_suffix (std::string const &s)
 
void resfile_prefix (std::string const &p)
 
void resfile_general_property (std::string const &g)
 
void selected_resis_property (std::string const &g)
 
core::pack::task::TaskFactoryOP task_factory () const
 
utility::vector1< core::Sizeselected_resis () const
 
bool designable_only () const
 
bool renumber_pdb () const
 
std::string resfile_name () const
 
std::string resfile_suffix () const
 
std::string resfile_prefix () const
 
std::string resfile_general_property () const
 
std::string selected_resis_property () const
 
void parse_my_tag (TagCOP tag, basic::datacache::DataMap &) override
 parse xml More...
 
bool apply (core::pose::Pose const &pose) const override
 Returns true if the given pose passes the filter, false otherwise. More...
 
utility::vector1< core::Sizeselect_residues (Pose const &pose) const
 Applies the TaskOperations specified in the xml, and then selects either. More...
 
void write_resfile (Pose const &pose, utility::vector1< core::Size > const &selected_residues) const
 Write the resfile to disk. More...
 
std::string name () const override
 
- Public Member Functions inherited from protocols::filters::Filter
 Filter ()
 
 Filter (std::string const &)
 
 ~Filter () override
 
virtual void report (std::ostream &, core::pose::Pose const &) const
 
virtual core::Real report_sm (core::pose::Pose const &) const
 used to report filter internals through a score or silent file More...
 
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 Attributes

core::pack::task::TaskFactoryOP task_factory_
 
utility::vector1< core::Sizeselected_resis_
 
bool designable_only_
 
bool renumber_pdb_
 
std::string resfile_name_
 
std::string resfile_suffix_
 
std::string resfile_prefix_
 
std::string resfile_general_property_
 
std::string selected_resis_property_
 

Additional Inherited Members

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

Member Typedef Documentation

◆ DataMap

◆ Filter

◆ FilterOP

◆ Pose

◆ Real

◆ Super

◆ TagCOP

Constructor & Destructor Documentation

◆ SaveResfileToDiskFilter() [1/3]

protocols::simple_filters::SaveResfileToDiskFilter::SaveResfileToDiskFilter ( )

◆ SaveResfileToDiskFilter() [2/3]

protocols::simple_filters::SaveResfileToDiskFilter::SaveResfileToDiskFilter ( core::pack::task::TaskFactoryOP  task_factory,
utility::vector1< core::Size > const &  selected_resis,
bool const  designable_only,
std::string const &  resfile_name,
std::string const &  resfile_suffix,
std::string const &  resfile_prefix,
std::string const &  resfile_general_property,
std::string const &  selected_resis_property 
)

◆ SaveResfileToDiskFilter() [3/3]

protocols::simple_filters::SaveResfileToDiskFilter::SaveResfileToDiskFilter ( SaveResfileToDiskFilter const &  rval)
default

◆ ~SaveResfileToDiskFilter()

protocols::simple_filters::SaveResfileToDiskFilter::~SaveResfileToDiskFilter ( )
overridedefault

Member Function Documentation

◆ apply()

bool protocols::simple_filters::SaveResfileToDiskFilter::apply ( core::pose::Pose const &  pose) const
overridevirtual

Returns true if the given pose passes the filter, false otherwise.

Implements protocols::filters::Filter.

References select_residues(), and write_resfile().

◆ class_name()

std::string protocols::simple_filters::SaveResfileToDiskFilter::class_name ( )
static

◆ clone()

protocols::filters::FilterOP protocols::simple_filters::SaveResfileToDiskFilter::clone ( ) const
overridevirtual

◆ designable_only() [1/2]

bool protocols::simple_filters::SaveResfileToDiskFilter::designable_only ( ) const

References designable_only_.

Referenced by parse_my_tag().

◆ designable_only() [2/2]

void protocols::simple_filters::SaveResfileToDiskFilter::designable_only ( bool const  d)

References designable_only_.

◆ fresh_instance()

protocols::filters::FilterOP protocols::simple_filters::SaveResfileToDiskFilter::fresh_instance ( ) const
overridevirtual

◆ name()

std::string protocols::simple_filters::SaveResfileToDiskFilter::name ( ) const
overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

◆ parse_my_tag()

void protocols::simple_filters::SaveResfileToDiskFilter::parse_my_tag ( TagCOP  tag,
basic::datacache::DataMap data 
)
overridevirtual

◆ provide_xml_schema()

void protocols::simple_filters::SaveResfileToDiskFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static

◆ renumber_pdb() [1/2]

bool protocols::simple_filters::SaveResfileToDiskFilter::renumber_pdb ( ) const

References renumber_pdb_.

Referenced by parse_my_tag(), and write_resfile().

◆ renumber_pdb() [2/2]

void protocols::simple_filters::SaveResfileToDiskFilter::renumber_pdb ( bool const  r)

References renumber_pdb_.

◆ resfile_general_property() [1/2]

std::string protocols::simple_filters::SaveResfileToDiskFilter::resfile_general_property ( ) const

References resfile_general_property_.

Referenced by parse_my_tag(), and write_resfile().

◆ resfile_general_property() [2/2]

void protocols::simple_filters::SaveResfileToDiskFilter::resfile_general_property ( std::string const &  g)

◆ resfile_name() [1/2]

std::string protocols::simple_filters::SaveResfileToDiskFilter::resfile_name ( ) const

References resfile_name_.

Referenced by parse_my_tag(), and write_resfile().

◆ resfile_name() [2/2]

void protocols::simple_filters::SaveResfileToDiskFilter::resfile_name ( std::string const &  n)

References resfile_name_.

◆ resfile_prefix() [1/2]

std::string protocols::simple_filters::SaveResfileToDiskFilter::resfile_prefix ( ) const

References resfile_prefix_.

Referenced by parse_my_tag(), and write_resfile().

◆ resfile_prefix() [2/2]

void protocols::simple_filters::SaveResfileToDiskFilter::resfile_prefix ( std::string const &  p)

References resfile_prefix_.

◆ resfile_suffix() [1/2]

std::string protocols::simple_filters::SaveResfileToDiskFilter::resfile_suffix ( ) const

References resfile_suffix_.

Referenced by parse_my_tag(), and write_resfile().

◆ resfile_suffix() [2/2]

void protocols::simple_filters::SaveResfileToDiskFilter::resfile_suffix ( std::string const &  s)

References resfile_suffix_.

◆ select_residues()

utility::vector1< core::Size > protocols::simple_filters::SaveResfileToDiskFilter::select_residues ( Pose const &  pose) const

Applies the TaskOperations specified in the xml, and then selects either.

References designable_only_, core::conformation::Residue::is_protein(), core::pose::Pose::residue(), core::pose::Pose::size(), task_factory(), and protocols::simple_filters::TR().

Referenced by apply().

◆ selected_resis() [1/2]

utility::vector1< core::Size > protocols::simple_filters::SaveResfileToDiskFilter::selected_resis ( ) const

References selected_resis_.

◆ selected_resis() [2/2]

void protocols::simple_filters::SaveResfileToDiskFilter::selected_resis ( utility::vector1< core::Size > const  r)

References selected_resis_.

◆ selected_resis_property() [1/2]

std::string protocols::simple_filters::SaveResfileToDiskFilter::selected_resis_property ( ) const

References selected_resis_property_.

Referenced by parse_my_tag(), and write_resfile().

◆ selected_resis_property() [2/2]

void protocols::simple_filters::SaveResfileToDiskFilter::selected_resis_property ( std::string const &  g)

◆ task_factory() [1/2]

core::pack::task::TaskFactoryOP protocols::simple_filters::SaveResfileToDiskFilter::task_factory ( ) const

◆ task_factory() [2/2]

void protocols::simple_filters::SaveResfileToDiskFilter::task_factory ( core::pack::task::TaskFactoryOP  task_factory)

References task_factory(), and task_factory_.

◆ write_resfile()

void protocols::simple_filters::SaveResfileToDiskFilter::write_resfile ( Pose const &  pose,
utility::vector1< core::Size > const &  selected_residues 
) const

Member Data Documentation

◆ designable_only_

bool protocols::simple_filters::SaveResfileToDiskFilter::designable_only_
private

Referenced by designable_only(), and select_residues().

◆ renumber_pdb_

bool protocols::simple_filters::SaveResfileToDiskFilter::renumber_pdb_
private

Referenced by renumber_pdb().

◆ resfile_general_property_

std::string protocols::simple_filters::SaveResfileToDiskFilter::resfile_general_property_
private

◆ resfile_name_

std::string protocols::simple_filters::SaveResfileToDiskFilter::resfile_name_
private

Referenced by resfile_name().

◆ resfile_prefix_

std::string protocols::simple_filters::SaveResfileToDiskFilter::resfile_prefix_
private

Referenced by resfile_prefix().

◆ resfile_suffix_

std::string protocols::simple_filters::SaveResfileToDiskFilter::resfile_suffix_
private

Referenced by resfile_suffix().

◆ selected_resis_

utility::vector1< core::Size > protocols::simple_filters::SaveResfileToDiskFilter::selected_resis_
private

Referenced by selected_resis().

◆ selected_resis_property_

std::string protocols::simple_filters::SaveResfileToDiskFilter::selected_resis_property_
private

Referenced by selected_resis_property().

◆ task_factory_

core::pack::task::TaskFactoryOP protocols::simple_filters::SaveResfileToDiskFilter::task_factory_
private

Referenced by task_factory().


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