yat  0.14.5pre
Public Member Functions | List of all members
theplu::yat::omic::BamPairProxy Class Reference

#include <yat/omic/BamPair.h>

Public Member Functions

 BamPairProxy (void)
 Default constructor.
 
 BamPairProxy (const BamRead *first, const BamRead *second)
 
const BamReadfirst (void) const
 
const BamReadsecond (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

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

const BamRead& theplu::yat::omic::BamPairProxy::first ( void  ) const
Returns
const reference to first BamRead
theplu::yat::omic::BamPairProxy::operator BamPair ( ) const

Implicit conversion from BamPairProxy to BamPair.

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:

Generated on Tue Sep 26 2017 02:33:29 for yat by  doxygen 1.8.5