BamTools::SamProgram Struct Reference

Represents a SAM program record. More...

#include <SamProgram.h>

Public Member Functions
	SamProgram (void)
	default constructor More...
	SamProgram (const std::string &id)
	constructs program record with id More...
	SamProgram (const SamProgram &other)
	copy constructor More...
	~SamProgram (void)
	destructor More...
void	Clear (void)
	Clears all data fields. More...
bool	HasCommandLine (void) const
	Returns true if program record contains @PG: CL:<CommandLine> More...
bool	HasID (void) const
	Returns true if program record contains @PG: ID:<ID> More...
bool	HasName (void) const
	Returns true if program record contains @PG: PN:<Name> More...
bool	HasPreviousProgramID (void) const
	Returns true if program record contains @PG: PP:<PreviousProgramID> More...
bool	HasVersion (void) 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< CustomHeaderTag >	CustomTags

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::SamProgram

(

void

)

default constructor

SamProgram::SamProgram

(

const std::string &

id

)

constructs program record with id

Parameters

id	desired program record ID

SamProgram::SamProgram

(

const SamProgram &

other

)

copy constructor

SamProgram::~SamProgram

(

void

)

destructor

Member Function Documentation

void SamProgram::Clear

(

void

)

Clears all data fields.

bool SamProgram::HasCommandLine

(

void

)

const

Returns true if program record contains @PG: CL:<CommandLine>

bool SamProgram::HasID

(

void

)

const

Returns true if program record contains @PG: ID:<ID>

bool SamProgram::HasName

(

void

)

const

Returns true if program record contains @PG: PN:<Name>

bool SamProgram::HasPreviousProgramID

(

void

)

const

Returns true if program record contains @PG: PP:<PreviousProgramID>

bool SamProgram::HasVersion

(

void

)

const

Returns true if program record contains @PG: VN:<Version>

Friends And Related Function Documentation

friend class BamTools::SamProgramChain

friend

Member Data Documentation

SamProgram::CommandLine

corresponds to @PG CL:<CommandLine>

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

SamProgram::ID

corresponds to @PG ID:<ID>

Required for valid SAM header.

SamProgram::Name

corresponds to @PG PN:<Name>

SamProgram::PreviousProgramID

corresponds to @PG PP:<PreviousProgramID>

SamProgram::Version

corresponds to @PG VN:<Version>

---

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

• SamProgram.h
• SamProgram.cpp