protocols::fldsgn::topology::SheetSet Class Reference

#include <Sheet.hh>

Public Types
typedef core::Size	Size
typedef core::Real	Real
typedef utility::vector1< int >	VecInt
typedef utility::vector1< Size >	VecSize
typedef utility::vector1< Real >	VecReal
typedef protocols::fldsgn::topology::StrandPairingSet	StrandPairingSet
typedef protocols::fldsgn::topology::StrandPairingSetCOP	StrandPairingSetCOP
typedef protocols::fldsgn::topology::SS_Info2_COP	SS_Info2_COP

Public Member Functions
virtual	~SheetSet ()
	Automatically generated virtual destructor for class deriving directly from ReferenceCount. More...
	SheetSet ()
	default constructor More...
	SheetSet (Sheets const &sheets)
	value constructor More...
	SheetSet (SS_Info2_COP const ssinfo, StrandPairingSetCOP const spairset)
	value constructor More...
	SheetSet (SheetSet const &s)
	copy constructor More...
void	initialize (SS_Info2_COP const ssinfo, StrandPairingSetCOP const spairset)
void	push_back (SheetOP const sop)
void	clear ()
SheetOP	sheet (Size const s) const
Sheets	sheets () const
Size	num_sheets () const
	return number of sheets More...
Size	size () const
	return number of sheets More...
Size	which_sheet (Size const s) const
	return the id of sheet that a given strand belongs to. More...
StrandPairingSet	spairset () const
	return strand pairing set More...
void	calc_geometry (SS_Info2_COP const ssinfo)

Private Member Functions
void	set_sheet_number () const

Private Attributes
std::map< Size, Size >	sheet_number_
	sheet number given a strand More...
Sheets	sheets_
StrandPairingSet	spairset_

Friends
std::ostream &	operator<< (std::ostream &out, const SheetSet &s)
	return strand pairing More...

Member Typedef Documentation

typedef core::Real protocols::fldsgn::topology::SheetSet::Real

typedef core::Size protocols::fldsgn::topology::SheetSet::Size

typedef protocols::fldsgn::topology::SS_Info2_COP protocols::fldsgn::topology::SheetSet::SS_Info2_COP

typedef protocols::fldsgn::topology::StrandPairingSet protocols::fldsgn::topology::SheetSet::StrandPairingSet

typedef protocols::fldsgn::topology::StrandPairingSetCOP protocols::fldsgn::topology::SheetSet::StrandPairingSetCOP

typedef utility::vector1< int > protocols::fldsgn::topology::SheetSet::VecInt

typedef utility::vector1< Real > protocols::fldsgn::topology::SheetSet::VecReal

typedef utility::vector1< Size > protocols::fldsgn::topology::SheetSet::VecSize

Constructor & Destructor Documentation

protocols::fldsgn::topology::SheetSet::~SheetSet ( )

virtual

Automatically generated virtual destructor for class deriving directly from ReferenceCount.

Auto-generated virtual destructor

protocols::fldsgn::topology::SheetSet::SheetSet

(

)

default constructor

protocols::fldsgn::topology::SheetSet::SheetSet

(

Sheets const &

sheets

)

value constructor

protocols::fldsgn::topology::SheetSet::SheetSet	(	SS_Info2_COP const	ssinfo,
		StrandPairingSetCOP const	spairset
	)

value constructor

References initialize().

protocols::fldsgn::topology::SheetSet::SheetSet

(

SheetSet const &

s

)

copy constructor

Member Function Documentation

void protocols::fldsgn::topology::SheetSet::calc_geometry

(

SS_Info2_COP const

ssinfo

)

References sheets_.

void protocols::fldsgn::topology::SheetSet::clear

(

)

References sheets_.

void protocols::fldsgn::topology::SheetSet::initialize	(	SS_Info2_COP const	ssinfo,
		StrandPairingSetCOP const	spairset
	)

References protocols::fldsgn::topology::StrandPairingSet::finalized(), protocols::fldsgn::topology::StrandPairingSet::make_strand_neighbor_two(), protocols::fldsgn::topology::StrandPairingSet::neighbor_strands(), runtime_assert, s, s1, protocols::fldsgn::topology::StrandPairing::s1(), s2, protocols::fldsgn::topology::StrandPairing::s2(), set_sheet_number(), sheet_number_, sheets_, spairset_, protocols::fldsgn::topology::StrandPairingSet::strand_pairing(), protocols::fldsgn::topology::StrandPairingSet::strand_pairings(), and protocols::fldsgn::TR.

Referenced by SheetSet().

Size protocols::fldsgn::topology::SheetSet::num_sheets ( ) const

inline

return number of sheets

References sheets_.

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

void protocols::fldsgn::topology::SheetSet::push_back

(

SheetOP const

sop

)

References sheets_.

void protocols::fldsgn::topology::SheetSet::set_sheet_number ( ) const

private

References protocols::forge::methods::order(), sheet(), sheet_number_, and sheets_.

Referenced by initialize().

SheetOP protocols::fldsgn::topology::SheetSet::sheet

(

Size const

s

)

const

References runtime_assert, and sheets_.

Referenced by protocols::fldsgn::topology::operator<<(), and set_sheet_number().

Sheets protocols::fldsgn::topology::SheetSet::sheets ( ) const

inline

References sheets_.

Size protocols::fldsgn::topology::SheetSet::size ( ) const

inline

return number of sheets

References sheets_.

SheetSet::StrandPairingSet protocols::fldsgn::topology::SheetSet::spairset

(

)

const

return strand pairing set

References spairset_.

Size protocols::fldsgn::topology::SheetSet::which_sheet

(

Size const

s

)

const

return the id of sheet that a given strand belongs to.

return a sheet number given a strand number

References sheet_number_.

Friends And Related Function Documentation

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

friend

return strand pairing

Member Data Documentation

std::map< Size, Size > protocols::fldsgn::topology::SheetSet::sheet_number_

mutableprivate

sheet number given a strand

Referenced by initialize(), set_sheet_number(), and which_sheet().

Sheets protocols::fldsgn::topology::SheetSet::sheets_

private

Referenced by calc_geometry(), clear(), initialize(), num_sheets(), push_back(), set_sheet_number(), sheet(), sheets(), and size().

StrandPairingSet protocols::fldsgn::topology::SheetSet::spairset_

private

Referenced by initialize(), and spairset().

---

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

• src/protocols/fldsgn/topology/Sheet.hh
• src/protocols/fldsgn/topology/Sheet.cc