ProteoWizard
pwiz
data
proteome
AminoAcid.hpp
Go to the documentation of this file.
1
//
2
// $Id: AminoAcid.hpp 1808 2010-02-12 21:01:48Z chambm $
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
28
#include "
pwiz/utility/misc/Export.hpp
"
29
#include "
pwiz/utility/chemistry/Chemistry.hpp
"
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
{
45
Alanine
,
46
Cysteine
,
47
AsparticAcid
,
48
GlutamicAcid
,
49
Phenylalanine
,
50
Glycine
,
51
Histidine
,
52
Isoleucine
,
53
Lysine
,
54
Leucine
,
55
Methionine
,
56
Asparagine
,
57
Proline
,
58
Glutamine
,
59
Arginine
,
60
Serine
,
61
Threonine
,
62
Valine
,
63
Tryptophan
,
64
Tyrosine
,
65
Selenocysteine
,
66
AspX
,
67
GlutX
,
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
78
struct
PWIZ_API_DECL
Record
79
{
80
std::string
name
;
81
std::string
abbreviation
;
82
char
symbol
;
83
chemistry::Formula
residueFormula
;
84
chemistry::Formula
formula
;
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
pwiz
Definition:
CwtPeakDetector.hpp:35
Phenylalanine
Phenylalanine
Definition:
AminoAcid.hpp:45
pwiz::proteome::AminoAcid::Info::Record::abbreviation
std::string abbreviation
Definition:
AminoAcid.hpp:81
Isoleucine
Isoleucine
Definition:
AminoAcid.hpp:45
pwiz::chemistry::Formula
class to represent a chemical formula
Definition:
Chemistry.hpp:133
Glutamine
Glutamine
Definition:
AminoAcid.hpp:45
Chemistry.hpp
Selenocysteine
Selenocysteine
Definition:
AminoAcid.hpp:45
pwiz::proteome::AminoAcid::Info::record
PWIZ_API_DECL const Record & record(Type type)
returns the amino acid's Record by type
Tryptophan
Tryptophan
Definition:
AminoAcid.hpp:45
AsparticAcid
AsparticAcid
Definition:
AminoAcid.hpp:45
AspX
AspX
Definition:
AminoAcid.hpp:45
Export.hpp
Methionine
Methionine
Definition:
AminoAcid.hpp:45
pwiz::proteome
Definition:
AminoAcid.hpp:35
Threonine
Threonine
Definition:
AminoAcid.hpp:45
Cysteine
Cysteine
Definition:
AminoAcid.hpp:45
pwiz::proteome::AminoAcid::Info::Record::symbol
char symbol
Definition:
AminoAcid.hpp:82
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
Proline
Proline
Definition:
AminoAcid.hpp:45
pwiz::proteome::AminoAcid::Info::Record::name
std::string name
Definition:
AminoAcid.hpp:80
pwiz::proteome::AminoAcid::Info::Record::formula
chemistry::Formula formula
Definition:
AminoAcid.hpp:84
Asparagine
Asparagine
Definition:
AminoAcid.hpp:45
PWIZ_API_DECL
#define PWIZ_API_DECL
Definition:
Export.hpp:32
GlutX
GlutX
Definition:
AminoAcid.hpp:45
Tyrosine
Tyrosine
Definition:
AminoAcid.hpp:45
Arginine
Arginine
Definition:
AminoAcid.hpp:45
Histidine
Histidine
Definition:
AminoAcid.hpp:45
Lysine
Lysine
Definition:
AminoAcid.hpp:45
Valine
Valine
Definition:
AminoAcid.hpp:45
pwiz::proteome::AminoAcid::Info::Record
struct for holding data for a single amino acid
Definition:
AminoAcid.hpp:78
GlutamicAcid
GlutamicAcid
Definition:
AminoAcid.hpp:45
Leucine
Leucine
Definition:
AminoAcid.hpp:45
Alanine
Alanine
Definition:
AminoAcid.hpp:45
pwiz::chemistry::detail::Type
pwiz::chemistry::Element::Type Type
Definition:
ChemistryData.hpp:37
Glycine
Glycine
Definition:
AminoAcid.hpp:45
Serine
Serine
Definition:
AminoAcid.hpp:45
Generated by
1.8.12