Rosetta 3.4
Public Types | Public Member Functions | Friends
protocols::fldsgn::topology::StrandPairing Class Reference

#include <StrandPairing.hh>

Inheritance diagram for protocols::fldsgn::topology::StrandPairing:
Inheritance graph
[legend]
Collaboration diagram for protocols::fldsgn::topology::StrandPairing:
Collaboration graph
[legend]

List of all members.

Public Types

typedef std::string String
typedef core::Size Size
typedef core::Real Real
typedef
protocols::fldsgn::topology::SS_Info2_OP 
SS_Info2_OP
typedef
protocols::fldsgn::topology::SS_Info2_COP 
SS_Info2_COP

Public Member Functions

 StrandPairing ()
 default constructor
 StrandPairing (Size const s1, Size const s2, Size const b1, Size const b2, Size const p, Real const rs, char const o)
 value constructor
 StrandPairing (Size const s1, Size const s2, Real const rs, char const o)
 value constructor
 StrandPairing (String const &spair)
 copy constructor
 StrandPairing (StrandPairing const &sp)
 copy constructor
 ~StrandPairing ()
 default destructor
StrandPairingOP clone ()
 clone this object
Size s1 () const
 the strand number of the 1st strand in strand pairing
Size s2 () const
 the strand number of the 2nd strand in strand pairing
Size begin1 () const
 the residue number of the beginning of 1st strand
Size end1 () const
 the residue number of the end of 1st strand
Size begin2 () const
 the residue number of the beginning of 2nd strand
Size end2 () const
 the residue number of the end of 2nd strand
Real rgstr_shift () const
 the number of register shift between the strands
utility::vector1< Sizepleats1 () const
 the pleating at the begining of strand_pairing
utility::vector1< Sizepleats2 () const
 the pleating at the end of strand_pairing
char orient () const
 orientation, parallel or anti-parallel, of strand pairing
bool has_bulge () const
 whether the strand pairing have bulge or not
String name () const
 StrandPairing is descripbed as s1()-s2().orient().rgstr_shift() For example, 2-3.A.1 means 2nd and 3rd strands make anti-parallel strand_pairing with register shift 1.
Size residue_pair (Size const res)
 residue pair
bool elongate (Size const r1, Size const r2, Size const p1, Size const p2)
 elongate strand pairings
bool add_pair (Size const r1, Size const r2, char const orient, Real const rgstr)
Size size1 () const
 the length of 1st strand
Size size2 () const
 the length of 2nd strand
bool is_parallel () const
 is parallel
bool is_member (Size const res)
 whether input residue is included in this StrandPairinge or not
void redefine_begin_end (SS_Info2_COP const ss_info)
 reset begin1_, begin2_, and end1_, end2_ based on ssinfo

Friends

std::ostream & operator<< (std::ostream &out, const StrandPairing &sp)
 return strand pairing

Member Typedef Documentation


Constructor & Destructor Documentation

protocols::fldsgn::topology::StrandPairing::StrandPairing ( )

default constructor

Referenced by clone().

protocols::fldsgn::topology::StrandPairing::StrandPairing ( Size const  s1,
Size const  s2,
Size const  b1,
Size const  b2,
Size const  p,
Real const  rs,
char const  o 
)

value constructor

protocols::fldsgn::topology::StrandPairing::StrandPairing ( Size const  s1,
Size const  s2,
Real const  rs,
char const  o 
)

value constructor

protocols::fldsgn::topology::StrandPairing::StrandPairing ( String const &  spair)

copy constructor

value constructor

protocols::fldsgn::topology::StrandPairing::StrandPairing ( StrandPairing const &  sp)

copy constructor

protocols::fldsgn::topology::StrandPairing::~StrandPairing ( )

default destructor


Member Function Documentation

bool protocols::fldsgn::topology::StrandPairing::add_pair ( Size const  r1,
Size const  r2,
char const  orient,
Real const  rgstr 
)

References size1(), and size2().

Size protocols::fldsgn::topology::StrandPairing::begin1 ( ) const [inline]

the residue number of the beginning of 1st strand

Referenced by protocols::fldsgn::topology::operator<<().

Size protocols::fldsgn::topology::StrandPairing::begin2 ( ) const [inline]

the residue number of the beginning of 2nd strand

Referenced by protocols::fldsgn::topology::operator<<().

StrandPairingOP protocols::fldsgn::topology::StrandPairing::clone ( )

clone this object

References StrandPairing().

bool protocols::fldsgn::topology::StrandPairing::elongate ( Size const  r1,
Size const  r2,
Size const  p1,
Size const  p2 
)

elongate strand pairings

References size1(), and size2().

Referenced by redefine_begin_end().

Size protocols::fldsgn::topology::StrandPairing::end1 ( ) const [inline]

the residue number of the end of 1st strand

Referenced by protocols::fldsgn::topology::operator<<().

Size protocols::fldsgn::topology::StrandPairing::end2 ( ) const [inline]

the residue number of the end of 2nd strand

Referenced by protocols::fldsgn::topology::operator<<().

bool protocols::fldsgn::topology::StrandPairing::has_bulge ( ) const [inline]

whether the strand pairing have bulge or not

bool protocols::fldsgn::topology::StrandPairing::is_member ( Size const  res)

whether input residue is included in this StrandPairinge or not

bool protocols::fldsgn::topology::StrandPairing::is_parallel ( ) const

is parallel

return length of 2nd strand

Referenced by redefine_begin_end().

String protocols::fldsgn::topology::StrandPairing::name ( ) const [inline]

StrandPairing is descripbed as s1()-s2().orient().rgstr_shift() For example, 2-3.A.1 means 2nd and 3rd strands make anti-parallel strand_pairing with register shift 1.

Referenced by protocols::fldsgn::topology::StrandPairingSet::finalize(), protocols::fldsgn::topology::StrandPairingSet::name_wo_rgstr(), and protocols::fldsgn::topology::operator<<().

char protocols::fldsgn::topology::StrandPairing::orient ( ) const [inline]

orientation, parallel or anti-parallel, of strand pairing

utility::vector1< Size > protocols::fldsgn::topology::StrandPairing::pleats1 ( ) const [inline]

the pleating at the begining of strand_pairing

utility::vector1< Size > protocols::fldsgn::topology::StrandPairing::pleats2 ( ) const [inline]

the pleating at the end of strand_pairing

void protocols::fldsgn::topology::StrandPairing::redefine_begin_end ( SS_Info2_COP const  ss_info)

reset begin1_, begin2_, and end1_, end2_ based on ssinfo

reset begin1_, end1_, begin2_, end2_ based on ssinfo

References elongate(), is_parallel(), and protocols::fldsgn::TR().

Size protocols::fldsgn::topology::StrandPairing::residue_pair ( Size const  res)

residue pair

return residue pairing

Real protocols::fldsgn::topology::StrandPairing::rgstr_shift ( ) const [inline]

the number of register shift between the strands

Size protocols::fldsgn::topology::StrandPairing::s1 ( ) const [inline]

the strand number of the 1st strand in strand pairing

Referenced by protocols::fldsgn::topology::SheetSet::initialize().

Size protocols::fldsgn::topology::StrandPairing::s2 ( ) const [inline]

the strand number of the 2nd strand in strand pairing

Referenced by protocols::fldsgn::topology::StrandPairingSet::finalize(), and protocols::fldsgn::topology::SheetSet::initialize().

Size protocols::fldsgn::topology::StrandPairing::size1 ( ) const

the length of 1st strand

return length of 1st strand

Referenced by add_pair(), and elongate().

Size protocols::fldsgn::topology::StrandPairing::size2 ( ) const

the length of 2nd strand

return length of 2nd strand

Referenced by add_pair(), and elongate().


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out,
const StrandPairing sp 
) [friend]

return strand pairing


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines