NCBI C++ ToolKit
user_type.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 #ifndef GUI_UTILS___USER_TYPE__HPP
2 #define GUI_UTILS___USER_TYPE__HPP
3 
4 /* $Id: user_type.hpp 26143 2012-07-25 19:53:48Z falkrb $
5  * ===========================================================================
6  *
7  * PUBLIC DOMAIN NOTICE
8  * National Center for Biotechnology Information
9  *
10  * This software/database is a "United States Government Work" under the
11  * terms of the United States Copyright Act. It was written as part of
12  * the author's official duties as a United States Government employee and
13  * thus cannot be copyrighted. This software/database is freely available
14  * to the public for use. The National Library of Medicine and the U.S.
15  * Government have not placed any restriction on its use or reproduction.
16  *
17  * Although all reasonable efforts have been taken to ensure the accuracy
18  * and reliability of the software and data, the NLM and the U.S.
19  * Government do not and cannot warrant the performance or results that
20  * may be obtained by using this software or data. The NLM and the U.S.
21  * Government disclaim all warranties, express or implied, including
22  * warranties of performance, merchantability or fitness for any particular
23  * purpose.
24  *
25  * Please cite the author in any work or product based on this material.
26  *
27  * ===========================================================================
28  *
29  * Authors: Andrey Yazhuk
30  *
31  * File Description:
32  *
33  */
34 
35 #include <corelib/ncbistr.hpp>
36 
37 #include <gui/gui_export.h>
38 
39 /** @addtogroup GUI_UTILS
40  *
41  * @{
42  */
43 
45 
46 
47 ///////////////////////////////////////////////////////////////////////////////
48 /// CGUIUserType
50 {
51 public:
52  // Type definitions
53  static const string sm_Tp_Undefined;
54 
55  static const string sm_Tp_Alignment;
56  static const string sm_Tp_Alignment_Set;
57  static const string sm_Tp_Annotation;
58  static const string sm_Tp_EntrezGeneRecord;
59  static const string sm_Tp_EntrezRecord;
60  static const string sm_Tp_Feature;
61  static const string sm_Tp_Location;
62  static const string sm_Tp_PhylogeneticTree;
63  static const string sm_Tp_TaxId_Set;
64  static const string sm_Tp_Sequence;
65  static const string sm_Tp_Sequence_ID;
66  static const string sm_Tp_Sequence_Set;
67  static const string sm_Tp_Submission;
68  static const string sm_Tp_TaxPlotData;
69  static const string sm_Tp_ValidationResult;
70  static const string sm_Tp_SeqTable;
71  static const string sm_Tp_Variation;
72 
73  static const string sm_Tp_Project;
74  static const string sm_Tp_ProjectItem;
75  static const string sm_Tp_Workspace;
76 
77  // User subtypes - sorted alphabetically, grouped by type
78  static const string sm_SbTp_Undefined;
79 
80  // Sequence subtypes
81  static const string sm_SbTp_DNA;
82  static const string sm_SbTp_Protein;
83 
84  // Annotation subtypes
85  static const string sm_SbTp_Alignments;
86  static const string sm_SbTp_Features;
87  static const string sm_SbTp_Graphs;
88  static const string sm_SbTp_Sequence_IDs;
89  static const string sm_SbTp_Locations;
90  static const string sm_SbTp_Table;
91 
92  // Bioseq Set subtypes
93  static const string sm_SbTp_NucProt;
94  static const string sm_SbTp_SegSeq;
95  static const string sm_SbTp_GenProdSet;
96 
97  static const string sm_SbTp_PopSet;
98  static const string sm_SbTp_PhySet;
99  static const string sm_SbTp_EcoSet;
100  static const string sm_SbTp_MutSet;
101 
102  static const string sm_SbTp_PopSet_Aln;
103  static const string sm_SbTp_PhySet_Aln;
104  static const string sm_SbTp_EcoSet_Aln;
105  static const string sm_SbTp_MutSet_Aln;
106 
107  // Project subtypes
108  static const string sm_SbTp_ProjectVer1;
109  static const string sm_SbTp_ProjectVer2;
110 
111  CGUIUserType();
112  CGUIUserType(const string& type, const string& subtype = sm_SbTp_Undefined);
113  bool operator<(const CGUIUserType& other) const;
114 
115  string m_Type;
116  string m_Subtype;
117 };
118 
119 
121 
122 /* @} */
123 
124 #endif // GUI_UTILS___USER_TYPE__HPP
CGUIUserType.
Definition: user_type.hpp:50
The NCBI C++ standard methods for dealing with std::string.
bool operator<(const CEquivRange &A, const CEquivRange &B)
string m_Type
Definition: user_type.hpp:115
static const string sm_Tp_Sequence
Definition: user_type.hpp:64
static const string sm_Tp_ProjectItem
Definition: user_type.hpp:74
static const string sm_Tp_EntrezGeneRecord
Definition: user_type.hpp:58
static const string sm_Tp_Alignment
Definition: user_type.hpp:55
static const string sm_Tp_Undefined
Definition: user_type.hpp:53
static const string sm_Tp_Annotation
Definition: user_type.hpp:57
static const string sm_Tp_Sequence_Set
Definition: user_type.hpp:66
string m_Subtype
Definition: user_type.hpp:116
static const string sm_SbTp_PhySet
Definition: user_type.hpp:98
static const string sm_SbTp_MutSet_Aln
Definition: user_type.hpp:105
static const string sm_SbTp_PhySet_Aln
Definition: user_type.hpp:103
static const string sm_SbTp_Undefined
Definition: user_type.hpp:78
static const string sm_SbTp_DNA
Definition: user_type.hpp:81
static const string sm_SbTp_EcoSet
Definition: user_type.hpp:99
static const string sm_Tp_TaxId_Set
Definition: user_type.hpp:63
static const string sm_SbTp_Graphs
Definition: user_type.hpp:87
static const string sm_SbTp_NucProt
Definition: user_type.hpp:93
static const string sm_Tp_Feature
Definition: user_type.hpp:60
static const string sm_SbTp_PopSet_Aln
Definition: user_type.hpp:102
static const string sm_SbTp_EcoSet_Aln
Definition: user_type.hpp:104
static const string sm_SbTp_GenProdSet
Definition: user_type.hpp:95
static const string sm_Tp_Alignment_Set
Definition: user_type.hpp:56
static const string sm_SbTp_Features
Definition: user_type.hpp:86
static const string sm_SbTp_Sequence_IDs
Definition: user_type.hpp:88
static const string sm_Tp_Submission
Definition: user_type.hpp:67
static const string sm_SbTp_Table
Definition: user_type.hpp:90
static const string sm_Tp_ValidationResult
Definition: user_type.hpp:69
static const string sm_SbTp_Protein
Definition: user_type.hpp:82
static const string sm_Tp_EntrezRecord
Definition: user_type.hpp:59
static const string sm_Tp_SeqTable
Definition: user_type.hpp:70
static const string sm_SbTp_ProjectVer1
Definition: user_type.hpp:108
static const string sm_SbTp_MutSet
Definition: user_type.hpp:100
static const string sm_SbTp_ProjectVer2
Definition: user_type.hpp:109
static const string sm_Tp_PhylogeneticTree
Definition: user_type.hpp:62
static const string sm_SbTp_SegSeq
Definition: user_type.hpp:94
static const string sm_SbTp_Locations
Definition: user_type.hpp:89
static const string sm_SbTp_PopSet
Definition: user_type.hpp:97
static const string sm_Tp_Workspace
Definition: user_type.hpp:75
static const string sm_Tp_Variation
Definition: user_type.hpp:71
static const string sm_SbTp_Alignments
Definition: user_type.hpp:85
static const string sm_Tp_Sequence_ID
Definition: user_type.hpp:65
static const string sm_Tp_Location
Definition: user_type.hpp:61
static const string sm_Tp_TaxPlotData
Definition: user_type.hpp:68
static const string sm_Tp_Project
Definition: user_type.hpp:73
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
#define NCBI_GUIOBJUTILS_EXPORT
Definition: gui_export.h:512
Defines to provide correct exporting from DLLs in Windows.
Definition: type.c:6
Modified on Sun Apr 14 05:27:01 2024 by modify_doxy.py rev. 669887