BamTools::BamRegion Struct Reference

Represents a sequential genomic region. More...

#include <BamAux.h>

List of all members.

Public Member Functions
	BamRegion (const int &leftID=-1, const int &leftPos=-1, const int &rightID=-1, const int &rightPos=-1)
	constructor
	BamRegion (const BamRegion &other)
	copy constructor
void	clear (void)
	Clears region boundaries.
bool	isLeftBoundSpecified (void) const
	Returns true if region has a left boundary.
bool	isNull (void) const
	Returns true if region boundaries are not defined.
bool	isRightBoundSpecified (void) const
	Returns true if region has a right boundary.
Public Attributes
int	LeftRefID
	reference ID for region's left boundary
int	LeftPosition
	position for region's left boundary
int	RightRefID
	reference ID for region's right boundary
int	RightPosition
	position for region's right boundary

---

Detailed Description

Represents a sequential genomic region.

Allowed to span multiple (sequential) references.

Warning:

BamRegion now represents a zero-based, HALF-OPEN interval. In previous versions of BamTools (0.x & 1.x) all intervals were treated as zero-based, CLOSED.

---

Constructor & Destructor Documentation

BamTools::BamRegion::BamRegion	(	const int &	leftID = -1,
		const int &	leftPos = -1,
		const int &	rightID = -1,
		const int &	rightPos = -1
	)			[inline]

constructor

BamTools::BamRegion::BamRegion

(

const BamRegion &

other

)

[inline]

copy constructor

---

Member Function Documentation

void BamTools::BamRegion::clear

(

void

)

[inline]

Clears region boundaries.

bool BamTools::BamRegion::isLeftBoundSpecified

(

void

)

const [inline]

Returns true if region has a left boundary.

bool BamTools::BamRegion::isNull

(

void

)

const [inline]

Returns true if region boundaries are not defined.

bool BamTools::BamRegion::isRightBoundSpecified

(

void

)

const [inline]

Returns true if region has a right boundary.

---

Member Data Documentation

int BamTools::BamRegion::LeftPosition

position for region's left boundary

int BamTools::BamRegion::LeftRefID

reference ID for region's left boundary

int BamTools::BamRegion::RightPosition

position for region's right boundary

int BamTools::BamRegion::RightRefID

reference ID for region's right boundary

---

The documentation for this struct was generated from the following file:

• BamAux.h