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
34namespace pwiz {
35namespace proteome {
36
37
38/// scope for types related to amino acids
39namespace AminoAcid {
40
41
42/// enumeration of the amino acids
43enum PWIZ_API_DECL Type
44{
68 Unknown
69};
70
71
72/// class for accessing information about the amino acids
73namespace Info
74{
75
76
77/// struct for holding data for a single amino acid
87
88
89/// returns the amino acid's Record by type
90PWIZ_API_DECL const Record& record(Type type);
91
92
93/// returns the amino acid's Record by symbol (may throw)
94PWIZ_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
GlutamicAcid
Definition AminoAcid.hpp:48
Arginine
Definition AminoAcid.hpp:59
Selenocysteine
Definition AminoAcid.hpp:65
Alanine
Definition AminoAcid.hpp:45
Cysteine
Definition AminoAcid.hpp:46
Methionine
Definition AminoAcid.hpp:55
Lysine
Definition AminoAcid.hpp:53
Tryptophan
Definition AminoAcid.hpp:63
Glycine
Definition AminoAcid.hpp:50
Asparagine
Definition AminoAcid.hpp:56
Phenylalanine
Definition AminoAcid.hpp:49
Leucine
Definition AminoAcid.hpp:54
Glutamine
Definition AminoAcid.hpp:58
AsparticAcid
Definition AminoAcid.hpp:47
Histidine
Definition AminoAcid.hpp:51
Valine
Definition AminoAcid.hpp:62
Threonine
Definition AminoAcid.hpp:61
AspX
Definition AminoAcid.hpp:66
Tyrosine
Definition AminoAcid.hpp:64
Serine
Definition AminoAcid.hpp:60
GlutX
Definition AminoAcid.hpp:67
Isoleucine
Definition AminoAcid.hpp:52
Proline
Definition AminoAcid.hpp:57
#define PWIZ_API_DECL
Definition Export.hpp:32
class to represent a chemical formula
PWIZ_API_DECL const Record & record(Type type)
returns the amino acid's Record by type
struct for holding data for a single amino acid
Definition AminoAcid.hpp:79