#include <EmbeddingDef.hh>

Inheritance diagram for protocols::membrane::geometry::EmbeddingDef:

Public Member Functions
	EmbeddingDef ()
	Default Constructor. More...

	EmbeddingDef (core::Vector const center, core::Vector const normal)
	Standard Constructor. More...

	EmbeddingDef (core::pose::Pose const &pose, core::Size const start, core::Size const end, bool pos_z=false)
	Constructor from pose, two residue numbers, and bool if in positive z-direction. More...

	EmbeddingDef (EmbeddingDef const &src)
	Copy Constructor. More...

EmbeddingDef &	operator= (EmbeddingDef const &src)
	Assignment Operator. More...

	~EmbeddingDef ()
	Destructor. More...

virtual void	show (std::ostream &output=std::cout) const
	Standard Rosetta Show Method for Debugging. More...

void	check_range () const
	Check reasonable range of vectors in embedding object. More...

core::Vector	normal () const
	Access Normal Param. More...

core::Vector	center () const
	Access center param. More...

void	invert ()
	Invert normal. More...

void	translate_by (EmbeddingDef const &translation)
	Translate by center and normal. More...

void	set_center (core::Vector center)
	Set Center Param. More...

void	set_normal (core::Vector normal)
	Set Normal Param. More...

bool	equals (EmbeddingDef const &other) const
	Equals method. More...

void	from_span (core::pose::Pose const &pose, core::Size const start, core::Size const end)
	From span. More...

void	from_span_positive_z (core::pose::Pose const &pose, core::Size const start, core::Size const end)
	From span. More...

Private Attributes
core::Vector	center_

core::Vector	normal_

Detailed Description

Embedding Setup Helper Class.

Constructor & Destructor Documentation

protocols::membrane::geometry::EmbeddingDef::EmbeddingDef ( )

Default Constructor.

protocols::membrane::geometry::EmbeddingDef::EmbeddingDef	(	core::Vector const	center,
		core::Vector const	normal
	)

Standard Constructor.

protocols::membrane::geometry::EmbeddingDef::EmbeddingDef	(	core::pose::Pose const &	pose,
		core::Size const	start,
		core::Size const	end,
		bool	pos_z = `false`
	)

Constructor from pose, two residue numbers, and bool if in positive z-direction.

References from_span(), and from_span_positive_z().

protocols::membrane::geometry::EmbeddingDef::EmbeddingDef ( EmbeddingDef const & src )

Copy Constructor.

protocols::membrane::geometry::EmbeddingDef::~EmbeddingDef ( )

Destructor.

Member Function Documentation

core::Vector protocols::membrane::geometry::EmbeddingDef::center ( ) const

Access center param.

References center_.

Referenced by protocols::docking::DockingSlideIntoContact::apply(), equals(), from_span(), from_span_positive_z(), set_center(), and translate_by().

void protocols::membrane::geometry::EmbeddingDef::check_range ( ) const

Check reasonable range of vectors in embedding object.

References center_, protocols::membrane::check_vector(), and normal_.

Referenced by set_center(), set_normal(), and translate_by().

bool protocols::membrane::geometry::EmbeddingDef::equals ( EmbeddingDef const & other ) const

Equals method.

Check Object Equality.

References center(), center_, normal(), and normal_.

void protocols::membrane::geometry::EmbeddingDef::from_span	(	core::pose::Pose const &	pose,
		core::Size const	start,
		core::Size const	end
	)

From span.

Embedding object from span.

Takes the CA coords of two residues and calculates center and normal from this.

References core::conformation::Residue::atom(), center(), center_, normal(), normal_, core::pose::Pose::residue(), protocols::TR(), and core::conformation::Atom::xyz().

Referenced by EmbeddingDef().

void protocols::membrane::geometry::EmbeddingDef::from_span_positive_z	(	core::pose::Pose const &	pose,
		core::Size const	start,
		core::Size const	end
	)

From span.

Embedding object from span.

Takes the CA coords of two residues and calculates center and normal from this. Normal always shows in positive z-direction!

References core::conformation::Residue::atom(), center(), center_, normal(), normal_, core::pose::Pose::residue(), protocols::TR(), and core::conformation::Atom::xyz().

Referenced by EmbeddingDef().

void protocols::membrane::geometry::EmbeddingDef::invert ( )

Invert normal.

References normal_.

core::Vector protocols::membrane::geometry::EmbeddingDef::normal ( ) const

Access Normal Param.

References normal_.

Referenced by equals(), from_span(), from_span_positive_z(), set_normal(), and translate_by().

EmbeddingDef & protocols::membrane::geometry::EmbeddingDef::operator= ( EmbeddingDef const & src )

Assignment Operator.

References center_, and normal_.

void protocols::membrane::geometry::EmbeddingDef::set_center ( core::Vector center )

Set Center Param.

Set New Center.

References center(), center_, and check_range().

void protocols::membrane::geometry::EmbeddingDef::set_normal ( core::Vector normal )

Set Normal Param.

Set New Normal.

References check_range(), normal(), and normal_.

void protocols::membrane::geometry::EmbeddingDef::show ( std::ostream & output = std::cout ) const

virtual

Standard Rosetta Show Method for Debugging.

References center_, normal_, and protocols::TR().

void protocols::membrane::geometry::EmbeddingDef::translate_by ( EmbeddingDef const & translation )

Translate by center and normal.

References center(), center_, check_range(), normal(), and normal_.

Member Data Documentation

core::Vector protocols::membrane::geometry::EmbeddingDef::center_

private

Referenced by center(), check_range(), equals(), from_span(), from_span_positive_z(), operator=(), set_center(), show(), and translate_by().

core::Vector protocols::membrane::geometry::EmbeddingDef::normal_

private

Referenced by check_range(), equals(), from_span(), from_span_positive_z(), invert(), normal(), operator=(), set_normal(), show(), and translate_by().

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

src/protocols/membrane/geometry/EmbeddingDef.hh
src/protocols/membrane/geometry/EmbeddingDef.cc

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation