PoldiPeakCollection.h

#ifndef MANTID_SINQ_POLDIPEAKCOLLECTION_H
#define MANTID_SINQ_POLDIPEAKCOLLECTION_H

#include "MantidSINQ/DllConfig.h"
#include "MantidSINQ/PoldiUtilities/PoldiPeak.h"
#include "MantidDataObjects/TableWorkspace.h"
#include "boost/shared_ptr.hpp"

namespace Mantid {
namespace Poldi {

/** PoldiPeakCollection :
 *
  PoldiPeakCollection stores PoldiPeaks and acts as a bridge
  to TableWorkspace

    @author Michael Wedel, Paul Scherrer Institut - SINQ
    @date 15/03/2014

    Copyright © 2014 PSI-MSS

  This file is part of Mantid.

  Mantid is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 3 of the License, or
  (at your option) any later version.

  Mantid 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 General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

  File change history is stored at: <https://github.com/mantidproject/mantid>
  Code Documentation is available at: <http://doxygen.mantidproject.org>
*/

using namespace Mantid::DataObjects;
using namespace Mantid::API;

class MANTID_SINQ_DLL PoldiPeakCollection
{    
public:
    enum IntensityType {
        Maximum,
        Integral
    };

    PoldiPeakCollection(IntensityType intensityType = Maximum);
    PoldiPeakCollection(TableWorkspace_sptr workspace);
    virtual ~PoldiPeakCollection() {}

    size_t peakCount() const;

    void addPeak(PoldiPeak_sptr newPeak);
    PoldiPeak_sptr peak(size_t index) const;

    IntensityType intensityType() const;

    void setProfileFunctionName(std::string newProfileFunction);
    std::string getProfileFunctionName() const;
    bool hasProfileFunctionName() const;

    TableWorkspace_sptr asTableWorkspace();

protected:
    void prepareTable(TableWorkspace_sptr table);
    void dataToTableLog(TableWorkspace_sptr table);
    void peaksToTable(TableWorkspace_sptr table);

    void constructFromTableWorkspace(TableWorkspace_sptr tableWorkspace);
    bool checkColumns(TableWorkspace_sptr tableWorkspace);

    void recoverDataFromLog(TableWorkspace_sptr TableWorkspace);

    std::string getIntensityTypeFromLog(LogManager_sptr tableLog);
    std::string getProfileFunctionNameFromLog(LogManager_sptr tableLog);

    std::string getStringValueFromLog(LogManager_sptr logManager, std::string valueName);

    std::string intensityTypeToString(IntensityType type) const;
    IntensityType intensityTypeFromString(std::string typeString) const;

    std::vector<PoldiPeak_sptr> m_peaks;
    IntensityType m_intensityType;
    std::string m_profileFunctionName;
};

typedef boost::shared_ptr<PoldiPeakCollection> PoldiPeakCollection_sptr;

}
}

#endif // MANTID_SINQ_POLDIPEAKCOLLECTION_H