WBatchLoader.h

//---------------------------------------------------------------------------
//
// Project: OpenWalnut ( http://www.openwalnut.org )
//
// Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
// For more information see http://www.openwalnut.org/copying
//
// This file is part of OpenWalnut.
//
// OpenWalnut is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// OpenWalnut is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
//
//---------------------------------------------------------------------------
 
#ifndef WBATCHLOADER_H
#define WBATCHLOADER_H
 
#include <memory>
#include <string>
#include <vector>
 
#include "../common/WSharedSequenceContainer.h"
#include "../common/WThreadedRunner.h"
#include "WDataModule.h"
 
class WModuleContainer;
 
/**
 * Class for loading many datasets. It runs in a separate thread.
 */
class WBatchLoader: public WThreadedRunner,
                    public std::enable_shared_from_this< WBatchLoader >
{
public:
    /**
     * Shared ptr abbreviation
     */
    typedef std::shared_ptr< WBatchLoader > SPtr;
 
    /**
     * Const shared ptr abbreviation
     */
    typedef std::shared_ptr< const WBatchLoader > ConstSPtr;
 
    /**
     * The type is used to store the list of data modules
     */
    typedef WSharedSequenceContainer< std::vector< WDataModule::SPtr > > DataModuleList;
 
    /**
     * Initializes the batchloader but does not start it. Use run() to start. The batch-loader will always use the WDataModule which was found
     * first if multiple match to one filename. This is the reason why WBatchLoader will be removed in the future. Follow issue #32.
     *
     * \param filenames the files to load.
     * \param targetContainer the container to which the data modules should be added.
     */
    WBatchLoader( std::vector< std::string > filenames, std::shared_ptr< WModuleContainer > targetContainer );
 
    /**
     * Destructor.
     */
    virtual ~WBatchLoader();
 
    /**
     * Run thread and load the data.
     */
    virtual void run();
 
    /**
     * Returns a ticket to the list of data modules that have been added so far.
     *
     * \return the ticket
     */
    DataModuleList::ReadTicket getDataModuleList() const;
 
    /**
     * Allows suppression of colormap registration in data modules. This can be handy if you use data modules in a container to construct more
     * complex data sets from multiple input files.
     *
     * \note call this before run().
     *
     * \param suppress true if suppress
     */
    void setSuppressColormaps( bool suppress = true );
 
    /**
     * Checks whether suppression of colormaps is active.
     *
     * \return true if colormaps are suppressed.
     */
    bool getSuppressColormaps() const;
 
protected:
    /**
     * Function that has to be overwritten for execution. It gets executed in a separate thread after run()
     * has been called.
     */
    virtual void threadMain();
 
    /**
     * List of files to load.
     */
    std::vector< std::string > m_filenamesToLoad;
 
    /**
     * The container which later will contain the loaded datasets.
     */
    std::shared_ptr< WModuleContainer > m_targetContainer;
 
    /**
     * The list of modules that have been added.
     */
    DataModuleList m_dataModules;
 
    /**
     * If true, data modules are instructed to suppress colormap registration.
     */
    bool m_suppressColormaps;
 
private:
};
 
#endif  // WBATCHLOADER_H