AbstractReportHandler.hpp

Go to the documentation of this file.

// Copyright (c) 2005 - 2012 Marc de Kamps
//                      2012 David-Matthias Sichau
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
//
//    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation
//      and/or other materials provided with the distribution.
//    * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software
//      without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
// USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
#ifndef MPILIB_REPORT_HANDLER_ABSTRACTREPORTHANDLER_HPP_
#define MPILIB_REPORT_HANDLER_ABSTRACTREPORTHANDLER_HPP_

#include <string>
#include <MPILib/include/TypeDefinitions.hpp>
#include <MPILib/include/report/Report.hpp>

namespace MPILib {
namespace report {
namespace handler {


class AbstractReportHandler {
public:

    AbstractReportHandler(const std::string& fileName, bool bStateWrite = false);

    virtual ~AbstractReportHandler();

    virtual void writeReport(const Report& report) = 0;

    virtual AbstractReportHandler* clone() const = 0;

    virtual void initializeHandler(const NodeId& nodeId) = 0;

    virtual void detachHandler(const NodeId& nodeId) = 0;

    std::string getRootOutputFileName() const;

    std::string getFileName() const;

    bool isStateWriteMandatory() const { return _bStateWrite; }

private:

    const std::string _streamFileName;
    const bool _bStateWrite;
};

}// end namespace of handler
}// end namespace of report
}// end namespace of MPILib

#endif // MPILIB_REPORT_HANDLER_ABSTRACTREPORTHANDLER_HPP_ include guard