Source code for hylite.Generic_Pileup_Reader

#!/usr/bin/env python3

#    (c) Copyright 2013-2018 Murray Cox, Wandrille Duchemin, Pierre-Yves Dupont.
#
#
#    This file is part of HyLiTE.
#
#    HyLiTE is a free software: you can redistribute it and/or modify
#    it under the terms of the GNU General Public License version 3 as published by
#    the Free Software Foundation.
#
#    HyLiTE 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 HyLiTE.  If not, see <http://www.gnu.org/licenses/>


#===============================#
# author: Wandrille Duchemin    #
#         Murray Cox            #
# last modified: 9 January 2018 #
#===============================#


class Generic_Pileup_Reader:
    '''This abstract class is used to be the parent of any class who access the information contained in certain points of a .pileup file
    
    Attributes:
         - filename (str): name of the .pileup file
    
    '''
    def __init__(self, filename):
        '''
        Args:
             - filename (str): name of the pileup file
        '''
        self.filename=filename
        
        
    
    def give_line(self):
        '''
        Raises:
             - Exception
        '''
        raise Exception('This is an abstract class! function not implemented')