WDataModuleInputFile.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 WDATAMODULEINPUTFILE_H
#define WDATAMODULEINPUTFILE_H
 
#include <memory>
#include <ostream>
#include <string>
 
#include <boost/filesystem/path.hpp>
 
#include "WDataModuleInput.h"
 
/**
 * Implements a file based input for the \ref WDataModule.
 */
class WDataModuleInputFile: public WDataModuleInput
{
public:
    /**
     * Convenience typedef for a std::shared_ptr< WDataModuleInputFile >.
     */
    typedef std::shared_ptr< WDataModuleInputFile > SPtr;
 
    /**
     * Convenience typedef for a std::shared_ptr< const WDataModuleInputFile >.
     */
    typedef std::shared_ptr< const WDataModuleInputFile > ConstSPtr;
 
    /**
     * Default constructor.
     *
     * \param fname the filename to use.
     */
    explicit WDataModuleInputFile( boost::filesystem::path fname );
 
    /**
     * Default constructor.
     *
     * \param fname the filename to use.
     */
    explicit WDataModuleInputFile( std::string fname );
 
    /**
     * Destructor.
     */
    virtual ~WDataModuleInputFile();
 
    /**
     * Get the filename to load.
     *
     * \return the filename
     */
    boost::filesystem::path getFilename() const;
 
    /**
     * Return a unique name for this input type. This is used to identify a certain input later.
     *
     * \return the name.
     */
    virtual std::string getName() const;
 
    /**
     * The file input as human readable string.
     *
     * \return the readable form.
     */
    virtual std::string asString() const;
 
    /**
     * Return some extend information for the input, like complete path, server data (username, subject name, ...). It is up to you.
     *
     * \return some extended information as string.
     */
    virtual std::string getExtendedInfo() const;
 
    /**
     * Write a machine-readable string which allows to restore your specific input later. No line-breaks, no ":" and it must not be empty.
     *
     * \param out the stream to serialize to
     *
     * \return the stream
     */
    virtual std::ostream& serialize( std::ostream& out ) const;      // NOLINT: yes, it is an intended non-const ref
protected:
private:
    /**
     * The filename to load.
     */
    boost::filesystem::path m_filename;
};
 
#endif  // WDATAMODULEINPUTFILE_H