GeoTessCPP  2.2.3
Software to facilitate storage and retrieval of 3D information about the Earth.
GeoTessEnumType.h
Go to the documentation of this file.
1 //- ****************************************************************************
2 //-
3 //- Copyright 2009 National Technology & Engineering Solutions of Sandia, LLC
4 //- (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
5 //- Government retains certain rights in this software.
6 //-
7 //- BSD Open Source License
8 //- All rights reserved.
9 //-
10 //- Redistribution and use in source and binary forms, with or without
11 //- modification, are permitted provided that the following conditions are met:
12 //-
13 //- 1. Redistributions of source code must retain the above copyright notice,
14 //- this list of conditions and the following disclaimer.
15 //-
16 //- 2. Redistributions in binary form must reproduce the above copyright
17 //- notice, this list of conditions and the following disclaimer in the
18 //- documentation and/or other materials provided with the distribution.
19 //-
20 //- 3. Neither the name of the copyright holder nor the names of its
21 //- contributors may be used to endorse or promote products derived from
22 //- this software without specific prior written permission.
23 //-
24 //- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 //- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 //- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 //- ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
28 //- LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 //- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 //- SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 //- INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 //- CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 //- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 //- POSSIBILITY OF SUCH DAMAGE.
35 //-
36 //- ****************************************************************************
37 
38 #ifndef ENUMTYPE_OBJECT_H
39 #define ENUMTYPE_OBJECT_H
40 
41 // **** _SYSTEM INCLUDES_ ******************************************************
42 
43 #include <iostream>
44 #include <string>
45 
46 // use standard library objects
47 using namespace std;
48 
49 // **** _LOCAL INCLUDES_ *******************************************************
50 
51 #include "CPPUtils.h"
52 
53 // **** _BEGIN GEOTESS NAMESPACE_ **********************************************
54 
55 namespace geotess
56 {
57 
58 // **** _FORWARD REFERENCES_ ***************************************************
59 
60 // **** _CLASS DEFINITION_ *****************************************************
61 
70 {
71 protected:
72 
77  : aName(""), aOrdinal(-1)
78  {
79  }
80 
85  : aName(et.aName), aOrdinal(et.aOrdinal)
86  {
87  }
88 
93  {
94  return *this;
95  }
96 
100  const string aName;
101 
105  const int aOrdinal;
106 
111  GeoTessEnumType(const string& name, int ordinal)
112  : aName(name), aOrdinal(ordinal)
113  {
114  }
115 
127  static const GeoTessEnumType* valueOf(const string& s,
128  GeoTessEnumType const* const * const array, int n);
129 
130 public:
131 
135  virtual ~GeoTessEnumType() { }
136 
140  string toString() const { return aName; }
141 
145  string name() const { return aName; }
146 
150  int ordinal() const { return aOrdinal; }
151 
155  friend bool operator==(const GeoTessEnumType& x, const GeoTessEnumType& y) { return &(x) == &(y); }
156 
160  friend bool operator!=(const GeoTessEnumType& x, const GeoTessEnumType &y) { return !(x == y); }
161 
162 };
163 // end class EnumType
164 
168 inline std::ostream& operator<<(std::ostream& o, GeoTessEnumType& s)
169 { return o << s.toString(); }
170 
171 } // end namespace geotess
172 
173 #endif // ENUMTYPE_OBJECT_H
geotess::GeoTessEnumType::~GeoTessEnumType
virtual ~GeoTessEnumType()
Definition: GeoTessEnumType.h:135
geotess
Definition: ArrayReuse.h:57
geotess::GeoTessEnumType::operator=
GeoTessEnumType & operator=(const GeoTessEnumType &et)
Definition: GeoTessEnumType.h:92
geotess::GeoTessEnumType
The base class for all "enum" types.
Definition: GeoTessEnumType.h:70
geotess::GeoTessEnumType::name
string name() const
Definition: GeoTessEnumType.h:145
geotess::GeoTessEnumType::ordinal
int ordinal() const
Definition: GeoTessEnumType.h:150
geotess::operator<<
std::ostream & operator<<(std::ostream &o, GeoTessEnumType &s)
Definition: GeoTessEnumType.h:168
geotess::GeoTessEnumType::operator==
friend bool operator==(const GeoTessEnumType &x, const GeoTessEnumType &y)
Definition: GeoTessEnumType.h:155
geotess::GeoTessEnumType::GeoTessEnumType
GeoTessEnumType()
Definition: GeoTessEnumType.h:76
geotess::GeoTessEnumType::GeoTessEnumType
GeoTessEnumType(const GeoTessEnumType &et)
Definition: GeoTessEnumType.h:84
geotess::GeoTessEnumType::aOrdinal
const int aOrdinal
Definition: GeoTessEnumType.h:105
geotess::GeoTessEnumType::toString
string toString() const
Definition: GeoTessEnumType.h:140
GEOTESS_EXP_IMP
#define GEOTESS_EXP_IMP
Definition: CPPGlobals.h:73
geotess::GeoTessEnumType::aName
const string aName
Definition: GeoTessEnumType.h:100
geotess::GeoTessEnumType::GeoTessEnumType
GeoTessEnumType(const string &name, int ordinal)
Definition: GeoTessEnumType.h:111
geotess::GeoTessEnumType::operator!=
friend bool operator!=(const GeoTessEnumType &x, const GeoTessEnumType &y)
Definition: GeoTessEnumType.h:160
CPPUtils.h
geotess::GeoTessEnumType::valueOf
static const GeoTessEnumType * valueOf(const string &s, GeoTessEnumType const *const *const array, int n)