Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::simple_filters::NonSequentialNeighborsFilter Class Reference

#include <NonSequentialNeighborsFilter.hh>

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

Public Member Functions

 NonSequentialNeighborsFilter ()
 
bool apply (core::pose::Pose const &pose) const override
 Returns true if the given pose passes the filter, false otherwise. More...
 
filters::FilterOP clone () const override
 
filters::FilterOP fresh_instance () const override
 
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...
 
core::Real compute (core::pose::Pose const &pose) const
 
 ~NonSequentialNeighborsFilter () override
 
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...
 
core::Real distance_threshold () const
 
void distance_threshold (core::Real const r)
 
core::Size neighbor_cutoff () const
 
void neighbor_cutoff (core::Size const n)
 
bool bound () const
 
void bound (bool const b)
 
core::Size resnum () const
 
void resnum (core::Size const s)
 
void jump (core::Size const j)
 
core::Size jump () const
 
core::Size residue_neighbors (core::pose::Pose const &pose, core::Size const resi) const
 
std::string name () const override
 
- Public Member Functions inherited from protocols::filters::Filter
 Filter ()
 
 Filter (std::string const &)
 
 Filter (Filter 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 bool filter_provides_citation_info () const
 Does this filter provide information about how to cite it? More...
 
virtual utility::vector1
< basic::citation_manager::CitationCollectionCOP > 
provide_citation_info () const
 Provide the citation. More...
 
virtual bool filter_is_unpublished () const
 Does this filter indicate that it is unpublished (and, by extension, that the author should be included in publications resulting from it)? More...
 
virtual utility::vector1
< basic::citation_manager::UnpublishedModuleInfoCOP > 
provide_authorship_info_for_unpublished () const
 Provide a list of authors and their e-mail addresses, as strings. More...
 

Static Public Member Functions

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

Private Attributes

core::Real distance_threshold_
 
core::Size neighbor_cutoff_
 
bool bound_
 
core::Size resnum_
 
core::Size jump_
 

Additional Inherited Members

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

Constructor & Destructor Documentation

protocols::simple_filters::NonSequentialNeighborsFilter::NonSequentialNeighborsFilter ( )
protocols::simple_filters::NonSequentialNeighborsFilter::~NonSequentialNeighborsFilter ( )
overridedefault

Member Function Documentation

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

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

Implements protocols::filters::Filter.

References compute().

bool protocols::simple_filters::NonSequentialNeighborsFilter::bound ( ) const
inline
void protocols::simple_filters::NonSequentialNeighborsFilter::bound ( bool const  b)
inline
std::string protocols::simple_filters::NonSequentialNeighborsFilter::class_name ( )
static
filters::FilterOP protocols::simple_filters::NonSequentialNeighborsFilter::clone ( ) const
inlineoverridevirtual
core::Real protocols::simple_filters::NonSequentialNeighborsFilter::compute ( core::pose::Pose const &  pose) const
core::Real protocols::simple_filters::NonSequentialNeighborsFilter::distance_threshold ( ) const
inline
void protocols::simple_filters::NonSequentialNeighborsFilter::distance_threshold ( core::Real const  r)
inline

References distance_threshold_.

filters::FilterOP protocols::simple_filters::NonSequentialNeighborsFilter::fresh_instance ( ) const
inlineoverridevirtual
void protocols::simple_filters::NonSequentialNeighborsFilter::jump ( core::Size const  j)
inline
core::Size protocols::simple_filters::NonSequentialNeighborsFilter::jump ( ) const
inline

References jump_.

Referenced by compute(), and parse_my_tag().

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

Reimplemented from protocols::filters::Filter.

References class_name().

core::Size protocols::simple_filters::NonSequentialNeighborsFilter::neighbor_cutoff ( ) const
inline
void protocols::simple_filters::NonSequentialNeighborsFilter::neighbor_cutoff ( core::Size const  n)
inline

References neighbor_cutoff_.

void protocols::simple_filters::NonSequentialNeighborsFilter::parse_my_tag ( utility::tag::TagCOP  ,
basic::datacache::DataMap &   
)
overridevirtual

Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing.

Reimplemented from protocols::filters::Filter.

References bound(), distance_threshold(), jump(), neighbor_cutoff(), resnum(), and protocols::simple_filters::TR().

void protocols::simple_filters::NonSequentialNeighborsFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::simple_filters::NonSequentialNeighborsFilter::report ( std::ostream &  out,
core::pose::Pose const &  pose 
) const
overridevirtual

Reimplemented from protocols::filters::Filter.

References compute().

core::Real protocols::simple_filters::NonSequentialNeighborsFilter::report_sm ( core::pose::Pose const &  ) const
overridevirtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References compute().

core::Size protocols::simple_filters::NonSequentialNeighborsFilter::residue_neighbors ( core::pose::Pose const &  pose,
core::Size const  resi 
) const
core::Size protocols::simple_filters::NonSequentialNeighborsFilter::resnum ( ) const
inline
void protocols::simple_filters::NonSequentialNeighborsFilter::resnum ( core::Size const  s)
inline

References resnum_.

Member Data Documentation

bool protocols::simple_filters::NonSequentialNeighborsFilter::bound_
private

Referenced by bound().

core::Real protocols::simple_filters::NonSequentialNeighborsFilter::distance_threshold_
private

Referenced by distance_threshold().

core::Size protocols::simple_filters::NonSequentialNeighborsFilter::jump_
private

Referenced by jump().

core::Size protocols::simple_filters::NonSequentialNeighborsFilter::neighbor_cutoff_
private

Referenced by neighbor_cutoff().

core::Size protocols::simple_filters::NonSequentialNeighborsFilter::resnum_
private

Referenced by resnum().


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