ChromatogramList_mz5.hpp

Go to the documentation of this file.

//
// $Id: ChromatogramList_mz5.hpp 2811 2011-06-23 20:44:29Z chambm $
//
//
// Original authors: Mathias Wilhelm <mw@wilhelmonline.com>
//                   Marc Kirchner <mail@marc-kirchner.de>
//
// Copyright 2011 Proteomics Center
//                Children's Hospital Boston, Boston, MA 02135
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//


#ifndef _CHROMATOGRAMLIST_MZ5_HPP_
#define _CHROMATOGRAMLIST_MZ5_HPP_


#include "ChromatogramListBase.hpp"
#include "mz5/Datastructures_mz5.hpp"
#include "mz5/ReferenceRead_mz5.hpp"
#include "mz5/Configuration_mz5.hpp"
#include "mz5/Connection_mz5.hpp"


namespace pwiz {
namespace msdata {


/// implementation of ChromatogramList, backed by an mz5 file
class PWIZ_API_DECL ChromatogramList_mz5: public ChromatogramListBase
{
public:

    /**
     * Creates a chromatogramListPtr.
     * @param readPtr helper class to read mz5 files
     * @param connectionptr connection to an mz5 file
     * @param msd MSData file
     */
    static ChromatogramListPtr create(boost::shared_ptr<mz5::ReferenceRead_mz5> readPtr,
                                      boost::shared_ptr<mz5::Connection_mz5> connectionPtr,
                                      const MSData& msd);

    /**
     * Destructor.
     */
    virtual ~ChromatogramList_mz5();
};


} // namespace msdata
} // namespace pwiz


#endif // _CHROMATOGRAMLIST_MZ5_HPP_