ProteoWizard
pwiz
analysis
chromatogram_processing
ChromatogramListFactory.hpp
Go to the documentation of this file.
1
//
2
// $Id$
3
//
4
//
5
// Original author: Darren Kessner <darren@proteowizard.org>
6
//
7
// Copyright 2008 Spielberg Family Center for Applied Proteomics
8
// Cedars-Sinai Medical Center, Los Angeles, California 90048
9
//
10
// Licensed under the Apache License, Version 2.0 (the "License");
11
// you may not use this file except in compliance with the License.
12
// You may obtain a copy of the License at
13
//
14
// http://www.apache.org/licenses/LICENSE-2.0
15
//
16
// Unless required by applicable law or agreed to in writing, software
17
// distributed under the License is distributed on an "AS IS" BASIS,
18
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
// See the License for the specific language governing permissions and
20
// limitations under the License.
21
//
22
23
24
#ifndef _CHROMATOGRAMLISTFACTORY_HPP_
25
#define _CHROMATOGRAMLISTFACTORY_HPP_
26
27
28
#include "
pwiz/data/msdata/MSData.hpp
"
29
#include "
pwiz/data/msdata/examples.hpp
"
30
#include "
pwiz/utility/misc/IterationListener.hpp
"
31
#include <string>
32
#include <vector>
33
34
35
namespace
pwiz
{
36
namespace
analysis {
37
38
39
/// Factory for instantiating and wrapping ChromatogramLists
40
class
PWIZ_API_DECL
ChromatogramListFactory
41
{
42
public
:
43
44
/// instantiate the ChromatogramListWrapper indicated by wrapper
45
static
void
wrap(
msdata::MSData
& msd,
const
std::string& wrapper,
pwiz::util::IterationListenerRegistry
* ilr = NULL);
46
47
/// instantiate a list of ChromatogramListWrappers
48
static
void
wrap(
msdata::MSData
& msd,
const
std::vector<std::string>& wrappers,
pwiz::util::IterationListenerRegistry
* ilr = NULL);
49
50
/// user-friendly documentation, with option of less or more detail
51
static
std::string usage(
bool
detailedHelp =
true
,
const
char
* morehelp_prompt = NULL,
int
maxLineLength = 80);
52
};
53
54
55
}
// namespace analysis
56
}
// namespace pwiz
57
58
59
#endif // _CHROMATOGRAMLISTFACTORY_HPP_
60
IterationListener.hpp
examples.hpp
pwiz
Definition:
ChromatogramList_Filter.hpp:36
MSData.hpp
PWIZ_API_DECL
#define PWIZ_API_DECL
Definition:
Export.hpp:32
pwiz::analysis::ChromatogramListFactory
Factory for instantiating and wrapping ChromatogramLists.
Definition:
ChromatogramListFactory.hpp:40
pwiz::util::IterationListenerRegistry
handles registration of IterationListeners and broadcast of update messages
Definition:
IterationListener.hpp:65
pwiz::msdata::MSData
This is the root element of ProteoWizard; it represents the mzML element, defined as: intended to cap...
Definition:
MSData.hpp:849
Generated by
1.8.17