core::conformation::membrane::MembranePlanes Class Reference

Store location of top and bottom marker residues for visualizing location of the membrane planes in a simulation. Accessible via membrane info. More...

#include <MembranePlanes.hh>

Public Member Functions
	MembranePlanes (utility::vector1< Size > top_points, utility::vector1< Size > bottom_points)
	Constructors ///. More...
	MembranePlanes (MembranePlanes const &src)
	Copy Constructor. More...
MembranePlanes &	operator= (MembranePlanes const &src)
	Assignment Operator. More...
	~MembranePlanes ()
	Destructor. More...
virtual void	show (std::ostream &output=std::cout) const
	Show Membrane Planes Info Data. More...
utility::vector1< Size >	top_points ()
	Data Access Methods ///. More...
utility::vector1< Size >	bottom_points ()
	Access point residues defining bottom membrane planes. More...

Private Member Functions
	MembranePlanes ()
	Default Constructor. More...

Private Attributes
utility::vector1< Size >	top_points_
utility::vector1< Size >	bottom_points_

Detailed Description

Store location of top and bottom marker residues for visualizing location of the membrane planes in a simulation. Accessible via membrane info.

Constructor & Destructor Documentation

core::conformation::membrane::MembranePlanes::MembranePlanes	(	utility::vector1< Size >	top_points,
		utility::vector1< Size >	bottom_points
	)

Constructors ///.

Custom Constructor

Create a MembranePlanes object detailing the positions of the upper and lower membrane planes

core::conformation::membrane::MembranePlanes::MembranePlanes

(

MembranePlanes const &

src

)

Copy Constructor.

Make a deep copy of this membrane planes object

core::conformation::membrane::MembranePlanes::~MembranePlanes

(

)

Destructor.

core::conformation::membrane::MembranePlanes::MembranePlanes ( )

private

Default Constructor.

Referenced by operator=().

Member Function Documentation

utility::vector1< Size > core::conformation::membrane::MembranePlanes::bottom_points

(

)

Access point residues defining bottom membrane planes.

References bottom_points_.

MembranePlanes & core::conformation::membrane::MembranePlanes::operator=

(

MembranePlanes const &

src

)

Assignment Operator.

Make a deep copy of this obejct overriding "="

References MembranePlanes().

void core::conformation::membrane::MembranePlanes::show ( std::ostream &  output = std::cout ) const

virtual

Show Membrane Planes Info Data.

References bottom_points_, utility::to_string(), and top_points_.

utility::vector1< Size > core::conformation::membrane::MembranePlanes::top_points

(

)

Data Access Methods ///.

Access point residues defining top membrane plane

References top_points_.

Member Data Documentation

utility::vector1< Size > core::conformation::membrane::MembranePlanes::bottom_points_

private

Referenced by bottom_points(), and show().

utility::vector1< Size > core::conformation::membrane::MembranePlanes::top_points_

private

Referenced by show(), and top_points().

---

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

• src/core/conformation/membrane/MembranePlanes.hh
• src/core/conformation/membrane/MembranePlanes.cc