Changes

From Genome Analysis Wiki
Jump to navigationJump to search
no edit summary
Line 10: Line 10:  
| <code>void SamRecord::resetRecord()</code>
 
| <code>void SamRecord::resetRecord()</code>
 
| Resets the record to be an empty record.  This is not necessary when you are reading a Sam/Bam file, but if you are setting fields, it is a good idea to clean out a record before reusing it.  Clearing it allows you to not have to set any empty fields.
 
| Resets the record to be an empty record.  This is not necessary when you are reading a Sam/Bam file, but if you are setting fields, it is a good idea to clean out a record before reusing it.  Clearing it allows you to not have to set any empty fields.
 +
|-
 +
| <code>void SamRecord::resetTagIter()</code>
 +
| Resets the iterator that loops through the tags to the beginning of the tags.  The iterator is automatically reset when a new record is read.  This method is only necessary if you want to iterate over a set of tags multiple times.
 
|-
 
|-
 
| <code>bool SamRecord::setReadName(const char* readName)</code>
 
| <code>bool SamRecord::setReadName(const char* readName)</code>
Line 81: Line 84:  
| <code>bool SamRecord::isValid(SamFileHeader& header)</code>
 
| <code>bool SamRecord::isValid(SamFileHeader& header)</code>
 
| Returns true if the record is valid.  This performs validation steps.  TODO: the method exists, but it does not yet perform any checks, so just returns true.
 
| Returns true if the record is valid.  This performs validation steps.  TODO: the method exists, but it does not yet perform any checks, so just returns true.
 +
|-
 +
| <code>const void* SamRecord::getRecordBuffer()</code>
 +
| Returns a const pointer to the buffer that is the BAM representation of the record.
 +
|-
 +
| <code>SamStatus::Status SamRecord::writeRecordBuffer(IFILE filePtr)</code>
 +
| Returns the status of writing the BAM record into the specified, already opened IFILE.
 
|-
 
|-
 
| <code>int32_t SamRecord::getBlockSize()</code>
 
| <code>int32_t SamRecord::getBlockSize()</code>

Navigation menu