Package goby :: Module Reads :: Class ReadsCollectionReader
[hide private]
[frames] | no frames]

Class ReadsCollectionReader

source code

                       object --+    
                                |    
MessageChunks.MessageChunksReader --+
                                    |
                                   ReadsCollectionReader

Iterator for read collections within a compact reads file

Instance Methods [hide private]
 
__init__(self, filename, verbose=False)
Initialize the MessageChunksReader using the name of the of the compact file (reads, alignment entries, etc.)
source code
 
next(self)
Return next read collection from the compact reads file
source code
 
__iter__(self)
The message chunks reader is actually an iterator over chunks in the compact file.
source code
 
__str__(self)
str(x)
source code

Inherited from MessageChunks.MessageChunksReader: __del__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Variables [hide private]

Inherited from MessageChunks.MessageChunksReader: DELIMITER_LENGTH, fileindex, filename, fileobject, verbose

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, filename, verbose=False)
(Constructor)

source code 

Initialize the MessageChunksReader using the name of the of the compact file (reads, alignment entries, etc.)

Overrides: object.__init__
(inherited documentation)

next(self)

source code 

Return next read collection from the compact reads file

Overrides: MessageChunks.MessageChunksReader.next

__iter__(self)

source code 

The message chunks reader is actually an iterator over chunks in the compact file. Each iteration will return a chunk of bytes raw bytes which can then be processed

Overrides: MessageChunks.MessageChunksReader.__iter__
(inherited documentation)

__str__(self)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)