BamTools  2.5.2
Public Member Functions | Public Attributes | Friends | List of all members
BamTools::SamProgram Struct Reference

Represents a SAM program record. More...

#include <SamProgram.h>

Public Member Functions

 SamProgram ()
 default constructor More...
 
 SamProgram (const std::string &id)
 constructs program record with id More...
 
void Clear ()
 Clears all data fields. More...
 
bool HasCommandLine () const
 Returns true if program record contains @PG: CL:<CommandLine> More...
 
bool HasID () const
 Returns true if program record contains @PG: ID:<ID> More...
 
bool HasName () const
 Returns true if program record contains @PG: PN:<Name> More...
 
bool HasPreviousProgramID () const
 Returns true if program record contains @PG: PP:<PreviousProgramID> More...
 
bool HasVersion () const
 Returns true if program record contains @PG: VN:<Version> More...
 

Public Attributes

std::string CommandLine
 corresponds to @PG CL:<CommandLine> More...
 
std::string ID
 corresponds to @PG ID:<ID> More...
 
std::string Name
 corresponds to @PG PN:<Name> More...
 
std::string PreviousProgramID
 corresponds to @PG PP:<PreviousProgramID> More...
 
std::string Version
 corresponds to @PG VN:<Version> More...
 
std::vector< CustomHeaderTagCustomTags
 

Friends

class BamTools::SamProgramChain
 

Detailed Description

Represents a SAM program record.

Provides direct read/write access to the SAM header program records.

See also
http://samtools.sourceforge.net/SAM1.pdf

Constructor & Destructor Documentation

◆ SamProgram() [1/2]

SamProgram::SamProgram ( )

default constructor

◆ SamProgram() [2/2]

SamProgram::SamProgram ( const std::string &  id)

constructs program record with id

Parameters
iddesired program record ID

Member Function Documentation

◆ Clear()

void SamProgram::Clear ( )

Clears all data fields.

◆ 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>

Friends And Related Function Documentation

◆ BamTools::SamProgramChain

friend class BamTools::SamProgramChain
friend

Member Data Documentation

◆ CommandLine

SamProgram::CommandLine

corresponds to @PG CL:<CommandLine>

◆ CustomTags

std::vector<CustomHeaderTag> BamTools::SamProgram::CustomTags

◆ ID

SamProgram::ID

corresponds to @PG ID:<ID>

Required for valid SAM header.

◆ Name

SamProgram::Name

corresponds to @PG PN:<Name>

◆ PreviousProgramID

SamProgram::PreviousProgramID

corresponds to @PG PP:<PreviousProgramID>

◆ Version

SamProgram::Version

corresponds to @PG VN:<Version>


The documentation for this struct was generated from the following files: