[lmi-commits] [lmi] master dec08c1 1/4: Enumerate some lingo strings for 'sample' product

[Greg Chicares]

branch: master
commit dec08c1c685eabb9995c5a1c1ac10c9536e50b75
Author: Gregory W. Chicares <gchicares@sbcglobal.net>
Commit: Gregory W. Chicares <gchicares@sbcglobal.net>

    Enumerate some lingo strings for 'sample' product
---
 sample.hpp | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/sample.hpp b/sample.hpp
index 01024ae..ebcfdda 100644
--- a/sample.hpp
+++ b/sample.hpp
@@ -24,6 +24,34 @@
 
 #include "config.hpp"
 
-// Coming soon...
+// For now, this file contains only an enumeration, but someday it may
+// include other information that applies to an entire portfolio.
+
+/// For the fictional Superior Life Insurance Company of Superior, WI.
+
+namespace superior
+{
+/// Enumerate lingo strings.
+///
+/// This is deliberately defined with enum-key 'enum' rather than
+/// 'enum class' or 'enum struct'. Because it is defined inside a
+/// namespace, with an enum-base, it is the same as an 'enum class'
+/// except that its enumerators decay to int as nature intended.
+/// Feature comparison:
+///
+///   this enum  enum class   desirable properties
+///   ---------  ----------   --------------------
+///      yes        yes       avoids polluting global namespace
+///      yes        yes       specifies underlying type
+///      yes         no       implicitly converts to int
+///
+/// Use nondefault initializers just to demonstrate that they work.
+/// Ultimately, enumerator zero will be reserved for an empty string.
+
+enum lingo : int
+    {policy_form       = 13
+    ,policy_form_KS_KY = 0
+    };
+} // namespace superior
 
 #endif // sample_hpp