Filter

#include <pbbam/DataSetTypes.h>
class PacBio::BAM::Filter

The Filter class represents a Filter element in DataSetXML.

The Filter element allows analysis pipelines to describe filters on data that should be respected downstream, without needing to create filtered intermediate files.

A filter consists of a list of Property elements, each of which must be passed (logical AND) to pass the filter, e.g. property1 && property2 && property3.

Inherits from DataSetElement

Public Functions

Filter()

Creates an empty filter.

const PacBio::BAM::Properties &Properties() const

Fetches the filter’s property list element.

Return
const reference to child element
Exceptions
  • std::runtime_error: if element does not exist

PacBio::BAM::Properties &Properties()

Fetches the filter’s property list child element.

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

Return
non-const reference to child element

Filter &Properties(const PacBio::BAM::Properties &properties)

Sets this filter’s Properties child element.

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

Return
reference to this filter object
Parameters
  • properties: new value for the element