DataSetMetadata

#include <pbbam/DataSetTypes.h>

class PacBio::BAM::DataSetMetadata

The DataSetMetadata class represents the DataSetMetadata child element in DataSetXML.

A few top-level elements are built-in, but as pbbam is not primarily a DataSetXML API, most of the metadata hierarchy needs to be manually managed.

Inherits from DataSetElement

Constructors & Related Methods

DataSetMetadata(const std::string &numRecords, const std::string &totalLength)

Constructs a DataSetMetadata with required fields.

Operators

DataSetMetadata &operator+=(const DataSetMetadata &other)

Merges DataSetMetadata contents.

Adds contents of other to this metadata object

Return

reference to this object

Parameters

• other: some other metadata to add to this one

Child Elements

const std::string &NumRecords() const

Fetches the text of the NumRecords element.

Return

const reference to element text (empty string if not present)

const std::string &TotalLength() const

Fetches the text of the TotalLength element.

Return

const reference to element text (empty string if not present)

const PacBio::BAM::Provenance &Provenance() const

Fetches the Provenance element.

Return

const reference to child element

Exceptions

• std::runtime_error: if element does not exist

std::string &NumRecords()

Fetches the text of the NumRecords element.

This element will be created if it does not yet exist.

Return

non-const reference to element text

std::string &TotalLength()

Fetches the text of the TotalLength element.

This element will be created if it does not yet exist.

Return

non-const reference to element text

PacBio::BAM::Provenance &Provenance()

Fetches Provenance element.

This element will be created if it does not yet exist.

Return

non-const reference to child element

DataSetMetadata &NumRecords(const std::string &numRecords)

Sets the text of the NumRecords element.

This element will be created if it does not yet exist.

Return

reference to this metadata object

DataSetMetadata &TotalLength(const std::string &totalLength)

Sets the text of the TotalLength element.

This element will be created if it does not yet exist.

Return

reference to this metadata object

DataSetMetadata &Provenance(const PacBio::BAM::Provenance &provenance)

Sets the Provenance child element.

This element will be created if it does not yet exist.

Return

reference to this metadata object