lane_summary.h

Go to the documentation of this file.

#pragma once

#include <cstddef>
#include <climits>
#include "interop/model/model_exceptions.h"
#include "interop/model/summary/cycle_state_summary.h"
#include "interop/model/summary/stat_summary.h"
#include "interop/model/summary/surface_summary.h"
#include "interop/io/format/generic_layout.h"

namespace illumina { namespace interop { namespace model { namespace summary
{

    class lane_summary : public stat_summary
    {
        typedef std::vector<surface_summary> surface_summary_vector_t;
    public:
        typedef metric_stat metric_stat_t;
    public:
        typedef surface_summary_vector_t::reference reference;
        typedef surface_summary_vector_t::const_reference const_reference;
        typedef surface_summary_vector_t::iterator iterator;
        typedef surface_summary_vector_t::const_iterator const_iterator;
        typedef surface_summary_vector_t::size_type size_type;
    public:
        lane_summary(const size_t lane = 0, const size_t channel_count=0) :
                stat_summary(channel_count),
                m_lane(lane),
                m_tile_count(0)
        {
        }

    public:
        surface_summary & operator[](const size_t n) INTEROP_THROW_SPEC((model::index_out_of_bounds_exception))
        {
            INTEROP_BOUNDS_CHECK(n, m_summary_by_surface.size(), "Surface index exceeds surface count");
            return m_summary_by_surface[n];
        }

        surface_summary &at(const size_t n) INTEROP_THROW_SPEC((model::index_out_of_bounds_exception))
        {
            INTEROP_BOUNDS_CHECK(n, m_summary_by_surface.size(), "Surface index exceeds surface count");
            return m_summary_by_surface[n];
        }

        iterator begin()
        {
            return m_summary_by_surface.begin();
        }

        iterator end()
        {
            return m_summary_by_surface.end();
        }

        const_iterator begin()const
        {
            return m_summary_by_surface.begin();
        }

        const_iterator end()const
        {
            return m_summary_by_surface.end();
        }

        void resize(const size_type n)
        {
            m_summary_by_surface.resize(n);
        }
        void lane(const size_t val)
        {
            m_lane = val;
        }
        void tile_count(const size_t val)
        {
            m_tile_count = val;
        }
        cycle_state_summary &cycle_state()
        {
            return m_cycle_state;
        }

    public:
        const surface_summary& operator[](const size_t n) const INTEROP_THROW_SPEC((model::index_out_of_bounds_exception))
        {
            INTEROP_BOUNDS_CHECK(n, m_summary_by_surface.size(), "Surface index exceeds surface count");
            return m_summary_by_surface[n];
        }

        const_reference at(const size_type n) const INTEROP_THROW_SPEC((model::index_out_of_bounds_exception))
        {
            INTEROP_BOUNDS_CHECK(n, m_summary_by_surface.size(), "Surface index exceeds surface count");
            return m_summary_by_surface[n];
        }
        size_t lane() const
        {
            return m_lane;
        }
        size_t tile_count() const
        {
            return m_tile_count;
        }
        const cycle_state_summary &cycle_state() const
        {
            return m_cycle_state;
        }
        size_t size() const
        {
            return m_summary_by_surface.size();
        }
    private:
        size_t m_lane;
        size_t m_tile_count;
        cycle_state_summary m_cycle_state;
        surface_summary_vector_t m_summary_by_surface;
        template<class MetricType, int Version>
        friend struct io::generic_layout;
    };

}}}}