Rosetta Core  2014.35
Public Member Functions | Private Attributes | List of all members
core::conformation::membrane::Span Class Reference

#include <Span.hh>

Public Member Functions

 Span ()
 Default Constructor. More...
 
 Span (Size start, Size end)
 Custom Constructor - Construct new span. More...
 
 ~Span ()
 Copy Consturctor. More...
 
Size start ()
 Get start position. More...
 
Size end ()
 Get end position. More...
 
void shift (Size offset)
 Shift by offset. More...
 
void show ()
 Show This Span. More...
 
bool is_valid ()
 Check that this Span is Valid. More...
 
void not_valid ()
 

Private Attributes

Size start_
 
Size end_
 

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 ( Size  start,
Size  end 
)

Custom Constructor - Construct new span.

Constructor from start and end

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

Copy Consturctor.

Destructor.

Make a deep copy of this object Assignment OperatorDestructor

Member Function Documentation

Size core::conformation::membrane::Span::end ( )

Get end position.

Get the end position of a transmembrane span

References end_.

bool core::conformation::membrane::Span::is_valid ( )

Check that this Span is Valid.

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

References end_, length, start_, and core::conformation::TR.

Referenced by not_valid().

void core::conformation::membrane::Span::not_valid ( )

References is_valid().

Referenced by shift().

void core::conformation::membrane::Span::shift ( 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 ( )

Show This Span.

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

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

Size core::conformation::membrane::Span::start ( )

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_.

Member Data Documentation

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

Referenced by end(), is_valid(), shift(), and show().

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

Referenced by is_valid(), shift(), show(), and start().


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