protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet Class Reference

#include <LegacyRequirementSet.hh>

Inheritance diagram for protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet:

Public Types
typedef std::map< core::Size, utility::vector1 < LegacyIntraSegmentRequirementOP > >	LegacyIntraSegmentRequirementsMap

Public Member Functions
	LegacyRequirementSet ()
core::Size	min_segments () const
void	min_segments (core::Size min_segments)
core::Size	max_segments () const
void	max_segments (core::Size max_segments)
void	add_requirement (LegacyGlobalRequirementOP requirement)
void	add_requirement (core::Size index, LegacyIntraSegmentRequirementOP requirement)
bool	satisfies (AssemblyCOP assembly) const
	Evaluated if this Assembly satisfies all contained AssemblyRequirements. More...
bool	violates (AssemblyCOP assembly) const
	Evaluate if this Assembly violates any contained AssemblyRequirements. More...
bool	can_be_added_to (AssemblyCOP assembly) const
	Check all LegacyGlobal requirements to see if we can add more edges to this Assembly. More...
core::Size	get_max_segments () const
void	show (std::ostream &out) const

Private Attributes
core::Size	min_segments_
core::Size	max_segments_
utility::vector1 < LegacyGlobalRequirementOP >	global_requirements_
LegacyIntraSegmentRequirementsMap	intra_segment_requirements_

Member Typedef Documentation

typedef std::map< core::Size, utility::vector1<LegacyIntraSegmentRequirementOP> > protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::LegacyIntraSegmentRequirementsMap

Constructor & Destructor Documentation

protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::LegacyRequirementSet

(

)

Member Function Documentation

void protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::add_requirement

(

LegacyGlobalRequirementOP

requirement

)

References global_requirements_.

void protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::add_requirement	(	core::Size	index,
		LegacyIntraSegmentRequirementOP	requirement
	)

References intra_segment_requirements_.

bool protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::can_be_added_to

(

AssemblyCOP

assembly

)

const

Check all LegacyGlobal requirements to see if we can add more edges to this Assembly.

References max_segments_.

core::Size protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::get_max_segments

(

)

const

References max_segments_.

core::Size protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::max_segments

(

)

const

References max_segments_.

Referenced by max_segments().

void protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::max_segments

(

core::Size

max_segments

)

References max_segments(), and max_segments_.

core::Size protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::min_segments

(

)

const

References min_segments_.

Referenced by min_segments().

void protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::min_segments

(

core::Size

min_segments

)

References min_segments(), and min_segments_.

bool protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::satisfies

(

AssemblyCOP

assembly

)

const

Evaluated if this Assembly satisfies all contained AssemblyRequirements.

References global_requirements_, intra_segment_requirements_, max_segments_, min_segments_, and protocols::legacy_sewing::sampling::requirements::TR().

void protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::show

(

std::ostream &

out

)

const

References global_requirements_, and intra_segment_requirements_.

bool protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::violates

(

AssemblyCOP

assembly

)

const

Evaluate if this Assembly violates any contained AssemblyRequirements.

This function should return true if any of the requirements contained in this set are guaranteed to fail in the case of future edge additions. This is implemented by considering a 'hypothetical' assembly in which segments which do not yet exist auto-pass all requirements.

References global_requirements_, intra_segment_requirements_, max_segments_, and protocols::legacy_sewing::sampling::requirements::TR().

Member Data Documentation

utility::vector1<LegacyGlobalRequirementOP> protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::global_requirements_

private

Referenced by add_requirement(), satisfies(), show(), and violates().

LegacyIntraSegmentRequirementsMap protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::intra_segment_requirements_

private

Referenced by add_requirement(), satisfies(), show(), and violates().

core::Size protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::max_segments_

private

Referenced by can_be_added_to(), get_max_segments(), max_segments(), satisfies(), and violates().

core::Size protocols::legacy_sewing::sampling::requirements::LegacyRequirementSet::min_segments_

private

Referenced by min_segments(), and satisfies().

---

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

• src/protocols/legacy_sewing/sampling/requirements/LegacyRequirementSet.hh
• src/protocols/legacy_sewing/sampling/requirements/LegacyRequirementSet.cc