#include <yat/omic/BamPair.h>

Public Member Functions
	BamPairProxy (void)
	Default constructor.

	BamPairProxy (const BamRead first, const BamRead second)

const BamRead &	first (void) const

const BamRead &	second (void) const

	operator BamPair () const

Detailed Description

A proxy class that behaves like a const BamPair&.

The class is used in BamPairIterator. The class allows to create an object that looks like a const reference of BamPair from two BamRead pointers without copying the BamRead objects. As the class is aimed at looking like a const BamPair&, implicit conversion to BamPair is allowed to mimic: BamPair = const BamPair&.

Constructor & Destructor Documentation

◆ BamPairProxy()

theplu::yat::omic::BamPairProxy::BamPairProxy	(	const BamRead *	first,
		const BamRead *	second
	)

Create a proxy from first and second.

Note: if the objects pointed to by first and second goes out of scope, this class becomes invalid and behaviour is undefined.

Member Function Documentation

◆ first()

const BamRead& theplu::yat::omic::BamPairProxy::first ( void ) const

Returns: const reference to first BamRead

◆ operator BamPair()

theplu::yat::omic::BamPairProxy::operator BamPair ( ) const

Implicit conversion from BamPairProxy to BamPair.

◆ second()

const BamRead& theplu::yat::omic::BamPairProxy::second ( void ) const

Returns: const reference to second BamRead

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

yat/omic/BamPair.h