Rosetta 3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
core::fragment::picking_old::vall::gen::LengthGen Class Reference

the default constant length fragment Vall ExtentGenerator More...

#include <LengthGen.hh>

Inheritance diagram for core::fragment::picking_old::vall::gen::LengthGen:
Inheritance graph
[legend]
Collaboration diagram for core::fragment::picking_old::vall::gen::LengthGen:
Collaboration graph
[legend]

Public Types

typedef Super::Size Size
 
typedef Super::Extent Extent
 typedef for ExtentGenerator concept More...
 
typedef Super::PageIterator PageIterator
 typedef for ExtentGenerator concept More...
 
typedef PageIterator VallResidueIterator
 
- Public Types inherited from core::fragment::picking_old::vall::gen::VallFragmentGen
typedef core::Size Size
 
typedef
core::fragment::picking_old::concepts::Extent
< VallSection::PageConstIterator
Extent
 typedef for ExtentGenerator concept More...
 
typedef Extent::PageIterator PageIterator
 typedef for ExtentGenerator concept More...
 
typedef PageIterator VallResidueIterator
 

Public Member Functions

 LengthGen ()
 default constructor More...
 
 LengthGen (Size const frag_size)
 fragment size constructor More...
 
 LengthGen (LengthGen const &rval)
 copy constructor More...
 
virtual ~LengthGen ()
 default destructor More...
 
LengthGenoperator= (LengthGen const &rval)
 copy assignment More...
 
virtual VallFragmentGenOP clone () const
 clone this object More...
 
virtual Extent operator() (VallResidueIterator extent_begin, VallResidueIterator section_end) const
 return the desired fragment extent w/requested fragment size More...
 
- Public Member Functions inherited from core::fragment::picking_old::vall::gen::VallFragmentGen
 VallFragmentGen ()
 default constructor More...
 
 VallFragmentGen (VallFragmentGen const &rval)
 copy constructor More...
 
virtual ~VallFragmentGen ()
 default destructor More...
 
VallFragmentGenoperator= (VallFragmentGen const &rval)
 copy assignment More...
 

Private Types

typedef VallFragmentGen Super
 

Private Attributes

Size frag_size_
 the size of desired fragment More...
 

Detailed Description

the default constant length fragment Vall ExtentGenerator

Remarks
assumes that Pages in the Book are stored in a container capable of returning a RandomAccessIterator, such as std::vector

Definition at line 35 of file LengthGen.hh.

Member Typedef Documentation

typedef for ExtentGenerator concept

Definition at line 54 of file LengthGen.hh.

typedef for ExtentGenerator concept

Definition at line 58 of file LengthGen.hh.

Definition at line 47 of file LengthGen.hh.

Definition at line 41 of file LengthGen.hh.

Definition at line 64 of file LengthGen.hh.

Constructor & Destructor Documentation

core::fragment::picking_old::vall::gen::LengthGen::LengthGen ( )

default constructor

Definition at line 29 of file LengthGen.cc.

Referenced by clone().

core::fragment::picking_old::vall::gen::LengthGen::LengthGen ( Size const  frag_size)

fragment size constructor

Parameters
[in]frag_sizethe desired length of the fragment

Definition at line 36 of file LengthGen.cc.

core::fragment::picking_old::vall::gen::LengthGen::LengthGen ( LengthGen const &  rval)

copy constructor

Definition at line 43 of file LengthGen.cc.

core::fragment::picking_old::vall::gen::LengthGen::~LengthGen ( )
virtual

default destructor

Definition at line 50 of file LengthGen.cc.

Member Function Documentation

VallFragmentGenOP core::fragment::picking_old::vall::gen::LengthGen::clone ( ) const
virtual

clone this object

Implements core::fragment::picking_old::vall::gen::VallFragmentGen.

Definition at line 65 of file LengthGen.cc.

References LengthGen().

LengthGen::Extent core::fragment::picking_old::vall::gen::LengthGen::operator() ( VallResidueIterator  extent_begin,
VallResidueIterator  section_end 
) const
virtual

return the desired fragment extent w/requested fragment size

Returns
valid (true) extent if the end of the extent does not go past the section_end, invalid (false) extent otherwise
Remarks
we assume VallResidueIterator is a type of RandomAccessIterator, such as those used in std::vector

Implements core::fragment::picking_old::vall::gen::VallFragmentGen.

Definition at line 75 of file LengthGen.cc.

References core::fragment::picking_old::concepts::Extent< PageIterator >::begin, core::fragment::picking_old::concepts::Extent< PageIterator >::end, frag_size_, and core::fragment::picking_old::concepts::Extent< PageIterator >::valid.

LengthGen & core::fragment::picking_old::vall::gen::LengthGen::operator= ( LengthGen const &  rval)

copy assignment

Definition at line 55 of file LengthGen.cc.

References frag_size_, and core::fragment::picking_old::vall::gen::VallFragmentGen::operator=().

Member Data Documentation

Size core::fragment::picking_old::vall::gen::LengthGen::frag_size_
private

the size of desired fragment

Definition at line 119 of file LengthGen.hh.

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


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