ProteoWizard
ProteinListFactory.hpp
Go to the documentation of this file.
1 //
2 // $Id: ProteinListFactory.hpp 4010 2012-10-17 20:22:16Z chambm $
3 //
4 //
5 // Original author: Matt Chambers <matt.chambers <a.t> vanderbilt.edu>
6 //
7 // Copyright 2012 Vanderbilt University - Nashville, TN 37232
8 //
9 // Licensed under the Apache License, Version 2.0 (the "License");
10 // you may not use this file except in compliance with the License.
11 // You may obtain a copy of the License at
12 //
13 // http://www.apache.org/licenses/LICENSE-2.0
14 //
15 // Unless required by applicable law or agreed to in writing, software
16 // distributed under the License is distributed on an "AS IS" BASIS,
17 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 // See the License for the specific language governing permissions and
19 // limitations under the License.
20 //
21 
22 
23 #ifndef _PROTEINLISTFACTORY_HPP_
24 #define _PROTEINLISTFACTORY_HPP_
25 
26 
28 #include <string>
29 #include <vector>
30 
31 
32 namespace pwiz {
33 namespace analysis {
34 
35 
36 /// Factory for instantiating and wrapping ProteinLists
38 {
39  public:
40 
41  /// instantiate the ProteinListWrapper indicated by wrapper
42  static void wrap(proteome::ProteomeData& pd, const std::string& wrapper);
43 
44  /// instantiate a list of ProteinListWrappers
45  static void wrap(proteome::ProteomeData& pd, const std::vector<std::string>& wrappers);
46 
47  /// user-friendly documentation
48  static std::string usage();
49 };
50 
51 
52 } // namespace analysis
53 } // namespace pwiz
54 
55 
56 #endif // _PROTEINLISTFACTORY_HPP_