<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>GG: Enum.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GG
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a8649c70aabfef076611d3be10291d33.html">GG</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#namespaces">Namespaces</a> |
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Enum.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <boost/config.hpp></code><br/>
<code>#include <map></code><br/>
<code>#include <string></code><br/>
</div>
<p><a href="Enum_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structGG_1_1EnumMapBase.html">GG::EnumMapBase</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A base type for all templated <a class="el" href="structGG_1_1EnumMap.html" title="A mapping between the values of an enum and the string representations of the enum's values...">EnumMap</a> types. <a href="structGG_1_1EnumMapBase.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structGG_1_1EnumMap.html">GG::EnumMap< E ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A mapping between the values of an enum and the string representations of the enum's values. <a href="structGG_1_1EnumMap.html#details">More...</a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceGG"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGG.html">GG</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a4d0a16fd972ecd9aeb9d1f410dfe4685"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Enum_8h.html#a4d0a16fd972ecd9aeb9d1f410dfe4685">GG_ENUM_MAP_BEGIN</a>(name)</td></tr>
<tr class="memitem:abd261e84febc33093021ec284a870bfe"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Enum_8h.html#abd261e84febc33093021ec284a870bfe">GG_ENUM_MAP_INSERT</a>(value)   m_map[ value ] = #value ;</td></tr>
<tr class="memitem:a8491f1bc4e9dd8f62489dab7eac662ca"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Enum_8h.html#a8491f1bc4e9dd8f62489dab7eac662ca">GG_ENUM_MAP_END</a></td></tr>
<tr class="memitem:aeaf16da5e849135eb60ba1e18e8d11f8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Enum_8h.html#aeaf16da5e849135eb60ba1e18e8d11f8">GG_ENUM_STREAM_IN</a>(name)</td></tr>
<tr class="memitem:a2860ea0bc28af5ef1a48ace97d4c4683"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Enum_8h.html#a2860ea0bc28af5ef1a48ace97d4c4683">GG_ENUM_STREAM_OUT</a>(name)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae7ae6563930ab8e329b2526aa18c9eb3"><td class="memTemplParams" colspan="2">template<class E > </td></tr>
<tr class="memitem:ae7ae6563930ab8e329b2526aa18c9eb3"><td class="memTemplItemLeft" align="right" valign="top">EnumMap< E > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceGG.html#ae7ae6563930ab8e329b2526aa18c9eb3">GG::GetEnumMap</a> ()</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Contains the utility classes and macros that allow for easy conversion to and from an enum value and its textual representation. </p>
<p>Definition in file <a class="el" href="Enum_8h_source.html">Enum.h</a>.</p>
</div><hr/><h2>Macro Definition Documentation</h2>
<a class="anchor" id="a4d0a16fd972ecd9aeb9d1f410dfe4685"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GG_ENUM_MAP_BEGIN</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">template</span> <> <span class="keyword">struct </span>EnumMap< name > : EnumMapBase \</div>
<div class="line">{ \</div>
<div class="line"> typedef name EnumType; \</div>
<div class="line"> typedef std::map<EnumType, std::string> MapType; \</div>
<div class="line"> EnumMap () \</div>
<div class="line"> {</div>
</div><!-- fragment --><p>Declares the beginning of a template specialization of EnumMap, for enumerated type <em>name</em>. Text-to-enum conversion is one of those places that calls for macro magic. To use these for e.g. "enum Foo {FOO, BAR};", write: </p>
<pre class="fragment"> GG_ENUM_MAP_BEGIN( Foo )
GG_ENUM_MAP_INSERT( FOO )
GG_ENUM_MAP_INSERT( BAR )
...
GG_ENUM_MAP_END </pre>
<p>Definition at line <a class="el" href="Enum_8h_source.html#l00088">88</a> of file <a class="el" href="Enum_8h_source.html">Enum.h</a>.</p>
</div>
</div>
<a class="anchor" id="abd261e84febc33093021ec284a870bfe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GG_ENUM_MAP_INSERT</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">value</td><td>)</td>
<td>   m_map[ value ] = #value ;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a single value from an enumerated type, and its corresponding string representation, to an EnumMap. </p>
<p>Definition at line <a class="el" href="Enum_8h_source.html#l00098">98</a> of file <a class="el" href="Enum_8h_source.html">Enum.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8491f1bc4e9dd8f62489dab7eac662ca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GG_ENUM_MAP_END</td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">} \</div>
<div class="line"> virtual <span class="keyword">const</span> std::string& FromEnum(<span class="keywordtype">long</span> <span class="keywordtype">int</span> i) <span class="keyword">const</span> \</div>
<div class="line"> { \</div>
<div class="line"> static <span class="keyword">const</span> std::string ERROR_STR; \</div>
<div class="line"> std::map<EnumType, std::string>::const_iterator it = \</div>
<div class="line"> m_map.find(EnumType(i)); \</div>
<div class="line"> return it == m_map.end() ? ERROR_STR : it->second; \</div>
<div class="line"> } \</div>
<div class="line"> long <span class="keywordtype">int</span> FromString (<span class="keyword">const</span> std::string &str) <span class="keyword">const</span> \</div>
<div class="line"> { \</div>
<div class="line"> for (MapType::const_iterator it = m_map.begin(); \</div>
<div class="line"> it != m_map.end(); \</div>
<div class="line"> ++it) { \</div>
<div class="line"> if (it->second == str) \</div>
<div class="line"> return it->first; \</div>
<div class="line"> } \</div>
<div class="line"> return BAD_VALUE; \</div>
<div class="line"> } \</div>
<div class="line"> MapType m_map; \</div>
<div class="line">};</div>
</div><!-- fragment --><p>Declares the end of a template specialization of EnumMap, for enumerated type <em>name</em>. </p>
<p>Definition at line <a class="el" href="Enum_8h_source.html#l00102">102</a> of file <a class="el" href="Enum_8h_source.html">Enum.h</a>.</p>
</div>
</div>
<a class="anchor" id="aeaf16da5e849135eb60ba1e18e8d11f8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GG_ENUM_STREAM_IN</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">inline</span> std::istream& operator>>(std::istream& is, name& v) \</div>
<div class="line"> { \</div>
<div class="line"> std::string str; \</div>
<div class="line"> is >> str; \</div>
<div class="line"> v = name (GG::GetEnumMap< name >().FromString(str)); \</div>
<div class="line"> return is; \</div>
<div class="line"> }</div>
</div><!-- fragment --><p>Defines an input stream operator for enumerated type <em>name</em>. Note that the generated function requires that EnumMap<name> be defined. </p>
<p>Definition at line <a class="el" href="Enum_8h_source.html#l00126">126</a> of file <a class="el" href="Enum_8h_source.html">Enum.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2860ea0bc28af5ef1a48ace97d4c4683"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GG_ENUM_STREAM_OUT</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">inline</span> std::ostream& <a class="code" href="namespaceGG.html#aa60faa1240dadf5dc8f284286b29b7cd">operator<<</a>(std::ostream& os, name v) \</div>
<div class="line"> { \</div>
<div class="line"> os << GG::GetEnumMap< name >().FromEnum(v); \</div>
<div class="line"> return os; \</div>
<div class="line"> }</div>
</div><!-- fragment --><p>Defines an output stream operator for enumerated type <em>name</em>. Note that the generated function requires that EnumMap<name> be defined. </p>
<p>Definition at line <a class="el" href="Enum_8h_source.html#l00137">137</a> of file <a class="el" href="Enum_8h_source.html">Enum.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 15 2012 15:13:31 for GG by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1
</small></address>
</body>
</html>
