Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Attributes | List of all members
protocols::filters::VectorPoseFilter Class Referenceabstract

Designates a filter that can be passed multiple poses by the VectorPoseJobDistributor Any filters deriving from this subclass can then act on all of the input poses simultaneously Only accessible through recon application. More...

#include <VectorPoseFilter.hh>

Inheritance diagram for protocols::filters::VectorPoseFilter:
Inheritance graph
[legend]

Public Member Functions

 VectorPoseFilter ()
 Constructor. More...
 
 ~VectorPoseFilter () override
 
 VectorPoseFilter (std::string const &name)
 
 VectorPoseFilter (VectorPoseFilter const &other)
 
bool apply (core::pose::Pose const &pose) const override=0
 Returns true if the given pose passes the filter, false otherwise. More...
 
virtual bool apply_mpi (core::pose::Pose const &pose) const =0
 Apply function to run under MPI. More...
 
void set_poses (utility::vector1< core::pose::PoseOP > const &poses)
 Set the vector of poses for the mover to act upon. More...
 
- Public Member Functions inherited from protocols::filters::Filter
 Filter ()
 
 Filter (std::string const &)
 
 Filter (Filter 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 void parse_my_tag (utility::tag::TagCOP, basic::datacache::DataMap &)
 Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing. More...
 
virtual FilterOP clone () const =0
 
virtual FilterOP fresh_instance () const =0
 
virtual core::Real score (core::pose::Pose &pose)
 
virtual std::string name () const
 
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...
 

Protected Attributes

utility::vector1
< core::pose::PoseOP
poses_
 
- Protected Attributes inherited from protocols::filters::Filter
std::string scorename_
 

Detailed Description

Designates a filter that can be passed multiple poses by the VectorPoseJobDistributor Any filters deriving from this subclass can then act on all of the input poses simultaneously Only accessible through recon application.

Constructor & Destructor Documentation

protocols::filters::VectorPoseFilter::VectorPoseFilter ( )

Constructor.

protocols::filters::VectorPoseFilter::~VectorPoseFilter ( )
override
protocols::filters::VectorPoseFilter::VectorPoseFilter ( std::string const &  name)
protocols::filters::VectorPoseFilter::VectorPoseFilter ( VectorPoseFilter const &  other)

Member Function Documentation

bool protocols::filters::VectorPoseFilter::apply ( core::pose::Pose const &  pose) const
overridepure virtual

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

Implements protocols::filters::Filter.

Implemented in protocols::recon_design::FitnessFilter.

virtual bool protocols::filters::VectorPoseFilter::apply_mpi ( core::pose::Pose const &  pose) const
pure virtual
void protocols::filters::VectorPoseFilter::set_poses ( utility::vector1< core::pose::PoseOP > const &  poses)

Set the vector of poses for the mover to act upon.

References poses_.

Referenced by protocols::jd2::VectorPoseJobDistributor::apply_parsed_protocol_serial().

Member Data Documentation

utility::vector1< core::pose::PoseOP > protocols::filters::VectorPoseFilter::poses_
protected

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