core::conformation::membrane::Span Class Reference

#include <Span.hh>

Inheritance diagram for core::conformation::membrane::Span:

Public Member Functions
	Span ()
	Default Constructor. More...
	Span (core::Size start, core::Size end, Orientation orient=in)
	Custom Constructor - Construct new span. More...
	Span (Span const &src)
	Copy Consturctor. More...
Span &	operator= (Span const &src)
	Assignment Operator. More...
	~Span () override
	Destructor. More...
core::Size	start () const
	Get start position. More...
core::Size	end () const
	Get end position. More...
Orientation	orientation () const
	Get the orientation of the span. More...
void	orientation (Orientation orient_in)
	Set the orientation of the span. More...
core::Size	center () const
	Get residue closest to center. More...
void	shift (core::Size offset)
	Shift by offset. More...
void	show () const
	Show This Span. More...
bool	is_valid () const
	Check that this Span is Valid. More...
void	not_valid () const

Private Attributes
core::Size	start_
core::Size	end_
Orientation	orientation_

Constructor & Destructor Documentation

core::conformation::membrane::Span::Span

(

)

Default Constructor.

Constructors ///.

Construct a default span object representing a span from 1-1 this constructor should eventually be made private because it doesn't build a real thing

Default Constructor

Construct a default span object representing a span from 1-1 this constructor should eventually be made private because it doesn't build a real thing

core::conformation::membrane::Span::Span	(	core::Size	start,
		core::Size	end,
		Orientation	orient = in
	)

Custom Constructor - Construct new span.

Constructor from start and end

core::conformation::membrane::Span::Span

(

Span const &

src

)

Copy Consturctor.

Make a deep copy of this object

core::conformation::membrane::Span::~Span ( )

overridedefault

Destructor.

Member Function Documentation

core::Size core::conformation::membrane::Span::center

(

)

const

Get residue closest to center.

get residue closest to center

References end_, and start_.

core::Size core::conformation::membrane::Span::end

(

)

const

Get end position.

Get the end position of a transmembrane span

References end_.

Referenced by core::conformation::membrane::SpanningTopology::add_span(), and core::conformation::membrane::SpanningTopology::spanning().

bool core::conformation::membrane::Span::is_valid

(

)

const

Check that this Span is Valid.

Check that this span describes a consecutive transmembrane span of nonzero length.

References end_, start_, and core::conformation::TR().

Referenced by not_valid().

void core::conformation::membrane::Span::not_valid

(

)

const

References is_valid().

Referenced by shift().

Span & core::conformation::membrane::Span::operator=

(

Span const &

src

)

Assignment Operator.

Make a deep copy of this object

References end_, orientation_, and start_.

Orientation core::conformation::membrane::Span::orientation

(

)

const

Get the orientation of the span.

References orientation_.

void core::conformation::membrane::Span::orientation

(

Orientation

orient_in

)

Set the orientation of the span.

References orientation_.

void core::conformation::membrane::Span::shift

(

core::Size

offset

)

Shift by offset.

Shift the transmembrane span by a user-provided offset

References end_, not_valid(), and start_.

void core::conformation::membrane::Span::show

(

)

const

Show This Span.

Show the information in this span. TODO: Should override base method

References end_, start_, and core::conformation::TR().

core::Size core::conformation::membrane::Span::start

(

)

const

Get start position.

Accessors ///.

Get the Starting Position of a transmembrane span

Get start position

Get the Starting Position of a transmembrane span

References start_.

Referenced by core::conformation::membrane::SpanningTopology::add_span(), and core::conformation::membrane::SpanningTopology::spanning().

Member Data Documentation

core::Size core::conformation::membrane::Span::end_

private

Referenced by center(), end(), is_valid(), operator=(), shift(), and show().

Orientation core::conformation::membrane::Span::orientation_

private

Referenced by operator=(), and orientation().

core::Size core::conformation::membrane::Span::start_

private

Referenced by center(), is_valid(), operator=(), shift(), show(), and start().

---

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

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