Rosetta Protocols  2014.35
Public Member Functions | Private Attributes | List of all members
protocols::simple_filters::ResidueCountFilter Class Reference

#include <ResidueCountFilter.hh>

Public Member Functions

 ResidueCountFilter ()
 
 ResidueCountFilter (ResidueCountFilter const &src)
 
virtual ~ResidueCountFilter ()
 
bool apply (core::pose::Pose const &pose) const
 Returns true if the given pose passes the filter, false otherwise. More...
 
filters::FilterOP clone () const
 
filters::FilterOP fresh_instance () const
 
void report (std::ostream &out, core::pose::Pose const &pose) const
 
core::Real report_sm (core::pose::Pose const &pose) const
 used to report filter internals through a score or silent file More...
 
core::Real compute (core::pose::Pose const &pose) const
 
core::Real round_to_Real (core::Real x) const
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &, filters::Filters_map const &, moves::Movers_map const &, core::pose::Pose const &)
 
core::Size max_residue_count () const
 
void max_residue_count (core::Size value)
 
bool enable_max_residue_count () const
 
void enable_max_residue_count (bool value)
 
core::Size min_residue_count () const
 
void min_residue_count (core::Size value)
 
utility::vector1< std::stringres_types () const
 
void res_types (utility::vector1< std::string > const &res_type)
 
bool enable_min_residue_count () const
 
void enable_min_residue_count (bool value)
 
core::pack::task::TaskFactoryOP task_factory () const
 
void task_factory (core::pack::task::TaskFactoryOP task_factory)
 
bool packable () const
 
void packable (bool const pack)
 
bool add_residue_type_by_name (core::chemical::ResidueTypeSet const &res_type_set, std::string const &res_type_input)
 Checks whether a residue type is present in the provided residue type set, and if so, adds it to res_types_. More...
 
- Public Member Functions inherited from protocols::filters::Filter
 Filter ()
 
 Filter (std::string const &)
 
 Filter (Filter const &)
 
virtual ~Filter ()
 
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 void apply (core::io::serialization::PipeMap &pmap)
 
virtual void score (core::io::serialization::PipeMap &pmap)
 
virtual core::Real score (core::pose::Pose &pose)
 
virtual void parse_def (utility::lua::LuaObject const &def, utility::lua::LuaObject const &score_fxns, utility::lua::LuaObject const &tasks)
 
virtual std::string name () const
 

Private Attributes

core::Size max_residue_count_
 
bool enable_max_residue_count_
 
core::Size min_residue_count_
 
bool enable_min_residue_count_
 
bool count_as_percentage_
 
utility::vector1< std::stringres_types_
 
bool packable_
 
core::pack::task::TaskFactoryOP task_factory_
 

Additional Inherited Members

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

Constructor & Destructor Documentation

protocols::simple_filters::ResidueCountFilter::ResidueCountFilter ( )

References filters.

Referenced by clone(), and fresh_instance().

protocols::simple_filters::ResidueCountFilter::ResidueCountFilter ( ResidueCountFilter const &  src)

References filters.

protocols::simple_filters::ResidueCountFilter::~ResidueCountFilter ( )
virtual

Member Function Documentation

bool protocols::simple_filters::ResidueCountFilter::add_residue_type_by_name ( core::chemical::ResidueTypeSet const &  res_type_set,
std::string const &  res_type_input 
)

Checks whether a residue type is present in the provided residue type set, and if so, adds it to res_types_.

given user specified residue type string, look for residue type name and add it to the list of types to count if it is present in the specified ResidueTypeSet. res_type_set, the residue type set of the input structure res_type_input, the user specified residue type name

Returns
false if res_type_input doesn't match any residue type names, true otherwise

References core::chemical::ResidueTypeSet::has_name(), and res_types_.

Referenced by parse_my_tag().

bool protocols::simple_filters::ResidueCountFilter::apply ( core::pose::Pose const &  pose) const
virtual
filters::FilterOP protocols::simple_filters::ResidueCountFilter::clone ( ) const
virtual
core::Real protocols::simple_filters::ResidueCountFilter::compute ( core::pose::Pose const &  pose) const
bool protocols::simple_filters::ResidueCountFilter::enable_max_residue_count ( ) const

References enable_max_residue_count_.

Referenced by apply(), and parse_my_tag().

void protocols::simple_filters::ResidueCountFilter::enable_max_residue_count ( bool  value)
bool protocols::simple_filters::ResidueCountFilter::enable_min_residue_count ( ) const

References enable_min_residue_count_.

Referenced by apply(), and parse_my_tag().

void protocols::simple_filters::ResidueCountFilter::enable_min_residue_count ( bool  value)
filters::FilterOP protocols::simple_filters::ResidueCountFilter::fresh_instance ( ) const
virtual
core::Size protocols::simple_filters::ResidueCountFilter::max_residue_count ( ) const

References max_residue_count_.

Referenced by apply(), and parse_my_tag().

void protocols::simple_filters::ResidueCountFilter::max_residue_count ( core::Size  value)

References max_residue_count_.

core::Size protocols::simple_filters::ResidueCountFilter::min_residue_count ( ) const

References min_residue_count_.

Referenced by apply(), and parse_my_tag().

void protocols::simple_filters::ResidueCountFilter::min_residue_count ( core::Size  value)

References min_residue_count_.

bool protocols::simple_filters::ResidueCountFilter::packable ( ) const

References packable_.

Referenced by parse_my_tag().

void protocols::simple_filters::ResidueCountFilter::packable ( bool const  pack)

References packable_.

void protocols::simple_filters::ResidueCountFilter::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap data,
filters::Filters_map const &  ,
moves::Movers_map const &  ,
core::pose::Pose const &  pose 
)
virtual
void protocols::simple_filters::ResidueCountFilter::report ( std::ostream &  out,
core::pose::Pose const &  pose 
) const
virtual

Reimplemented from protocols::filters::Filter.

References compute().

core::Real protocols::simple_filters::ResidueCountFilter::report_sm ( core::pose::Pose const &  ) const
virtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References compute().

utility::vector1< std::string > protocols::simple_filters::ResidueCountFilter::res_types ( ) const

References res_types_.

void protocols::simple_filters::ResidueCountFilter::res_types ( utility::vector1< std::string > const &  res_type)

References res_types_.

Real protocols::simple_filters::ResidueCountFilter::round_to_Real ( core::Real  x) const

Referenced by compute().

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

References task_factory_.

Referenced by compute(), parse_my_tag(), and task_factory().

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

References task_factory(), and task_factory_.

Member Data Documentation

bool protocols::simple_filters::ResidueCountFilter::count_as_percentage_
private

Referenced by compute(), and parse_my_tag().

bool protocols::simple_filters::ResidueCountFilter::enable_max_residue_count_
private
bool protocols::simple_filters::ResidueCountFilter::enable_min_residue_count_
private
core::Size protocols::simple_filters::ResidueCountFilter::max_residue_count_
private

Referenced by max_residue_count().

core::Size protocols::simple_filters::ResidueCountFilter::min_residue_count_
private

Referenced by min_residue_count().

bool protocols::simple_filters::ResidueCountFilter::packable_
private

Referenced by compute(), and packable().

utility::vector1< std::string > protocols::simple_filters::ResidueCountFilter::res_types_
private
core::pack::task::TaskFactoryOP protocols::simple_filters::ResidueCountFilter::task_factory_
private

Referenced by task_factory().


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