core::select::residue_selector::SliceResidueSelector Class Reference

The SliceResidueSelector allows slicing of the returned values of other residue selectors. More...

#include <SliceResidueSelector.hh>

Inheritance diagram for core::select::residue_selector::SliceResidueSelector:

Public Member Functions
	SliceResidueSelector ()
ResidueSelectorOP	clone () const override
	Clone operator. More...
	SliceResidueSelector (ResidueSelectorCOP const &selector, slice_enums::SliceMode slice_mode, int from, int to, slice_enums::OutOfBoundsMode oob_mode=slice_enums::ERROR)
	SliceResidueSelector (ResidueSelectorCOP selector, slice_enums::SliceMode slice_mode, utility::vector1< int > const &indices, slice_enums::OutOfBoundsMode oob_mode=slice_enums::ERROR)
ResidueSubset	apply (core::pose::Pose const &pose) const override
	Return a ResidueSubset indicating a selection of Residues from the input Pose; the ResidueSubset is an array of booleans where a value of "true" for position i indicates that residue i is a part of the selected subset – and a value of "false" would indicate that it is not. More...
void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &datamap) override
	Initialize any data members of this instance from an input tag and a DataMap object. More...
std::string	get_name () const override
void	set_residue_selector (ResidueSelectorCOP selector)
void	set_slice_mode (slice_enums::SliceMode slice_mode)
void	set_from (int from)
void	set_to (int to)
void	set_indices (utility::vector1< int > const &indices)
void	set_out_of_bounds_behavior (slice_enums::OutOfBoundsMode oob_mode)
utility::vector1 < basic::citation_manager::CitationCollectionCOP >	provide_citation_info () const override
	Provide the citation. More...
bool	residue_selector_is_unpublished () const override
	Does this residue selector indicate that it is unpublished (and, by extension, that the author should be included in publications resulting from it)? More...
utility::vector1 < basic::citation_manager::UnpublishedModuleInfoCOP >	provide_authorship_info_for_unpublished () const override
	Provide a list of authors and their e-mail addresses, as strings. More...
Public Member Functions inherited from core::select::residue_selector::ResidueSelector
	ResidueSelector ()
	Constructor. More...
	~ResidueSelector () override
	Destructor. More...
virtual bool	residue_selector_provides_citation_info () const
	Does this residue selector provide information about how to cite it? More...

Static Public Member Functions
static std::string	class_name ()
static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)

Private Member Functions
int	wrap_index (int index, int elements, utility::vector1< std::string > &error_messages) const
void	show_selection_logic (ResidueSubset const &initial, ResidueSubset const &final) const

Private Attributes
ResidueSelectorCOP	selector_
slice_enums::SliceMode	slice_mode_
int	from_
int	to_
utility::vector1< int >	indices_
slice_enums::OutOfBoundsMode	oob_mode_

Detailed Description

The SliceResidueSelector allows slicing of the returned values of other residue selectors.

Constructor & Destructor Documentation

core::select::residue_selector::SliceResidueSelector::SliceResidueSelector

(

)

core::select::residue_selector::SliceResidueSelector::SliceResidueSelector	(	ResidueSelectorCOP const &	selector,
		slice_enums::SliceMode	slice_mode,
		int	from,
		int	to,
		slice_enums::OutOfBoundsMode	oob_mode = slice_enums::ERROR
	)

core::select::residue_selector::SliceResidueSelector::SliceResidueSelector	(	ResidueSelectorCOP	selector,
		slice_enums::SliceMode	slice_mode,
		utility::vector1< int > const &	indices,
		slice_enums::OutOfBoundsMode	oob_mode = slice_enums::ERROR
	)

Member Function Documentation

ResidueSubset core::select::residue_selector::SliceResidueSelector::apply ( core::pose::Pose const &  pose ) const

overridevirtual

Return a ResidueSubset indicating a selection of Residues from the input Pose; the ResidueSubset is an array of booleans where a value of "true" for position i indicates that residue i is a part of the selected subset – and a value of "false" would indicate that it is not.

Implements core::select::residue_selector::ResidueSelector.

References core::select::residue_selector::slice_enums::CONTIGUOUS, core::select::residue_selector::slice_enums::ERROR, from_, core::select::get_residues_from_subset(), indices_, oob_mode_, selector_, show_selection_logic(), core::pose::Pose::size(), slice_mode_, core::select::residue_selector::slice_enums::SPARSE, to_, core::id::to_string(), core::select::residue_selector::TR(), core::select::residue_selector::slice_enums::WARN, and wrap_index().

std::string core::select::residue_selector::SliceResidueSelector::class_name ( )

static

Referenced by get_name(), core::select::residue_selector::SliceResidueSelectorCreator::keyname(), and provide_xml_schema().

ResidueSelectorOP core::select::residue_selector::SliceResidueSelector::clone ( ) const

overridevirtual

Clone operator.

Copy this object and return an owning pointer to the new object.

Implements core::select::residue_selector::ResidueSelector.

std::string core::select::residue_selector::SliceResidueSelector::get_name ( ) const

overridevirtual

Implements core::select::residue_selector::ResidueSelector.

References class_name().

void core::select::residue_selector::SliceResidueSelector::parse_my_tag ( utility::tag::TagCOP  tag, basic::datacache::DataMap &  datacache  )

overridevirtual

Initialize any data members of this instance from an input tag and a DataMap object.

Noop implementation in the base class in the case that a derived class has no need to read data from an input tag

Reimplemented from core::select::residue_selector::ResidueSelector.

References core::select::residue_selector::slice_enums::CONTIGUOUS, core::select::residue_selector::slice_enums::ERROR, core::select::residue_selector::slice_enums::IGNORE, set_from(), set_indices(), set_out_of_bounds_behavior(), set_residue_selector(), set_slice_mode(), set_to(), core::select::residue_selector::slice_enums::SPARSE, and core::select::residue_selector::slice_enums::WARN.

utility::vector1< basic::citation_manager::UnpublishedModuleInfoCOP > core::select::residue_selector::SliceResidueSelector::provide_authorship_info_for_unpublished ( ) const

overridevirtual

Provide a list of authors and their e-mail addresses, as strings.

Returns

This residue selector was created by Brian Coventry.

Author

Vikram K. Mulligan (vmull.nosp@m.igan.nosp@m.@flat.nosp@m.iron.nosp@m.insti.nosp@m.tute.nosp@m..org)

Reimplemented from core::select::residue_selector::ResidueSelector.

References selector_.

utility::vector1< basic::citation_manager::CitationCollectionCOP > core::select::residue_selector::SliceResidueSelector::provide_citation_info ( ) const

overridevirtual

Provide the citation.

Returns

A vector of citation collections. This allows the residue selector to provide citations for itself and for any modules that it invokes.

This residue selector has no citation. It may provide citations for the residue selector that it calls, though.

Author

Vikram K. Mulligan (vmull.nosp@m.igan.nosp@m.@flat.nosp@m.iron.nosp@m.insti.nosp@m.tute.nosp@m..org)

Reimplemented from core::select::residue_selector::ResidueSelector.

References selector_.

void core::select::residue_selector::SliceResidueSelector::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd )

static

References class_name(), and core::select::residue_selector::xsd_type_definition_w_attributes_and_optional_subselector().

Referenced by core::select::residue_selector::SliceResidueSelectorCreator::provide_xml_schema().

bool core::select::residue_selector::SliceResidueSelector::residue_selector_is_unpublished ( ) const

overridevirtual

Does this residue selector indicate that it is unpublished (and, by extension, that the author should be included in publications resulting from it)?

Returns true (this residue selector is unpublished).

Author

Vikram K. Mulligan (vmull.nosp@m.igan.nosp@m.@flat.nosp@m.iron.nosp@m.insti.nosp@m.tute.nosp@m..org)

Reimplemented from core::select::residue_selector::ResidueSelector.

void core::select::residue_selector::SliceResidueSelector::set_from

(

int

from

)

References from_.

Referenced by parse_my_tag().

void core::select::residue_selector::SliceResidueSelector::set_indices

(

utility::vector1< int > const &

indices

)

References indices_.

Referenced by parse_my_tag().

void core::select::residue_selector::SliceResidueSelector::set_out_of_bounds_behavior

(

slice_enums::OutOfBoundsMode

oob_mode

)

References oob_mode_.

Referenced by parse_my_tag().

void core::select::residue_selector::SliceResidueSelector::set_residue_selector

(

ResidueSelectorCOP

selector

)

References selector_.

Referenced by parse_my_tag().

void core::select::residue_selector::SliceResidueSelector::set_slice_mode

(

slice_enums::SliceMode

slice_mode

)

References slice_mode_.

Referenced by parse_my_tag().

void core::select::residue_selector::SliceResidueSelector::set_to

(

int

to

)

References to_.

Referenced by parse_my_tag().

void core::select::residue_selector::SliceResidueSelector::show_selection_logic ( ResidueSubset const &  initial, ResidueSubset const &  final  ) const

private

References protocols::kinmatch::str(), core::id::to_string(), and core::select::residue_selector::TR().

Referenced by apply().

int core::select::residue_selector::SliceResidueSelector::wrap_index ( int  index, int  elements, utility::vector1< std::string > &  error_messages  ) const

private

References core::select::residue_selector::slice_enums::ERROR, oob_mode_, core::id::to_string(), and core::select::residue_selector::slice_enums::WARN.

Referenced by apply().

Member Data Documentation

int core::select::residue_selector::SliceResidueSelector::from_

private

Referenced by apply(), and set_from().

utility::vector1< int > core::select::residue_selector::SliceResidueSelector::indices_

private

Referenced by apply(), and set_indices().

slice_enums::OutOfBoundsMode core::select::residue_selector::SliceResidueSelector::oob_mode_

private

Referenced by apply(), set_out_of_bounds_behavior(), and wrap_index().

ResidueSelectorCOP core::select::residue_selector::SliceResidueSelector::selector_

private

Referenced by apply(), provide_authorship_info_for_unpublished(), provide_citation_info(), and set_residue_selector().

slice_enums::SliceMode core::select::residue_selector::SliceResidueSelector::slice_mode_

private

Referenced by apply(), and set_slice_mode().

int core::select::residue_selector::SliceResidueSelector::to_

private

Referenced by apply(), and set_to().

---

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

• src/core/select/residue_selector/SliceResidueSelector.hh
• src/core/select/residue_selector/SliceResidueSelector.cc