Represents a SAM program record.
More...
#include <SamProgram.h>
|
| SamProgram () |
| default constructor
|
|
| SamProgram (const std::string &id) |
| constructs program record with id
|
|
void | Clear () |
| Clears all data fields.
|
|
bool | HasCommandLine () const |
| Returns true if program record contains @PG: CL:<CommandLine>
|
|
bool | HasID () const |
| Returns true if program record contains @PG: ID:<ID>
|
|
bool | HasName () const |
| Returns true if program record contains @PG: PN:<Name>
|
|
bool | HasPreviousProgramID () const |
| Returns true if program record contains @PG: PP:<PreviousProgramID>
|
|
bool | HasVersion () const |
| Returns true if program record contains @PG: VN:<Version>
|
|
Represents a SAM program record.
Provides direct read/write access to the SAM header program records.
- See also
- http://samtools.sourceforge.net/SAM1.pdf
◆ SamProgram() [1/2]
SamProgram::SamProgram |
( |
| ) |
|
◆ SamProgram() [2/2]
SamProgram::SamProgram |
( |
const std::string & |
id | ) |
|
constructs program record with id
- Parameters
-
id | desired program record ID |
◆ Clear()
void SamProgram::Clear |
( |
| ) |
|
◆ HasCommandLine()
bool SamProgram::HasCommandLine |
( |
| ) |
const |
Returns true
if program record contains @PG: CL:<CommandLine>
◆ HasID()
bool SamProgram::HasID |
( |
| ) |
const |
Returns true
if program record contains @PG: ID:<ID>
◆ HasName()
bool SamProgram::HasName |
( |
| ) |
const |
Returns true
if program record contains @PG: PN:<Name>
◆ HasPreviousProgramID()
bool SamProgram::HasPreviousProgramID |
( |
| ) |
const |
Returns true
if program record contains @PG: PP:<PreviousProgramID>
◆ HasVersion()
bool SamProgram::HasVersion |
( |
| ) |
const |
Returns true
if program record contains @PG: VN:<Version>
◆ BamTools::SamProgramChain
◆ CommandLine
corresponds to @PG CL:<CommandLine>
◆ CustomTags
◆ ID
corresponds to @PG ID:<ID>
Required for valid SAM header.
◆ Name
corresponds to @PG PN:<Name>
◆ PreviousProgramID
SamProgram::PreviousProgramID |
corresponds to @PG PP:<PreviousProgramID>
◆ Version
corresponds to @PG VN:<Version>
The documentation for this struct was generated from the following files: