Rosetta  2021.16
 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::pose_selectors::TopNByProperty Class Reference

Select top N poses by a specific pose property. More...

#include <BasicPoseSelectors.hh>

Inheritance diagram for protocols::pose_selectors::TopNByProperty:
Inheritance graph
[legend]

Public Member Functions

 TopNByProperty ()
 
 ~TopNByProperty () override=default
 
std::string get_name () const override
 Each derived selector must specify its name. More...
 
rosetta_scripts::PoseSelectorFlags get_flags () const override
 Report selector flags. More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data) override
 Called by PoseSelectorFactory when constructing new PoseSelectors. Takes care of the specific selector's parsing. More...
 
utility::vector1< boolselect_poses (utility::vector1< core::pose::PoseOP > poses) override
 Select poses from provided vector by applying the selection criteria parsed from Tag. More...
 

Static Public Member Functions

static void provide_xml_schema (utility::tag::XMLSchemaDefinition &)
 
static std::string name ()
 
- Static Public Member Functions inherited from protocols::rosetta_scripts::PoseSelector
static std::string name ()
 

Private Attributes

core::Size n_
 
protocols::rosetta_scripts::PosePropertyReporterOP reporter_
 
int order_
 

Additional Inherited Members

- Protected Member Functions inherited from protocols::rosetta_scripts::PoseSelector
 PoseSelector ()
 
 ~PoseSelector () override
 

Detailed Description

Select top N poses by a specific pose property.

Constructor & Destructor Documentation

protocols::pose_selectors::TopNByProperty::TopNByProperty ( )
protocols::pose_selectors::TopNByProperty::~TopNByProperty ( )
overridedefault

Member Function Documentation

rosetta_scripts::PoseSelectorFlags protocols::pose_selectors::TopNByProperty::get_flags ( ) const
inlineoverridevirtual
std::string protocols::pose_selectors::TopNByProperty::get_name ( ) const
inlineoverridevirtual

Each derived selector must specify its name.

Implements protocols::rosetta_scripts::PoseSelector.

References name().

Referenced by select_poses().

static std::string protocols::pose_selectors::TopNByProperty::name ( )
inlinestatic

Referenced by get_name(), and provide_xml_schema().

void protocols::pose_selectors::TopNByProperty::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &  data 
)
overridevirtual

Called by PoseSelectorFactory when constructing new PoseSelectors. Takes care of the specific selector's parsing.

Reimplemented from protocols::rosetta_scripts::PoseSelector.

References n_, protocols::forge::methods::order(), order_, reporter_, and protocols::TR().

void protocols::pose_selectors::TopNByProperty::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
utility::vector1< bool > protocols::pose_selectors::TopNByProperty::select_poses ( utility::vector1< core::pose::PoseOP poses)
overridevirtual

Select poses from provided vector by applying the selection criteria parsed from Tag.

Implements protocols::rosetta_scripts::PoseSelector.

References get_name(), n_, order_, reporter_, and protocols::TR().

Member Data Documentation

core::Size protocols::pose_selectors::TopNByProperty::n_
private

Referenced by parse_my_tag(), and select_poses().

int protocols::pose_selectors::TopNByProperty::order_
private

Referenced by parse_my_tag(), and select_poses().

protocols::rosetta_scripts::PosePropertyReporterOP protocols::pose_selectors::TopNByProperty::reporter_
private

Referenced by parse_my_tag(), and select_poses().


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