rosetta.protocols.sewing.sampling.requirements
index
(built-in)

Bindings for protocols::sewing::sampling::requirements namespace

 
Classes
       
builtins.object
GlobalRequirement
GlobalLengthRequirement
ResidueRetentionRequirement
GlobalRequirementCreator
GlobalLengthRequirementCreator
ResidueRetentionRequirementCreator
IntraSegmentRequirement
SegmentDsspRequirement
SegmentLengthRequirement
IntraSegmentRequirementCreator
SegmentDsspRequirementCreator
SegmentLengthRequirementCreator
RequirementFactory
RequirementSet

 
class GlobalLengthRequirement(GlobalRequirement)
    
Method resolution order:
GlobalLengthRequirement
GlobalRequirement
builtins.object

Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(handle) -> NoneType
 
2. __init__(self : handle, valid_dssp_codes : rosetta.std.set_std_string_std_less_std_string_std_allocator_std_string_t, min_length : int, max_length : int) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.protocols.sewing.sampling.requirements.GlobalLengthRequirement,  : rosetta.protocols.sewing.sampling.requirements.GlobalLengthRequirement) -> rosetta.protocols.sewing.sampling.requirements.GlobalLengthRequirement
satisfies(...) from builtins.PyCapsule
satisfies(self : rosetta.protocols.sewing.sampling.requirements.GlobalLengthRequirement, assembly : rosetta.protocols.sewing.Assembly) -> bool
 
Inverse of violated for this requirement
violates(...) from builtins.PyCapsule
violates(self : rosetta.protocols.sewing.sampling.requirements.GlobalLengthRequirement, assembly : rosetta.protocols.sewing.Assembly) -> bool
 
Has the Assembly removed required residues
for the specified model

Methods inherited from GlobalRequirement:
can_be_added_to(...) from builtins.PyCapsule
can_be_added_to(self : rosetta.protocols.sewing.sampling.requirements.GlobalRequirement,  : rosetta.protocols.sewing.Assembly) -> bool
 
Can we add more edges to the Assembly? Base class implementation
returns true, so only implement for requirements that require Assemblies
of a specific size

 
class GlobalLengthRequirementCreator(GlobalRequirementCreator)
    
Method resolution order:
GlobalLengthRequirementCreator
GlobalRequirementCreator
builtins.object

Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(handle) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.protocols.sewing.sampling.requirements.GlobalLengthRequirementCreator,  : rosetta.protocols.sewing.sampling.requirements.GlobalLengthRequirementCreator) -> rosetta.protocols.sewing.sampling.requirements.GlobalLengthRequirementCreator

Methods inherited from GlobalRequirementCreator:
create_requirement(...) from builtins.PyCapsule
create_requirement(rosetta.protocols.sewing.sampling.requirements.GlobalRequirementCreator) -> rosetta.protocols.sewing.sampling.requirements.GlobalRequirement
type_name(...) from builtins.PyCapsule
type_name(rosetta.protocols.sewing.sampling.requirements.GlobalRequirementCreator) -> str

 
class GlobalRequirement(builtins.object)
     Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.protocols.sewing.sampling.requirements.GlobalRequirement,  : rosetta.protocols.sewing.sampling.requirements.GlobalRequirement) -> rosetta.protocols.sewing.sampling.requirements.GlobalRequirement
can_be_added_to(...) from builtins.PyCapsule
can_be_added_to(self : rosetta.protocols.sewing.sampling.requirements.GlobalRequirement,  : rosetta.protocols.sewing.Assembly) -> bool
 
Can we add more edges to the Assembly? Base class implementation
returns true, so only implement for requirements that require Assemblies
of a specific size
satisfies(...) from builtins.PyCapsule
satisfies(self : rosetta.protocols.sewing.sampling.requirements.GlobalRequirement, assembly : rosetta.protocols.sewing.Assembly) -> bool
 
does the Assembly, as a whole, currently satisfy this requirement?
violates(...) from builtins.PyCapsule
violates(self : rosetta.protocols.sewing.sampling.requirements.GlobalRequirement, assembly : rosetta.protocols.sewing.Assembly) -> bool
 
does the Assembly violate this segment? Unlike satisfies, violates

 
class GlobalRequirementCreator(builtins.object)
    The Creator class is responsible for creating a particular
GlobalRequirement class.
 
  Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(rosetta.protocols.sewing.sampling.requirements.GlobalRequirementCreator) -> NoneType
 
2. __init__(rosetta.protocols.sewing.sampling.requirements.GlobalRequirementCreator, rosetta.protocols.sewing.sampling.requirements.GlobalRequirementCreator) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.protocols.sewing.sampling.requirements.GlobalRequirementCreator,  : rosetta.protocols.sewing.sampling.requirements.GlobalRequirementCreator) -> rosetta.protocols.sewing.sampling.requirements.GlobalRequirementCreator
create_requirement(...) from builtins.PyCapsule
create_requirement(rosetta.protocols.sewing.sampling.requirements.GlobalRequirementCreator) -> rosetta.protocols.sewing.sampling.requirements.GlobalRequirement
type_name(...) from builtins.PyCapsule
type_name(rosetta.protocols.sewing.sampling.requirements.GlobalRequirementCreator) -> str

 
class IntraSegmentRequirement(builtins.object)
     Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirement,  : rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirement) -> rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirement
satisfies(...) from builtins.PyCapsule
satisfies(self : rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirement, segment : rosetta.protocols.sewing.SewSegment) -> bool
 
does the segment satisfy this requirement?
violates(...) from builtins.PyCapsule
violates(self : rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirement, segment : rosetta.protocols.sewing.SewSegment) -> bool
 
does the segment violate this requirement?

 
class IntraSegmentRequirementCreator(builtins.object)
     Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirementCreator) -> NoneType
 
2. __init__(rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirementCreator, rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirementCreator) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirementCreator,  : rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirementCreator) -> rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirementCreator
create_requirement(...) from builtins.PyCapsule
create_requirement(rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirementCreator) -> rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirement
type_name(...) from builtins.PyCapsule
type_name(rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirementCreator) -> str

 
class RequirementFactory(builtins.object)
    Create Features Reporters
 
  Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
factory_register(...) from builtins.PyCapsule
factory_register(*args, **kwargs)
Overloaded function.
 
1. factory_register(self : rosetta.protocols.sewing.sampling.requirements.RequirementFactory, creator : rosetta.protocols.sewing.sampling.requirements.GlobalRequirementCreator) -> NoneType
 
2. factory_register(self : rosetta.protocols.sewing.sampling.requirements.RequirementFactory, creator : rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirementCreator) -> NoneType
get_global_requirement(...) from builtins.PyCapsule
get_global_requirement(self : rosetta.protocols.sewing.sampling.requirements.RequirementFactory, type_name : str) -> rosetta.protocols.sewing.sampling.requirements.GlobalRequirement
get_instance(...) from builtins.PyCapsule
get_instance() -> rosetta.protocols.sewing.sampling.requirements.RequirementFactory
get_intra_segment_requirement(...) from builtins.PyCapsule
get_intra_segment_requirement(self : rosetta.protocols.sewing.sampling.requirements.RequirementFactory, type_name : str) -> rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirement

 
class RequirementSet(builtins.object)
     Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(rosetta.protocols.sewing.sampling.requirements.RequirementSet) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
add_requirement(...) from builtins.PyCapsule
add_requirement(*args, **kwargs)
Overloaded function.
 
1. add_requirement(self : rosetta.protocols.sewing.sampling.requirements.RequirementSet, requirement : rosetta.protocols.sewing.sampling.requirements.GlobalRequirement) -> NoneType
 
2. add_requirement(self : rosetta.protocols.sewing.sampling.requirements.RequirementSet, index : int, requirement : rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirement) -> NoneType
assign(...) from builtins.PyCapsule
assign(self : rosetta.protocols.sewing.sampling.requirements.RequirementSet,  : rosetta.protocols.sewing.sampling.requirements.RequirementSet) -> rosetta.protocols.sewing.sampling.requirements.RequirementSet
can_be_added_to(...) from builtins.PyCapsule
can_be_added_to(self : rosetta.protocols.sewing.sampling.requirements.RequirementSet, assembly : rosetta.protocols.sewing.Assembly) -> bool
 
Check all Global requirements to see if we
can add more edges to this Assembly
get_max_segments(...) from builtins.PyCapsule
get_max_segments(rosetta.protocols.sewing.sampling.requirements.RequirementSet) -> int
max_segments(...) from builtins.PyCapsule
max_segments(*args, **kwargs)
Overloaded function.
 
1. max_segments(rosetta.protocols.sewing.sampling.requirements.RequirementSet) -> int
 
2. max_segments(self : rosetta.protocols.sewing.sampling.requirements.RequirementSet, max_segments : int) -> NoneType
min_segments(...) from builtins.PyCapsule
min_segments(*args, **kwargs)
Overloaded function.
 
1. min_segments(rosetta.protocols.sewing.sampling.requirements.RequirementSet) -> int
 
2. min_segments(self : rosetta.protocols.sewing.sampling.requirements.RequirementSet, min_segments : int) -> NoneType
satisfies(...) from builtins.PyCapsule
satisfies(self : rosetta.protocols.sewing.sampling.requirements.RequirementSet, assembly : rosetta.protocols.sewing.Assembly) -> bool
 
Evaluated if this Assembly satisfies all
contained AssemblyRequirements
violates(...) from builtins.PyCapsule
violates(self : rosetta.protocols.sewing.sampling.requirements.RequirementSet, assembly : rosetta.protocols.sewing.Assembly) -> bool
 
Evaluate if this Assembly violates any contained
AssemblyRequirements

 
class ResidueRetentionRequirement(GlobalRequirement)
    
Method resolution order:
ResidueRetentionRequirement
GlobalRequirement
builtins.object

Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(handle) -> NoneType
 
2. __init__(self : handle, model_id : int) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
add_resnum(...) from builtins.PyCapsule
add_resnum(self : rosetta.protocols.sewing.sampling.requirements.ResidueRetentionRequirement, resnum : int) -> NoneType
assign(...) from builtins.PyCapsule
assign(self : rosetta.protocols.sewing.sampling.requirements.ResidueRetentionRequirement,  : rosetta.protocols.sewing.sampling.requirements.ResidueRetentionRequirement) -> rosetta.protocols.sewing.sampling.requirements.ResidueRetentionRequirement
model_id(...) from builtins.PyCapsule
model_id(self : rosetta.protocols.sewing.sampling.requirements.ResidueRetentionRequirement, model_id : int) -> NoneType
required_resnums(...) from builtins.PyCapsule
required_resnums(self : rosetta.protocols.sewing.sampling.requirements.ResidueRetentionRequirement, required_resnums : rosetta.std.set_unsigned_long_std_less_unsigned_long_std_allocator_unsigned_long_t) -> NoneType
satisfies(...) from builtins.PyCapsule
satisfies(self : rosetta.protocols.sewing.sampling.requirements.ResidueRetentionRequirement, assembly : rosetta.protocols.sewing.Assembly) -> bool
 
Inverse of violated for this requirement
violates(...) from builtins.PyCapsule
violates(self : rosetta.protocols.sewing.sampling.requirements.ResidueRetentionRequirement, assembly : rosetta.protocols.sewing.Assembly) -> bool
 
Has the Assembly removed required residues
for the specified model

Methods inherited from GlobalRequirement:
can_be_added_to(...) from builtins.PyCapsule
can_be_added_to(self : rosetta.protocols.sewing.sampling.requirements.GlobalRequirement,  : rosetta.protocols.sewing.Assembly) -> bool
 
Can we add more edges to the Assembly? Base class implementation
returns true, so only implement for requirements that require Assemblies
of a specific size

 
class ResidueRetentionRequirementCreator(GlobalRequirementCreator)
    
Method resolution order:
ResidueRetentionRequirementCreator
GlobalRequirementCreator
builtins.object

Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(handle) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.protocols.sewing.sampling.requirements.ResidueRetentionRequirementCreator,  : rosetta.protocols.sewing.sampling.requirements.ResidueRetentionRequirementCreator) -> rosetta.protocols.sewing.sampling.requirements.ResidueRetentionRequirementCreator

Methods inherited from GlobalRequirementCreator:
create_requirement(...) from builtins.PyCapsule
create_requirement(rosetta.protocols.sewing.sampling.requirements.GlobalRequirementCreator) -> rosetta.protocols.sewing.sampling.requirements.GlobalRequirement
type_name(...) from builtins.PyCapsule
type_name(rosetta.protocols.sewing.sampling.requirements.GlobalRequirementCreator) -> str

 
class SegmentDsspRequirement(IntraSegmentRequirement)
    
Method resolution order:
SegmentDsspRequirement
IntraSegmentRequirement
builtins.object

Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(handle) -> NoneType
 
2. __init__(self : handle, valid_dssp_codes : rosetta.std.set_std_string_std_less_std_string_std_allocator_std_string_t) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.protocols.sewing.sampling.requirements.SegmentDsspRequirement,  : rosetta.protocols.sewing.sampling.requirements.SegmentDsspRequirement) -> rosetta.protocols.sewing.sampling.requirements.SegmentDsspRequirement
satisfies(...) from builtins.PyCapsule
satisfies(self : rosetta.protocols.sewing.sampling.requirements.SegmentDsspRequirement, segment : rosetta.protocols.sewing.SewSegment) -> bool
 
Does the segment have a valid DSSP code?
violates(...) from builtins.PyCapsule
violates(self : rosetta.protocols.sewing.sampling.requirements.SegmentDsspRequirement, segment : rosetta.protocols.sewing.SewSegment) -> bool
 
Does the segment have an invalid DSSP code?

 
class SegmentDsspRequirementCreator(IntraSegmentRequirementCreator)
    
Method resolution order:
SegmentDsspRequirementCreator
IntraSegmentRequirementCreator
builtins.object

Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(handle) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.protocols.sewing.sampling.requirements.SegmentDsspRequirementCreator,  : rosetta.protocols.sewing.sampling.requirements.SegmentDsspRequirementCreator) -> rosetta.protocols.sewing.sampling.requirements.SegmentDsspRequirementCreator

Methods inherited from IntraSegmentRequirementCreator:
create_requirement(...) from builtins.PyCapsule
create_requirement(rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirementCreator) -> rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirement
type_name(...) from builtins.PyCapsule
type_name(rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirementCreator) -> str

 
class SegmentLengthRequirement(IntraSegmentRequirement)
    
Method resolution order:
SegmentLengthRequirement
IntraSegmentRequirement
builtins.object

Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(handle) -> NoneType
 
2. __init__(self : handle, min_length : int, max_length : int) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.protocols.sewing.sampling.requirements.SegmentLengthRequirement,  : rosetta.protocols.sewing.sampling.requirements.SegmentLengthRequirement) -> rosetta.protocols.sewing.sampling.requirements.SegmentLengthRequirement
satisfies(...) from builtins.PyCapsule
satisfies(self : rosetta.protocols.sewing.sampling.requirements.SegmentLengthRequirement, segment : rosetta.protocols.sewing.SewSegment) -> bool
 
Do we have the right number of residues in the SewSegment
violates(...) from builtins.PyCapsule
violates(self : rosetta.protocols.sewing.sampling.requirements.SegmentLengthRequirement, segment : rosetta.protocols.sewing.SewSegment) -> bool
 
Can we, through more edge additions, get the right number of residues?

 
class SegmentLengthRequirementCreator(IntraSegmentRequirementCreator)
    
Method resolution order:
SegmentLengthRequirementCreator
IntraSegmentRequirementCreator
builtins.object

Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(handle) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.protocols.sewing.sampling.requirements.SegmentLengthRequirementCreator,  : rosetta.protocols.sewing.sampling.requirements.SegmentLengthRequirementCreator) -> rosetta.protocols.sewing.sampling.requirements.SegmentLengthRequirementCreator

Methods inherited from IntraSegmentRequirementCreator:
create_requirement(...) from builtins.PyCapsule
create_requirement(rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirementCreator) -> rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirement
type_name(...) from builtins.PyCapsule
type_name(rosetta.protocols.sewing.sampling.requirements.IntraSegmentRequirementCreator) -> str