protocols::membrane::geometry::Embedding Class Reference

#include <Embedding.hh>

Inheritance diagram for protocols::membrane::geometry::Embedding:

Public Member Functions
	Embedding ()
	Detault Constructors. More...
	Embedding (EmbeddingDef const &embedding)
	Construction from single EmbeddingDef object. More...
	Embedding (core::conformation::membrane::SpanningTopology const &topology, core::Real radius)
	Constructs bogus object from topology. More...
	Embedding (core::conformation::membrane::SpanningTopology const &topology, core::pose::Pose const &pose)
	Custom Constructor - from topology & structure. More...
	Embedding (Embedding const &Embedding)
	Copy Constructor. More...
Embedding &	operator= (Embedding const &src)
	Assignment Operator. More...
	~Embedding () override
	Destructor. More...
virtual void	show () const
	Methods ///. More...
virtual void	show (std::ostream &out) const
void	invert ()
core::Size	nspans () const
EmbeddingDefOP	embedding (core::Size span_number) const
void	add_span_embedding (EmbeddingDefOP span_embed)
void	add_span_embedding (core::Vector center, core::Vector normal)
utility::vector1< EmbeddingDefOP >	embeddings () const
EmbeddingDefOP	total_embed () const
utility::vector1< EmbeddingDefOP >	from_spans (core::conformation::membrane::SpanningTopology const &topology, core::pose::Pose const &pose)
	HELPER METHODS ///. More...

Private Attributes
utility::vector1< EmbeddingDefOP >	embeddings_
EmbeddingDefOP	total_embed_

Constructor & Destructor Documentation

protocols::membrane::geometry::Embedding::Embedding

(

)

Detault Constructors.

Constructors ///.

Construct an empty embedding object

Constructs empty object

protocols::membrane::geometry::Embedding::Embedding

(

EmbeddingDef const &

embedding

)

Construction from single EmbeddingDef object.

References embeddings_, and total_embed_.

protocols::membrane::geometry::Embedding::Embedding	(	core::conformation::membrane::SpanningTopology const &	topology,
		core::Real	radius
	)

Constructs bogus object from topology.

References protocols::membrane::average_antiparallel_embeddings(), core::conformation::membrane::center, embeddings_, core::conformation::membrane::normal, core::conformation::membrane::SpanningTopology::nspans(), total_embed_, and protocols::TR().

protocols::membrane::geometry::Embedding::Embedding	(	core::conformation::membrane::SpanningTopology const &	topology,
		core::pose::Pose const &	pose
	)

Custom Constructor - from topology & structure.

Constructs from topology and pose.

Construct Embedding from Structure & Topology

References protocols::membrane::average_embeddings(), embeddings_, from_spans(), invert(), show(), total_embed_, and protocols::TR().

protocols::membrane::geometry::Embedding::Embedding

(

Embedding const &

Embedding

)

Copy Constructor.

protocols::membrane::geometry::Embedding::~Embedding ( )

overridedefault

Destructor.

Member Function Documentation

void protocols::membrane::geometry::Embedding::add_span_embedding

(

EmbeddingDefOP

span_embed

)

References protocols::membrane::average_embeddings(), embeddings_, invert(), and total_embed_.

Referenced by add_span_embedding().

void protocols::membrane::geometry::Embedding::add_span_embedding	(	core::Vector	center,
		core::Vector	normal
	)

References add_span_embedding(), and embedding().

EmbeddingDefOP protocols::membrane::geometry::Embedding::embedding

(

core::Size

span_number

)

const

References embeddings_.

Referenced by add_span_embedding(), and from_spans().

utility::vector1< EmbeddingDefOP > protocols::membrane::geometry::Embedding::embeddings

(

)

const

References embeddings_.

utility::vector1< EmbeddingDefOP > protocols::membrane::geometry::Embedding::from_spans	(	core::conformation::membrane::SpanningTopology const &	topology,
		core::pose::Pose const &	pose
	)

HELPER METHODS ///.

References core::conformation::membrane::center, embedding(), embeddings_, core::sequence::end, core::conformation::membrane::normal, core::conformation::membrane::SpanningTopology::nspans(), core::conformation::membrane::SpanningTopology::span(), protocols::loops::start, and protocols::TR().

Referenced by Embedding().

void protocols::membrane::geometry::Embedding::invert

(

)

References embeddings_, core::conformation::membrane::normal, and total_embed_.

Referenced by add_span_embedding(), and Embedding().

core::Size protocols::membrane::geometry::Embedding::nspans

(

)

const

References embeddings_.

Embedding & protocols::membrane::geometry::Embedding::operator=

(

Embedding const &

src

)

Assignment Operator.

References embeddings_, and total_embed_.

void protocols::membrane::geometry::Embedding::show ( ) const

virtual

Methods ///.

Referenced by Embedding().

void protocols::membrane::geometry::Embedding::show ( std::ostream &  out ) const

virtual

References embeddings_, total_embed_, and protocols::TR().

EmbeddingDefOP protocols::membrane::geometry::Embedding::total_embed

(

)

const

References total_embed_.

Member Data Documentation

utility::vector1< EmbeddingDefOP > protocols::membrane::geometry::Embedding::embeddings_

private

Referenced by add_span_embedding(), Embedding(), embedding(), embeddings(), from_spans(), invert(), nspans(), operator=(), and show().

EmbeddingDefOP protocols::membrane::geometry::Embedding::total_embed_

private

Referenced by add_span_embedding(), Embedding(), invert(), operator=(), show(), and total_embed().

---

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

• src/protocols/membrane/geometry/Embedding.hh
• src/protocols/membrane/geometry/Embedding.cc