the default constant length fragment Vall ExtentGenerator More...

#include <LengthGen.hh>

Inheritance diagram for core::fragment::picking_old::vall::gen::LengthGen:

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

	~LengthGen () override
	default destructor More...

LengthGen &	operator= (LengthGen const &rval)
	copy assignment More...

VallFragmentGenOP	clone () const override
	clone this object More...

Extent	operator() (VallResidueIterator extent_begin, VallResidueIterator section_end) const override
	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...

	~VallFragmentGen () override
	default destructor More...

VallFragmentGen &	operator= (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

Member Typedef Documentation

◆ Extent

typedef Super::Extent core::fragment::picking_old::vall::gen::LengthGen::Extent

typedef for ExtentGenerator concept

◆ PageIterator

typedef Super::PageIterator core::fragment::picking_old::vall::gen::LengthGen::PageIterator

typedef for ExtentGenerator concept

◆ Size

typedef Super::Size core::fragment::picking_old::vall::gen::LengthGen::Size

◆ Super

typedef VallFragmentGen core::fragment::picking_old::vall::gen::LengthGen::Super

private

◆ VallResidueIterator

typedef PageIterator core::fragment::picking_old::vall::gen::LengthGen::VallResidueIterator

Constructor & Destructor Documentation

◆ LengthGen() [1/3]

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

default constructor

◆ LengthGen() [2/3]

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

fragment size constructor

Parameters

[in] frag_size the desired length of the fragment

◆ LengthGen() [3/3]

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

default

copy constructor

◆ ~LengthGen()

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

overridedefault

default destructor

Member Function Documentation

◆ clone()

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

overridevirtual

clone this object

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

◆ operator()()

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

overridevirtual

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.

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

◆ operator=()

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

copy assignment

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

Member Data Documentation

◆ frag_size_

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