BamTools 2.5.2
|
Represents a SAM read group entry. More...
#include <SamReadGroup.h>
Public Member Functions | |
SamReadGroup () | |
default constructor | |
SamReadGroup (const std::string &id) | |
constructs read group with id | |
void | Clear () |
Clears all data fields. | |
bool | HasDescription () const |
Returns true if read group contains @RG DS:<Description> | |
bool | HasFlowOrder () const |
Returns true if read group contains @RG FO:<FlowOrder> | |
bool | HasID () const |
Returns true if read group contains @RG: ID:<ID> | |
bool | HasKeySequence () const |
Returns true if read group contains @RG KS:<KeySequence> | |
bool | HasLibrary () const |
Returns true if read group contains @RG LB:<Library> | |
bool | HasPlatformUnit () const |
Returns true if read group contains @RG PU:<PlatformUnit> | |
bool | HasPredictedInsertSize () const |
Returns true if read group contains @RG PI:<PredictedInsertSize> | |
bool | HasProductionDate () const |
Returns true if read group contains @RG DT:<ProductionDate> | |
bool | HasProgram () const |
Returns true if read group contains @RG PG:<Program> | |
bool | HasSample () const |
Returns true if read group contains @RG SM:<Sample> | |
bool | HasSequencingCenter () const |
Returns true if read group contains @RG CN:<SequencingCenter> | |
bool | HasSequencingTechnology () const |
Returns true if read group contains @RG PL:<SequencingTechnology> | |
Public Attributes | |
std::string | Description |
corresponds to @RG DS:<Description> | |
std::string | FlowOrder |
corresponds to @RG FO:<FlowOrder> | |
std::string | ID |
corresponds to @RG ID:<ID> | |
std::string | KeySequence |
corresponds to @RG KS:<KeySequence> | |
std::string | Library |
corresponds to @RG LB:<Library> | |
std::string | PlatformUnit |
corresponds to @RG PU:<PlatformUnit> | |
std::string | PredictedInsertSize |
corresponds to @RG PI:<PredictedInsertSize> | |
std::string | ProductionDate |
corresponds to @RG DT:<ProductionDate> | |
std::string | Program |
corresponds to @RG PG:<Program> | |
std::string | Sample |
corresponds to @RG SM:<Sample> | |
std::string | SequencingCenter |
corresponds to @RG CN:<SequencingCenter> | |
std::string | SequencingTechnology |
corresponds to @RG PL:<SequencingTechnology> | |
std::vector< CustomHeaderTag > | CustomTags |
Represents a SAM read group entry.
Provides direct read/write access to the SAM read group data fields.
SamReadGroup::SamReadGroup | ( | ) |
default constructor
SamReadGroup::SamReadGroup | ( | const std::string & | id | ) |
constructs read group with id
id | desired read group ID |
void SamReadGroup::Clear | ( | ) |
Clears all data fields.
bool SamReadGroup::HasDescription | ( | ) | const |
Returns true
if read group contains @RG DS:<Description>
bool SamReadGroup::HasFlowOrder | ( | ) | const |
Returns true
if read group contains @RG FO:<FlowOrder>
bool SamReadGroup::HasID | ( | ) | const |
Returns true
if read group contains @RG: ID:<ID>
bool SamReadGroup::HasKeySequence | ( | ) | const |
Returns true
if read group contains @RG KS:<KeySequence>
bool SamReadGroup::HasLibrary | ( | ) | const |
Returns true
if read group contains @RG LB:<Library>
bool SamReadGroup::HasPlatformUnit | ( | ) | const |
Returns true
if read group contains @RG PU:<PlatformUnit>
bool SamReadGroup::HasPredictedInsertSize | ( | ) | const |
Returns true
if read group contains @RG PI:<PredictedInsertSize>
bool SamReadGroup::HasProductionDate | ( | ) | const |
Returns true
if read group contains @RG DT:<ProductionDate>
bool SamReadGroup::HasProgram | ( | ) | const |
Returns true
if read group contains @RG PG:<Program>
bool SamReadGroup::HasSample | ( | ) | const |
Returns true
if read group contains @RG SM:<Sample>
bool SamReadGroup::HasSequencingCenter | ( | ) | const |
Returns true
if read group contains @RG CN:<SequencingCenter>
bool SamReadGroup::HasSequencingTechnology | ( | ) | const |
Returns true
if read group contains @RG PL:<SequencingTechnology>
std::vector<CustomHeaderTag> BamTools::SamReadGroup::CustomTags |
std::string BamTools::SamReadGroup::Description |
corresponds to @RG DS:<Description>
std::string BamTools::SamReadGroup::FlowOrder |
corresponds to @RG FO:<FlowOrder>
std::string BamTools::SamReadGroup::ID |
corresponds to @RG ID:<ID>
Required for valid SAM header.
std::string BamTools::SamReadGroup::KeySequence |
corresponds to @RG KS:<KeySequence>
std::string BamTools::SamReadGroup::Library |
corresponds to @RG LB:<Library>
std::string BamTools::SamReadGroup::PlatformUnit |
corresponds to @RG PU:<PlatformUnit>
std::string BamTools::SamReadGroup::PredictedInsertSize |
corresponds to @RG PI:<PredictedInsertSize>
std::string BamTools::SamReadGroup::ProductionDate |
corresponds to @RG DT:<ProductionDate>
std::string BamTools::SamReadGroup::Program |
corresponds to @RG PG:<Program>
std::string BamTools::SamReadGroup::Sample |
corresponds to @RG SM:<Sample>
std::string BamTools::SamReadGroup::SequencingCenter |
corresponds to @RG CN:<SequencingCenter>
std::string BamTools::SamReadGroup::SequencingTechnology |
corresponds to @RG PL:<SequencingTechnology>