Aggregator.hpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2009-2015.
 * Distributed under the terms of the GNU Lesser General Public License (LGPL) as
 * published by the Free Software Foundation.
 * ****** END LICENSE BLOCK ****** */

#ifndef __FWJOBS_AGGREGATOR_HPP__
#define __FWJOBS_AGGREGATOR_HPP__

#include "fwJobs/config.hpp"
#include "fwJobs/IJob.hpp"

#include <fwCore/macros.hpp>

#include <boost/multi_index_container.hpp>
#include <boost/multi_index/hashed_index.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index/random_access_index.hpp>
#include <boost/multi_index/identity.hpp>
#include <boost/multi_index/member.hpp>

#include <cstdint>
#include <functional>
#include <string>

namespace fwJobs
{

class FWJOBS_CLASS_API Aggregator : public IJob
{
public:

    typedef SPTR (::fwJobs::Aggregator) sptr;
    typedef WPTR (::fwJobs::Aggregator) wptr;

    typedef ::boost::multi_index_container< ::fwJobs::IJob::sptr,
                                            ::boost::multi_index::indexed_by<
                                                ::boost::multi_index::random_access<>,
                                                ::boost::multi_index::hashed_unique<
                                                    ::boost::multi_index::identity< ::fwJobs::IJob::sptr >
                                                    >
                                                >
                                            > IJobSeq;
    FWJOBS_API static sptr New(const std::string& name = "");

    FWJOBS_API Aggregator();

    FWJOBS_API Aggregator(const std::string& name);

    FWJOBS_API void add(const ::fwJobs::IJob::sptr & iJob, double weight = 1.);

    FWJOBS_API IJobSeq getSubJobs();


protected:

    FWJOBS_API SharedFuture runImpl();

private:

    IJobSeq m_jobs;

    struct JobInfo
    {
        std::uint64_t doneWork;
        std::uint64_t totalWork;
        std::uint64_t lastValue;

        JobInfo() : doneWork(0), totalWork(0), lastValue(0)
        {
        }

        JobInfo(std::uint64_t d, std::uint64_t t) :
            doneWork(d),
            totalWork(t),
            lastValue(0)
        {
        }

        JobInfo( const IJob &iJob ) :
            doneWork(iJob.getDoneWorkUnits()),
            totalWork(iJob.getTotalWorkUnits()),
            lastValue(0)
        {
        }

        double progress() const
        {
            return ( 0 == totalWork ) ? 1. : double(doneWork)/totalWork;
        }
    };

    typedef std::map< fwJobs::IJob*, JobInfo > JobInfoMap;

    JobInfoMap m_jobInfo;
};

} //namespace fwJobs

#endif //__FWJOBS_AGGREGATOR_HPP__