Loading...
Searching...
No Matches
PileupElement.h
/*
* Copyright (C) 2010 Regents of the University of Michigan
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __PILEUP_ELEMENT_H__
#define __PILEUP_ELEMENT_H__
#include "SamRecord.h"
/// This is a base class pileup component, representing the information
/// for one reference position. Child classes will be defined to detail more
/// information that needs to be saved and how it should be analyzed.
class PileupElement
{
public:
static const int32_t UNSET_POSITION = -1;
/// Pileup element constructor.
PileupElement();
/// Constructor that resets the pileup element, does not copy, just resets.
PileupElement(const PileupElement& q);
/// Pileup element destructor.
virtual ~PileupElement();
/// Add an entry to this pileup element.
virtual void addEntry(SamRecord& record);
/// Perform the analysis associated with this class.
virtual void analyze();
/// Resets the entry, setting the new position associated with this element.
virtual void reset(int32_t refPosition);
/// Get the chromosome name stored in this element.
const char* getChromosome() const { return(myChromosome.c_str()); }
/// Get the reference position stored in this element.
int32_t getRefPosition() const { return(myRefPosition); }
/// Returns the reference base for this pileup element.
/// Only works if a reference has been set, otherwise, 'N' is returned.
char getRefBase();
/// Set the reference to use for all pilepElements.
static void setReference(GenomeSequence* reference);
protected:
/// Get a pointer to the reference.
static GenomeSequence* getReference() { return(myRefPtr); }
private:
int32_t myRefPosition;
std::string myChromosome;
static GenomeSequence* myRefPtr;
};
#endif
GenomeSequence
Create/Access/Modify/Load Genome Sequences stored as binary mapped files.
Definition GenomeSequence.h:100
PileupElement
This is a base class pileup component, representing the information for one reference position.
Definition PileupElement.h:27
PileupElement::setReference
static void setReference(GenomeSequence *reference)
Set the reference to use for all pilepElements.
Definition PileupElement.cpp:86
PileupElement::getChromosome
const char * getChromosome() const
Get the chromosome name stored in this element.
Definition PileupElement.h:51
PileupElement::getRefPosition
int32_t getRefPosition() const
Get the reference position stored in this element.
Definition PileupElement.h:54
PileupElement::getReference
static GenomeSequence * getReference()
Get a pointer to the reference.
Definition PileupElement.h:65
PileupElement::PileupElement
PileupElement()
Pileup element constructor.
Definition PileupElement.cpp:24
PileupElement::addEntry
virtual void addEntry(SamRecord &record)
Add an entry to this pileup element.
Definition PileupElement.cpp:44
PileupElement::analyze
virtual void analyze()
Perform the analysis associated with this class.
Definition PileupElement.cpp:57
PileupElement::~PileupElement
virtual ~PileupElement()
Pileup element destructor.
Definition PileupElement.cpp:38
PileupElement::reset
virtual void reset(int32_t refPosition)
Resets the entry, setting the new position associated with this element.
Definition PileupElement.cpp:67
PileupElement::getRefBase
char getRefBase()
Returns the reference base for this pileup element.
Definition PileupElement.cpp:74
SamRecord
Class providing an easy to use interface to get/set/operate on the fields in a SAM/BAM record.
Definition SamRecord.h:52