Rosetta
Public Types | Public Member Functions | Private Attributes | Friends | List of all members
protocols::fldsgn::topology::HSSTriplet Class Reference

#include <HSSTriplet.hh>

Inheritance diagram for protocols::fldsgn::topology::HSSTriplet:
Inheritance graph
[legend]

Public Types

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

Public Member Functions

 HSSTriplet ()
 default constructor More...
 
 HSSTriplet (core::Size const h, core::Size const s1, core::Size const s2)
 @Brief value constructor More...
 
 HSSTriplet (String const &hss)
 value constructor More...
 
 ~HSSTriplet () override
 default destructor More...
 
 HSSTriplet (HSSTriplet const &hss)
 copy constructor More...
 
bool operator== (HSSTriplet const &rval) const
 operator == More...
 
core::Size helix () const
 
core::Size strand1 () const
 
core::Size strand2 () const
 
Real hsheet_dist () const
 reutrn distance between sheet ( defined by the 2 strands ) and helix More...
 
Real hs_angle () const
 return distance between sheet ( defined by the 2 strands ) and helix More...
 
Real hs1_dist () const
 distance between mid helix and midpoint of 1st strand More...
 
Real hs2_dist () const
 distance between mid helix and midpoint of 2nd strand More...
 
Real ss_dist () const
 distance between midpoints of strands More...
 
String ss_orient () const
 orientation between strands More...
 
String hs1_orient () const
 orientation between helix and 1st strand More...
 
String hs2_orient () const
 orientation between helix and 2nd strand More...
 
bool left_handed () const
 hsstriplet is left handed or not More...
 
bool geometry_is_initialized () const
 geometry is initialized or not More...
 
void calc_geometry (SS_Info2_COP const ssinfo)
 calc geometry More...
 

Private Attributes

core::Size helix_
 helix of hsstriplet More...
 
core::Size strand1_
 1st strand of hsstriplet More...
 
core::Size strand2_
 2nd strand of hsstriplet More...
 
Real hsheet_dist_
 distance between sheet ( defined by the 2 strands ) and helix More...
 
Real hs_angle_
 distance between sheet ( defined by the 2 strands ) and helix More...
 
Real hs1_dist_
 distance between mid helix and midpoint of strand1 More...
 
Real hs2_dist_
 distance between mid helix and midpoint of strand2 More...
 
Real ss_dist_
 distance between midpoints of strands More...
 
String ss_orient_
 orientation between strands More...
 
String hs1_orient_
 orientation between helix and 1st strand More...
 
String hs2_orient_
 orientation between helix and 2nd strand More...
 
bool left_handed_
 hsstriplet is left-handed or not More...
 
bool geometry_is_initialized_
 geometry is initialized More...
 

Friends

std::ostream & operator<< (std::ostream &out, const HSSTriplet &s)
 IO Operator. More...
 

Member Typedef Documentation

◆ Real

◆ Size

◆ SS_Info2_COP

◆ String

◆ Vector

Constructor & Destructor Documentation

◆ HSSTriplet() [1/4]

protocols::fldsgn::topology::HSSTriplet::HSSTriplet ( )
inline

default constructor

◆ HSSTriplet() [2/4]

protocols::fldsgn::topology::HSSTriplet::HSSTriplet ( core::Size const  h,
core::Size const  s1,
core::Size const  s2 
)
inline

@Brief value constructor

◆ HSSTriplet() [3/4]

protocols::fldsgn::topology::HSSTriplet::HSSTriplet ( String const &  hss)

value constructor

@value constructor

References helix_, strand1_, and strand2_.

◆ ~HSSTriplet()

protocols::fldsgn::topology::HSSTriplet::~HSSTriplet ( )
overridedefault

default destructor

Auto-generated virtual destructor.

◆ HSSTriplet() [4/4]

protocols::fldsgn::topology::HSSTriplet::HSSTriplet ( HSSTriplet const &  hss)

copy constructor

@copy constructor

Member Function Documentation

◆ calc_geometry()

void protocols::fldsgn::topology::HSSTriplet::calc_geometry ( SS_Info2_COP const  ssinfo)

◆ geometry_is_initialized()

bool protocols::fldsgn::topology::HSSTriplet::geometry_is_initialized ( ) const
inline

geometry is initialized or not

References geometry_is_initialized_.

◆ helix()

core::Size protocols::fldsgn::topology::HSSTriplet::helix ( ) const
inline

◆ hs1_dist()

core::Real protocols::fldsgn::topology::HSSTriplet::hs1_dist ( ) const

distance between mid helix and midpoint of 1st strand

References hs1_dist_.

Referenced by protocols::fldsgn::filters::HSSTripletFilter::apply(), and protocols::fldsgn::filters::HSSTripletFilter::compute_dist().

◆ hs1_orient()

std::string protocols::fldsgn::topology::HSSTriplet::hs1_orient ( ) const

orientation between helix and 1st strand

References hs1_orient_.

◆ hs2_dist()

core::Real protocols::fldsgn::topology::HSSTriplet::hs2_dist ( ) const

distance between mid helix and midpoint of 2nd strand

References hs2_dist_.

Referenced by protocols::fldsgn::filters::HSSTripletFilter::apply(), and protocols::fldsgn::filters::HSSTripletFilter::compute_dist().

◆ hs2_orient()

std::string protocols::fldsgn::topology::HSSTriplet::hs2_orient ( ) const

orientation between helix and 2nd strand

References hs2_orient_.

◆ hs_angle()

core::Real protocols::fldsgn::topology::HSSTriplet::hs_angle ( ) const

return distance between sheet ( defined by the 2 strands ) and helix

References hs_angle_.

Referenced by protocols::fldsgn::filters::HSSTripletFilter::apply(), and protocols::fldsgn::filters::HSSTripletFilter::compute().

◆ hsheet_dist()

core::Real protocols::fldsgn::topology::HSSTriplet::hsheet_dist ( ) const

reutrn distance between sheet ( defined by the 2 strands ) and helix

References hsheet_dist_.

Referenced by protocols::fldsgn::filters::HSSTripletFilter::compute().

◆ left_handed()

bool protocols::fldsgn::topology::HSSTriplet::left_handed ( ) const

hsstriplet is left handed or not

orientation between helix and 2nd strand

References left_handed_.

Referenced by protocols::fldsgn::topology::BetaAlphaBetaMotif::calc_geometry().

◆ operator==()

bool protocols::fldsgn::topology::HSSTriplet::operator== ( HSSTriplet const &  rval) const
inline

operator ==

References helix_, strand1_, and strand2_.

◆ ss_dist()

core::Real protocols::fldsgn::topology::HSSTriplet::ss_dist ( ) const

distance between midpoints of strands

References ss_dist_.

◆ ss_orient()

std::string protocols::fldsgn::topology::HSSTriplet::ss_orient ( ) const

orientation between strands

References ss_orient_.

◆ strand1()

core::Size protocols::fldsgn::topology::HSSTriplet::strand1 ( ) const
inline

◆ strand2()

core::Size protocols::fldsgn::topology::HSSTriplet::strand2 ( ) const
inline

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  out,
const HSSTriplet s 
)
friend

IO Operator.

Member Data Documentation

◆ geometry_is_initialized_

bool protocols::fldsgn::topology::HSSTriplet::geometry_is_initialized_
private

geometry is initialized

Referenced by calc_geometry(), and geometry_is_initialized().

◆ helix_

core::Size protocols::fldsgn::topology::HSSTriplet::helix_
private

helix of hsstriplet

Referenced by helix(), HSSTriplet(), and operator==().

◆ hs1_dist_

Real protocols::fldsgn::topology::HSSTriplet::hs1_dist_
private

distance between mid helix and midpoint of strand1

Referenced by calc_geometry(), and hs1_dist().

◆ hs1_orient_

String protocols::fldsgn::topology::HSSTriplet::hs1_orient_
private

orientation between helix and 1st strand

Referenced by calc_geometry(), and hs1_orient().

◆ hs2_dist_

Real protocols::fldsgn::topology::HSSTriplet::hs2_dist_
private

distance between mid helix and midpoint of strand2

Referenced by calc_geometry(), and hs2_dist().

◆ hs2_orient_

String protocols::fldsgn::topology::HSSTriplet::hs2_orient_
private

orientation between helix and 2nd strand

Referenced by calc_geometry(), and hs2_orient().

◆ hs_angle_

Real protocols::fldsgn::topology::HSSTriplet::hs_angle_
private

distance between sheet ( defined by the 2 strands ) and helix

Referenced by calc_geometry(), and hs_angle().

◆ hsheet_dist_

Real protocols::fldsgn::topology::HSSTriplet::hsheet_dist_
private

distance between sheet ( defined by the 2 strands ) and helix

Referenced by calc_geometry(), and hsheet_dist().

◆ left_handed_

bool protocols::fldsgn::topology::HSSTriplet::left_handed_
private

hsstriplet is left-handed or not

Referenced by calc_geometry(), and left_handed().

◆ ss_dist_

Real protocols::fldsgn::topology::HSSTriplet::ss_dist_
private

distance between midpoints of strands

Referenced by calc_geometry(), and ss_dist().

◆ ss_orient_

String protocols::fldsgn::topology::HSSTriplet::ss_orient_
private

orientation between strands

Referenced by calc_geometry(), and ss_orient().

◆ strand1_

core::Size protocols::fldsgn::topology::HSSTriplet::strand1_
private

1st strand of hsstriplet

Referenced by HSSTriplet(), operator==(), and strand1().

◆ strand2_

core::Size protocols::fldsgn::topology::HSSTriplet::strand2_
private

2nd strand of hsstriplet

Referenced by HSSTriplet(), operator==(), and strand2().


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