File: PileupElement.h

package info (click to toggle)
libstatgen 1.0.15-8
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,588 kB
  • sloc: cpp: 49,624; ansic: 1,408; makefile: 320; sh: 60
file content (74 lines) | stat: -rw-r--r-- 2,436 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/*
 *  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