summary_run_metric.h

Go to the documentation of this file.

#pragma once

#include "interop/io/format/generic_layout.h"
#include "interop/model/metric_base/base_metric.h"
#include "interop/model/metric_base/metric_set.h"

namespace illumina { namespace interop { namespace model { namespace metrics
{

    class summary_run_metric : public metric_base::empty_metric
    {
    public:
        enum
        {
            TYPE = constants::SummaryRun,
            LATEST_VERSION = 1
        };
        typedef metric_base::base_metric_header header_type;
        typedef std::vector<float> float_vector;
        typedef uint8_t ubyte_t;
        typedef uint16_t ushort_t;
        typedef uint32_t uint_t;
        typedef double count_t;

    public:
        summary_run_metric() :
                m_occupancy_proxy_cluster_count(missing())
                , m_raw_cluster_count(missing())
                , m_occupied_cluster_count(missing())
                , m_pf_cluster_count(missing())
        { }
        summary_run_metric(const header_type&) :
                m_occupancy_proxy_cluster_count(missing())
                , m_raw_cluster_count(missing())
                , m_occupied_cluster_count(missing())
                , m_pf_cluster_count(missing())
        { }

        summary_run_metric(const count_t occupancy_proxy_cluster_count
                , const count_t raw_cluster_count
                , const count_t occupied_cluster_count
                , const count_t pf_cluster_count
                ) :
                m_occupancy_proxy_cluster_count(occupancy_proxy_cluster_count)
                , m_raw_cluster_count(raw_cluster_count)
                , m_occupied_cluster_count(occupied_cluster_count)
                , m_pf_cluster_count(pf_cluster_count)
        {}

    public:
        void set(const count_t occupancy_proxy_cluster_count
                , const count_t raw_cluster_count
                , const count_t occupied_cluster_count
                , const count_t pf_cluster_count)
        {
            m_occupancy_proxy_cluster_count = occupancy_proxy_cluster_count;
            m_raw_cluster_count = raw_cluster_count;
            m_occupied_cluster_count = occupied_cluster_count;
            m_pf_cluster_count = pf_cluster_count;
        }

        count_t raw_cluster_count() const
        {
            return m_raw_cluster_count;
        }
        count_t occupied_cluster_count() const
        {
            return m_occupied_cluster_count;
        }
        count_t pf_cluster_count() const
        {
            return m_pf_cluster_count;
        }
        count_t occupancy_proxy_cluster_count() const
        {
            return m_occupancy_proxy_cluster_count;
        }
        count_t percent_occupancy_proxy() const
        {
            if(std::isnan(m_pf_cluster_count)) return missing();
            if(std::isnan(m_occupancy_proxy_cluster_count)) return missing();
            return m_occupancy_proxy_cluster_count / m_pf_cluster_count * 100.0;
        }
        count_t percent_pf() const
        {
            if(std::isnan(m_raw_cluster_count)) return missing();
            if(std::isnan(m_pf_cluster_count)) return missing();
            return m_pf_cluster_count / m_raw_cluster_count * 100.0;
        }
        count_t percent_occupied() const
        {
            if(std::isnan(m_raw_cluster_count)) return missing();
            if(std::isnan(m_occupied_cluster_count)) return missing();
            return m_occupied_cluster_count / m_raw_cluster_count * 100.0;
        }
        id_t id() const
        {
            return 1;// There is only ever 1 per run, cannot be zero
        }

    public:
        static const char *prefix()
        { return "SummaryRun"; }

    public:
        static count_t missing()
        {
            return std::numeric_limits<count_t>::quiet_NaN();
        }

    private:
        count_t m_occupancy_proxy_cluster_count;
        count_t m_raw_cluster_count;
        count_t m_occupied_cluster_count;
        count_t m_pf_cluster_count;

        template<class MetricType, int Version>
        friend
        struct io::generic_layout;
    };
}}}}