ProteoWizard
AminoAcid.hpp
Go to the documentation of this file.
1 //
2 // $Id$
3 //
4 //
5 // Original author: Darren Kessner <darren@proteowizard.org>
6 //
7 // Copyright 2006 Louis Warschaw Prostate Cancer Center
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 _AMINOACID_HPP_
25 #define _AMINOACID_HPP_
26 
27 
30 #include <string>
31 #include <memory>
32 
33 
34 namespace pwiz {
35 namespace proteome {
36 
37 
38 /// scope for types related to amino acids
39 namespace AminoAcid {
40 
41 
42 /// enumeration of the amino acids
43 enum PWIZ_API_DECL Type
44 {
68  Unknown
69 };
70 
71 
72 /// class for accessing information about the amino acids
73 namespace Info
74 {
75 
76 
77 /// struct for holding data for a single amino acid
79 {
80  std::string name;
81  std::string abbreviation;
82  char symbol;
85  double abundance;
86 };
87 
88 
89 /// returns the amino acid's Record by type
90 PWIZ_API_DECL const Record& record(Type type);
91 
92 
93 /// returns the amino acid's Record by symbol (may throw)
94 PWIZ_API_DECL const Record& record(char symbol);
95 
96 
97 } // namespace Info
98 } // namespace AminoAcid
99 
100 
101 } // namespace proteome
102 } // namespace pwiz
103 
104 
105 #endif // _AMINOACID_HPP_
106 
Isoleucine
Isoleucine
Definition: AminoAcid.hpp:52
Selenocysteine
Selenocysteine
Definition: AminoAcid.hpp:65
pwiz
Definition: ChromatogramList_Filter.hpp:36
pwiz::proteome::AminoAcid::Info::Record::formula
chemistry::Formula formula
Definition: AminoAcid.hpp:84
Phenylalanine
Phenylalanine
Definition: AminoAcid.hpp:49
pwiz::proteome
Definition: AminoAcid.hpp:35
pwiz::chemistry::Formula
class to represent a chemical formula
Definition: Chemistry.hpp:133
Tryptophan
Tryptophan
Definition: AminoAcid.hpp:63
PWIZ_API_DECL
#define PWIZ_API_DECL
Definition: Export.hpp:32
Threonine
Threonine
Definition: AminoAcid.hpp:61
Glutamine
Glutamine
Definition: AminoAcid.hpp:58
AspX
AspX
Definition: AminoAcid.hpp:66
Methionine
Methionine
Definition: AminoAcid.hpp:55
Export.hpp
Proline
Proline
Definition: AminoAcid.hpp:57
AsparticAcid
AsparticAcid
Definition: AminoAcid.hpp:47
Cysteine
Cysteine
Definition: AminoAcid.hpp:46
pwiz::proteome::AminoAcid::Info::Record
struct for holding data for a single amino acid
Definition: AminoAcid.hpp:78
Tyrosine
Tyrosine
Definition: AminoAcid.hpp:64
Arginine
Arginine
Definition: AminoAcid.hpp:59
pwiz::proteome::AminoAcid::Info::Record::abbreviation
std::string abbreviation
Definition: AminoAcid.hpp:81
pwiz::proteome::AminoAcid::Info::Record::symbol
char symbol
Definition: AminoAcid.hpp:82
Asparagine
Asparagine
Definition: AminoAcid.hpp:56
GlutX
GlutX
Definition: AminoAcid.hpp:67
pwiz::proteome::AminoAcid::Info::Record::residueFormula
chemistry::Formula residueFormula
Definition: AminoAcid.hpp:83
pwiz::proteome::AminoAcid::Info::Record::abundance
double abundance
Definition: AminoAcid.hpp:85
Histidine
Histidine
Definition: AminoAcid.hpp:51
pwiz::proteome::AminoAcid::Info::record
const PWIZ_API_DECL Record & record(Type type)
returns the amino acid's Record by type
GlutamicAcid
GlutamicAcid
Definition: AminoAcid.hpp:48
Valine
Valine
Definition: AminoAcid.hpp:62
Lysine
Lysine
Definition: AminoAcid.hpp:53
pwiz::proteome::AminoAcid::Info::Record::name
std::string name
Definition: AminoAcid.hpp:80
Leucine
Leucine
Definition: AminoAcid.hpp:54
pwiz::chemistry::detail::Type
pwiz::chemistry::Element::Type Type
Definition: ChemistryData.hpp:37
Alanine
Alanine
Definition: AminoAcid.hpp:45
Glycine
Glycine
Definition: AminoAcid.hpp:50
Serine
Serine
Definition: AminoAcid.hpp:60
Chemistry.hpp