protocols::fldsgn::topology::HSSTripletSet Class Reference

#include <HSSTriplet.hh>

Inheritance diagram for protocols::fldsgn::topology::HSSTripletSet:

Public Types
typedef core::Size	Size
typedef std::string	String
typedef std::map< TripletID, HSSTripletOP >	TripletMap

Public Member Functions
	HSSTripletSet ()
	default constructor More...
	HSSTripletSet (HSSTriplets const &s)
	value constructor More...
	HSSTripletSet (String const &s)
	value constructor More...
	HSSTripletSet (HSSTripletSet const &s)
	copy constructor More...
	~HSSTripletSet () override
	destructor More...
void	add_hsstriplets (HSSTriplets const &s)
	value constructor More...
void	push_back (HSSTripletOP const hssop)
	puch back data More...
void	clear ()
	clear data More...
HSSIterator	begin ()
	return an interator that points to the first HSSTripletOP More...
HSSIterator	end ()
	return an interator that points beyond the last HSSTripletOP More...
HSSConstIterator	begin () const
	return an const interator that points to the first HSSTripletOP More...
HSSConstIterator	end () const
	return an const interator that points beyond the last HSSTripletOP More...
Size	size () const
	return the size of vector of hss_triplets_ More...
HSSTripletOP	hss_triplet (Size const helix, Size const s1, Size const s2) const
	returns the Triplet containing given helix, strand1, and strand2 Exits and throws an error if the triplet isn't found More...
HSSTriplets	hss_triplets (Size const helix) const
	returns list of Triplets containing given helix More...
HSSTriplets const &	hss_triplets () const
	return all data More...

Private Attributes
HSSTriplets	hss_triplets_
TripletMap	helix2hss_

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

Member Typedef Documentation

typedef core::Size protocols::fldsgn::topology::HSSTripletSet::Size

typedef std::string protocols::fldsgn::topology::HSSTripletSet::String

typedef std::map< TripletID, HSSTripletOP > protocols::fldsgn::topology::HSSTripletSet::TripletMap

Constructor & Destructor Documentation

protocols::fldsgn::topology::HSSTripletSet::HSSTripletSet

(

)

default constructor

References clear().

protocols::fldsgn::topology::HSSTripletSet::HSSTripletSet

(

HSSTriplets const &

s

)

value constructor

References push_back().

protocols::fldsgn::topology::HSSTripletSet::HSSTripletSet

(

String const &

s

)

value constructor

References clear(), and push_back().

protocols::fldsgn::topology::HSSTripletSet::HSSTripletSet

(

HSSTripletSet const &

s

)

copy constructor

protocols::fldsgn::topology::HSSTripletSet::~HSSTripletSet ( )

overridedefault

destructor

Member Function Documentation

void protocols::fldsgn::topology::HSSTripletSet::add_hsstriplets

(

HSSTriplets const &

s

)

value constructor

References push_back().

HSSIterator protocols::fldsgn::topology::HSSTripletSet::begin ( )

inline

return an interator that points to the first HSSTripletOP

References hss_triplets_.

HSSConstIterator protocols::fldsgn::topology::HSSTripletSet::begin ( ) const

inline

return an const interator that points to the first HSSTripletOP

References hss_triplets_.

void protocols::fldsgn::topology::HSSTripletSet::clear

(

)

clear data

References helix2hss_, and hss_triplets_.

Referenced by HSSTripletSet().

HSSIterator protocols::fldsgn::topology::HSSTripletSet::end ( )

inline

return an interator that points beyond the last HSSTripletOP

References hss_triplets_.

HSSConstIterator protocols::fldsgn::topology::HSSTripletSet::end ( ) const

inline

return an const interator that points beyond the last HSSTripletOP

References hss_triplets_.

HSSTripletOP protocols::fldsgn::topology::HSSTripletSet::hss_triplet	(	Size const	helix,
		Size const	s1,
		Size const	s2
	)		const

returns the Triplet containing given helix, strand1, and strand2 Exits and throws an error if the triplet isn't found

References helix2hss_.

HSSTriplets protocols::fldsgn::topology::HSSTripletSet::hss_triplets

(

Size const

helix

)

const

returns list of Triplets containing given helix

References protocols::loops::loop_closure::ccd::helix.

Referenced by protocols::fldsgn::filters::HSSTripletFilter::add_hsstriplets(), protocols::fldsgn::filters::HSSTripletFilter::get_hss3s(), and protocols::fldsgn::topology::operator<<().

HSSTriplets const & protocols::fldsgn::topology::HSSTripletSet::hss_triplets

(

)

const

return all data

References hss_triplets_.

void protocols::fldsgn::topology::HSSTripletSet::push_back

(

HSSTripletOP const

hssop

)

puch back data

References helix2hss_, hss_triplets_, and protocols::fldsgn::TR().

Referenced by add_hsstriplets(), and HSSTripletSet().

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

inline

return the size of vector of hss_triplets_

References hss_triplets_.

Friends And Related Function Documentation

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

friend

IO Operator.

Member Data Documentation

TripletMap protocols::fldsgn::topology::HSSTripletSet::helix2hss_

private

Referenced by clear(), hss_triplet(), and push_back().

HSSTriplets protocols::fldsgn::topology::HSSTripletSet::hss_triplets_

private

Referenced by begin(), clear(), end(), hss_triplets(), push_back(), and size().

---

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

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