File: Species.h

package info (click to toggle)
caret 5.6.4~dfsg.1-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 31,904 kB
  • ctags: 28,901
  • sloc: cpp: 378,050; python: 6,718; ansic: 5,507; makefile: 333; sh: 46
file content (115 lines) | stat: -rw-r--r-- 2,927 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

#ifndef __SPECIES_H__
#define __SPECIES_H__

/*LICENSE_START*/
/*
 *  Copyright 1995-2002 Washington University School of Medicine
 *
 *  http://brainmap.wustl.edu
 *
 *  This file is part of CARET.
 *
 *  CARET is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  CARET is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with CARET; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
/*LICENSE_END*/

#include <QString>
#include <vector>

/// defines valid species
class Species {
   public:
      /// type of species
      enum TYPE {
         /// unknown
         TYPE_UNKNOWN,
         /// baboon
         TYPE_BABOON,
         /// chimpanzee
         TYPE_CHIMPANZEE,
         /// ferret
         TYPE_FERRET,
         /// galago
         TYPE_GALAGO,
         /// gibbon
         TYPE_GIBBON,
         /// gorilla
         TYPE_GORILLA,
         /// human
         TYPE_HUMAN,
         /// macaque monkey
         TYPE_MACAQUE,
         /// mouse
         TYPE_MOUSE,
         /// orangutan
         TYPE_ORANGUTAN,
         /// rat
         TYPE_RAT,
         /// other
         TYPE_OTHER
      };
      
      // get a list of valid species types and names
      static void getAllSpeciesTypesAndNames(std::vector<TYPE>& speciesTypesOut,
                                             std::vector<QString>& speciesNamesOut);
      
      // constructor
      Species();
      
      // constructor
      Species(const TYPE t);
      
      // constructor
      Species(const QString& name);
      
      // destructor
      ~Species();
      
      /// equality operator
      bool operator==(const Species& ss) { return (type == ss.type); }
      
      /// inequality operator
      bool operator!=(const Species& ss) { return (type != ss.type); }
      
      // reset
      void reset();
      
      // get species name
      QString getName() const;
      
      /// get the species type
      TYPE getType() const { return type; }
      
      // set the species using type
      void setUsingType(const TYPE typeIn);
      
      // set the species using name
      void setUsingName(const QString& nameIn);
      
      // is human
      bool isHuman() const { return type == TYPE_HUMAN; }
      
      // is valid (not unknown)
      bool isValid() const { return type != TYPE_UNKNOWN; }
      
   protected:
      /// the species type
      TYPE type;
};

#endif // __SPECIES_H__