Rosetta
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
protocols::denovo_design::components::StrandPairing Class Reference

#include <SegmentPairing.hh>

Inheritance diagram for protocols::denovo_design::components::StrandPairing:
Inheritance graph
[legend]

Public Member Functions

 StrandPairing ()
 
 StrandPairing (SegmentName const &s1, SegmentName const &s2, StrandOrientation const &orient1, StrandOrientation const &orient2, RegisterShift const &shift)
 
 ~StrandPairing () override
 
SegmentPairingOP clone () const override
 
PairingType type () const override
 
std::string pairing_string (StructureData const &sd) const override
 
bool parallel () const
 
StrandOrientation orient1 () const
 
StrandOrientation orient2 () const
 
RegisterShift shift () const
 
void set_orient1 (StrandOrientation const orient)
 Sets the orientation for the first strand; used to determine whether the strands are parallel or antiparallel. More...
 
void set_orient2 (StrandOrientation const orient)
 Sets the orientation for the second strand; used to determine whether the strands are parallel or antiparallel. More...
 
void set_shift (RegisterShift const shift)
 Sets the register shift. More...
 
- Public Member Functions inherited from protocols::denovo_design::components::SegmentPairing
 SegmentPairing ()
 
 SegmentPairing (SegmentNames const &paired_segments)
 
 ~SegmentPairing () override
 
void parse_my_tag (utility::tag::Tag const &tag)
 
bool has_segment (std::string const &segment) const
 
SegmentNames const & segments () const
 
void set_segments (std::string const &segments_str)
 
void set_segments (SegmentNames const &segments)
 

Static Public Member Functions

static std::string class_name ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 
- Static Public Member Functions inherited from protocols::denovo_design::components::SegmentPairing
static std::string complex_type_name_for_pairing (std::string const &pairing_name)
 
static SegmentPairingOP create (std::string const &type_name)
 
static std::string get_strand_pairings (StructureData const &sd)
 Gets string for all strand pairings from a StructureData. More...
 
static std::string get_helix_pairings (StructureData const &sd)
 Gets string for all helix pairings from a StructureData. More...
 
static std::string get_hss_triplets (StructureData const &sd)
 Gets string for all helix-strand-strand triplets in a StructureData. More...
 
static ResiduePairs get_strand_residue_pairs (StructureData const &sd)
 Gets pairs of residues involved in strand pairing. More...
 

Protected Member Functions

void parse_tag (utility::tag::Tag const &tag) override
 
void to_xml (utility::tag::Tag &tag) const override
 

Private Member Functions

RegisterShift nobu_register_shift (StructureData const &sd, protocols::fldsgn::topology::Strand const &s1, protocols::fldsgn::topology::Strand const &s2, RegisterShift const nc_order_shift, StrandOrientation const &nc_order_orient) const
 

Private Attributes

StrandOrientation orient1_
 
StrandOrientation orient2_
 
RegisterShift shift_
 

Additional Inherited Members

- Public Types inherited from protocols::denovo_design::components::SegmentPairing
enum  PairingType { HELIX = 1 , STRAND = 2 , HELIX_SHEET = 3 , UNKNOWN }
 
- Static Public Attributes inherited from protocols::denovo_design::components::SegmentPairing
static std::string TAG_NAME = "Pairing"
 
- Static Protected Member Functions inherited from protocols::denovo_design::components::SegmentPairing
static void add_common_xml_elements (utility::tag::XMLSchemaDefinition &xsd, std::string const &class_name, std::string const &description, utility::tag::AttributeList &attlist)
 

Constructor & Destructor Documentation

◆ StrandPairing() [1/2]

protocols::denovo_design::components::StrandPairing::StrandPairing ( )

◆ StrandPairing() [2/2]

protocols::denovo_design::components::StrandPairing::StrandPairing ( SegmentName const &  s1,
SegmentName const &  s2,
StrandOrientation const &  orient1,
StrandOrientation const &  orient2,
RegisterShift const &  shift 
)

◆ ~StrandPairing()

protocols::denovo_design::components::StrandPairing::~StrandPairing ( )
inlineoverride

Member Function Documentation

◆ class_name()

static std::string protocols::denovo_design::components::StrandPairing::class_name ( )
inlinestatic

◆ clone()

SegmentPairingOP protocols::denovo_design::components::StrandPairing::clone ( ) const
overridevirtual

◆ nobu_register_shift()

RegisterShift protocols::denovo_design::components::StrandPairing::nobu_register_shift ( StructureData const &  sd,
protocols::fldsgn::topology::Strand const &  s1,
protocols::fldsgn::topology::Strand const &  s2,
RegisterShift const  nc_order_shift,
StrandOrientation const &  nc_order_orient 
) const
private

◆ orient1()

StrandOrientation protocols::denovo_design::components::StrandPairing::orient1 ( ) const

◆ orient2()

StrandOrientation protocols::denovo_design::components::StrandPairing::orient2 ( ) const

◆ pairing_string()

std::string protocols::denovo_design::components::StrandPairing::pairing_string ( StructureData const &  sd) const
overridevirtual

◆ parallel()

bool protocols::denovo_design::components::StrandPairing::parallel ( ) const

References orient1_, and orient2_.

Referenced by pairing_string().

◆ parse_tag()

void protocols::denovo_design::components::StrandPairing::parse_tag ( utility::tag::Tag const &  tag)
overrideprotectedvirtual

◆ provide_xml_schema()

void protocols::denovo_design::components::StrandPairing::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static

◆ set_orient1()

void protocols::denovo_design::components::StrandPairing::set_orient1 ( StrandOrientation const  orient)
inline

Sets the orientation for the first strand; used to determine whether the strands are parallel or antiparallel.

References orient1_.

Referenced by parse_tag().

◆ set_orient2()

void protocols::denovo_design::components::StrandPairing::set_orient2 ( StrandOrientation const  orient)
inline

Sets the orientation for the second strand; used to determine whether the strands are parallel or antiparallel.

References orient2_.

Referenced by parse_tag().

◆ set_shift()

void protocols::denovo_design::components::StrandPairing::set_shift ( RegisterShift const  shift)
inline

Sets the register shift.

References shift(), and shift_.

Referenced by parse_tag().

◆ shift()

RegisterShift protocols::denovo_design::components::StrandPairing::shift ( ) const

◆ to_xml()

void protocols::denovo_design::components::StrandPairing::to_xml ( utility::tag::Tag &  tag) const
overrideprotectedvirtual

◆ type()

PairingType protocols::denovo_design::components::StrandPairing::type ( ) const
inlineoverridevirtual

Member Data Documentation

◆ orient1_

StrandOrientation protocols::denovo_design::components::StrandPairing::orient1_
private

◆ orient2_

StrandOrientation protocols::denovo_design::components::StrandPairing::orient2_
private

◆ shift_

RegisterShift protocols::denovo_design::components::StrandPairing::shift_
private

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