1# =========================================================================== 2# 3# PUBLIC DOMAIN NOTICE 4# National Center for Biotechnology Information 5# 6# This software/database is a "United States Government Work" under the 7# terms of the United States Copyright Act. It was written as part of 8# the author's official duties as a United States Government employee and 9# thus cannot be copyrighted. This software/database is freely available 10# to the public for use. The National Library of Medicine and the U.S. 11# Government have not placed any restriction on its use or reproduction. 12# 13# Although all reasonable efforts have been taken to ensure the accuracy 14# and reliability of the software and data, the NLM and the U.S. 15# Government do not and cannot warrant the performance or results that 16# may be obtained by using this software or data. The NLM and the U.S. 17# Government disclaim all warranties, express or implied, including 18# warranties of performance, merchantability or fitness for any particular 19# purpose. 20# 21# Please cite the author in any work or product based on this material. 22# 23# =========================================================================== 24# 25# 26 27from ctypes import c_int 28 29from . import NGS 30from .String import getNGSValue 31from .PileupEvent import PileupEvent 32 33#Iterates across a list of PileupEvents 34 35class PileupEventIterator(PileupEvent): 36 def nextPileupEvent(self): 37 """Advance to first PileupEvent on initial invocation 38 advance to next PileupEvent subsequently 39 :returns: false if no more PileupEvents are available. 40 :throws: ErrorMsg if more PileupEvents should be available, but could not be accessed. 41 """ 42 return bool(getNGSValue(self, NGS.lib_manager.PY_NGS_PileupEventIteratorNext, c_int)) 43 44 def resetPileupEvent(self): 45 """resets to initial iterator state 46 the next call to "nextPileupEvent" will advance to first event 47 :returns: false if no more PileupEvents are available. 48 :throws: ErrorMsg if more PileupEvents should be available, but could not be accessed. 49 """ 50 return bool(getNGSValue(self, NGS.lib_manager.PY_NGS_PileupEventIteratorReset, c_int))