mirror of
https://github.com/mcneel/opennurbs.git
synced 2026-03-31 16:26:51 +08:00
91 lines
75 KiB
HTML
91 lines
75 KiB
HTML
<!-- HTML header for doxygen 1.8.13-->
|
|
<!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"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>openNURBS SDK Help: D:/BuildAgent/work/d8e3bf9e94f4c621/src4/bin/opennurbs_public/opennurbs_lookup.h Source File</title>
|
|
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
|
|
<!-- <script type="text/javascript" src="../../jquery.js"></script> -->
|
|
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
|
|
<script type="text/javascript" src="../../dynsections.js"></script>
|
|
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../customdoxygen.css" rel="stylesheet" type="text/css"/>
|
|
<!-- bootstrap -->
|
|
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
|
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
|
|
<!-- smartmenus -->
|
|
<link href="../../jquery.smartmenus.bootstrap.css" rel="stylesheet">
|
|
<script type="text/javascript" src="../../jquery.smartmenus.js"></script>
|
|
<script type="text/javascript" src="../../jquery.smartmenus.bootstrap.js"></script>
|
|
</head>
|
|
<body>
|
|
<!-- <div class="version-banner">
|
|
Go back to the <a href="/">main site</a>...
|
|
</div> -->
|
|
<div class="container">
|
|
<!-- navbar -->
|
|
<nav class="navbar navbar-default">
|
|
<div class="container-fluid">
|
|
<a class="navbar-brand" href="#">openNURBS SDK Help</a>
|
|
<div class="navbar-collapse collapse" id="main-nav-placeholder">
|
|
<!-- <p class="navbar-text navbar-right">v6.0</p> -->
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li class="dropdown">
|
|
<a class="dropdown-toggle" href="#">v6.0 <span class="caret"></span></a>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="#">Latest (6.x)</a></li>
|
|
<li class="disabled"><a href="#">WIP (7.x)</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div class="page-content">
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript" src="../../menudata.js"></script>
|
|
<script type="text/javascript" src="../../menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('../../',false,false,'search.php','Search');
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="../../dir_2ea30aa2956a8db99dd22aa5e597f384.html">bin</a></li><li class="navelem"><a class="el" href="../../dir_7a6cfee8d318bd47c162fe536aecd3a7.html">opennurbs_public</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">opennurbs_lookup.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* $NoKeywords: $ */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright (c) 1993-2012 Robert McNeel & Associates. All rights reserved.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// OpenNURBS, Rhinoceros, and Rhino3D are registered trademarks of Robert</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// McNeel & Associates.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// ALL IMPLIED WARRANTIES OF FITNESS FOR ANY PARTICULAR PURPOSE AND OF</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// MERCHANTABILITY ARE HEREBY DISCLAIMED.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// </span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// For complete openNURBS copyright information see <http://www.opennurbs.org>.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">//</span><span class="comment"></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span>*/</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#if !defined(OPENNURBS_MAP_INC_)</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define OPENNURBS_MAP_INC_</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/*</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">Description:</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> ON_SerialNumberMap provides a way to map set of unique </span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> serial number - uuid pairs to application defined values</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> so that adding, finding and removing serial numbers is </span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> fast and efficient. The class is designed to handle</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> several millions of unique serial numbers. There are no</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> restrictions on what order numbers are added and removed.</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> The minimum memory footprint is less than 150KB and doesn't</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> increase until you have more than 8000 serial numbers.</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> It is possible to have an active serial number and an</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> inactive id.</span></div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="../../d4/d1e/class_o_n___serial_number_map.html"> 32</a></span> <span class="comment">*/</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>ON_CLASS <a class="code" href="../../d4/d1e/class_o_n___serial_number_map.html">ON_SerialNumberMap</a></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="../../d4/d1e/class_o_n___serial_number_map.html">ON_SerialNumberMap</a>();</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  ~<a class="code" href="../../d4/d1e/class_o_n___serial_number_map.html">ON_SerialNumberMap</a>();</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="../../d0/df3/struct_o_n___serial_number_map_1_1_m_a_p___v_a_l_u_e.html"> 38</a></span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">struct </span><a class="code" href="../../d0/df3/struct_o_n___serial_number_map_1_1_m_a_p___v_a_l_u_e.html">MAP_VALUE</a></div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="../../d0/df3/struct_o_n___serial_number_map_1_1_m_a_p___v_a_l_u_e.html#af5bf4cb21eedea3e3c48a5f0f204010a"> 40</a></span>  {</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="../../d0/df3/struct_o_n___serial_number_map_1_1_m_a_p___v_a_l_u_e.html#a19540dfcebb4ffd6b70f4288681e2e0d"> 41</a></span>  ON__UINT32 m_u_type;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  ON__UINT32 m_u32;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">union</span></div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="../../d0/df3/struct_o_n___serial_number_map_1_1_m_a_p___v_a_l_u_e.html#ae4be432e70e330db45b5dbacd866d694"> 44</a></span>  {</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="../../d0/df3/struct_o_n___serial_number_map_1_1_m_a_p___v_a_l_u_e.html#ad28a5bef61555d499454c97c5d0c5454"> 45</a></span>  ON__UINT64 u64;</div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="../../d0/df3/struct_o_n___serial_number_map_1_1_m_a_p___v_a_l_u_e.html#a2bc3052035a2eb9a1fe39d1be7a64dce"> 46</a></span>  ON__INT64 i64;</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="../../d0/df3/struct_o_n___serial_number_map_1_1_m_a_p___v_a_l_u_e.html#ae22d4f243139a608c478d88558b97bb9"> 47</a></span>  <span class="keywordtype">void</span>* ptr;</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="../../d0/df3/struct_o_n___serial_number_map_1_1_m_a_p___v_a_l_u_e.html#ab1d7af9c19ef56a7cee9440c545e8556"> 48</a></span>  ON__UINT32 ui[2];</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  ON__INT32 i[2];</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  } m_u;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  };</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html"> 52</a></span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">struct </span><a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">SN_ELEMENT</a></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  {<span class="comment"></span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> ////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span> <span class="comment">//</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// ID</span></div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html#a65a110d27c107020f918af715ebed401"> 58</a></span>  <span class="comment">//</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> m_id;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> ////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span> <span class="comment">//</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// Serial number:</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">//</span></div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html#a0e3c6f00627cf99b06e75f7f386f38fe"> 65</a></span>  ON__UINT64 <a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html#a0e3c6f00627cf99b06e75f7f386f38fe">m_sn</a>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> ////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span> <span class="comment">//</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// Status flags:</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">//</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">// If m_id_active is 1, then m_sn_active must be 1.</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// If m_sn_active = 1, then m_id_active can be 0 or 1.</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  ON__UINT8 m_sn_active; <span class="comment">// 1 = serial number is active</span></div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html#ae731a01b5f757ee774b0ad79be683032"> 74</a></span>  ON__UINT8 m_id_active; <span class="comment">// 1 = id is active</span></div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html#a2c107f25a86e791ee31fcf743e96b25f"> 75</a></span>  ON__UINT8 m_reserved1;</div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html#ad79fb78baedb63264a5f5929b5f2855d"> 76</a></span>  ON__UINT8 m_reserved2;</div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html#a0cc754de81268145e3b7e96df44c423a"> 77</a></span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  ON__UINT32 m_id_crc32; <span class="comment">// id hash = IdCRC(id)</span></div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html#aad87ba2dab8d489ca47ab96c672e32ab"> 79</a></span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">struct </span><a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">SN_ELEMENT</a>* m_next; <span class="comment">// id hash table linked list</span></div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html#ac54595d1c808e5866ba46f0b0302042e"> 81</a></span> <span class="comment"></span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> ////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"></span> <span class="comment">//</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">// User information:</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="comment">//</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="comment">// ON_SerialNumberMap does not use the m_value field.</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="comment">// When a new element is added, m_value is memset to</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="comment">// zero. Other than that, m_value is not changed by</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="comment">// this class. The location of m_value in memory,</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="comment">// (&m_value) may change at any time.</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">struct </span><a class="code" href="../../d0/df3/struct_o_n___serial_number_map_1_1_m_a_p___v_a_l_u_e.html">MAP_VALUE</a> m_value;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html#a81e1534a20b27acf1b59ae33eb7b95a0"> 93</a></span>  <span class="keywordtype">void</span> Dump(<a class="code" href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a>&) <span class="keyword">const</span>;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  };</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="comment">/*</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> Number of active serial numbers in the list.</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> */</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  ON__UINT64 ActiveSerialNumberCount() <span class="keyword">const</span>;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="comment">/*</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> Number of active ids in the list. This number</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> is less than or equal to ActiveSerialNumberCount().</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> */</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  ON__UINT64 ActiveIdCount() <span class="keyword">const</span>;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="comment">/*</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> The active element with the smallest serial number, </span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> or null if the list is empty.</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> Restrictions:</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> The returned pointer may become invalid after any</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> subsequent calls to any function in this class. </span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> If you need to save information in the returned</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> SN_ELEMENT for future use, you must copy the </span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> information into storage you are managing.</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"></span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> You may change the value of the SN_ELEMENT's m_value</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> field. You must NEVER change any other SN_ELEMENT</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> fields or you will break searching and possibly cause</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> crashes.</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> */</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">struct </span><a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">SN_ELEMENT</a>* FirstElement() <span class="keyword">const</span>;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="comment">/*</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> The active element with the biggest serial number,</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> or null if the list is empty.</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> Restrictions:</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> The returned pointer may become invalid after any</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> subsequent calls to any function in this class. </span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> If you need to save information in the returned</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> SN_ELEMENT for future use, you must copy the </span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> information into storage you are managing.</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"></span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> You may change the value of the SN_ELEMENT's m_value</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> field. You must NEVER change any other SN_ELEMENT</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> fields or you will break searching and possibly cause</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> crashes.</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> */</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">struct </span><a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">SN_ELEMENT</a>* LastElement() <span class="keyword">const</span>;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="comment">/*</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> sn - [in] serial number to search for.</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> If the serial number is active, a pointer to</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> its element is returned.</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> Restrictions:</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> The returned pointer may become invalid after any</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> subsequent calls to any function in this class. </span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> If you need to save information in the returned</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> SN_ELEMENT for future use, you must copy the </span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> information into storage you are managing.</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"></span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> You may change the value of the SN_ELEMENT's m_value</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> field. You must NEVER change any other SN_ELEMENT</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> fields or you will break searching and possibly cause</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> crashes.</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> */</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keyword">struct </span><a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">SN_ELEMENT</a>* FindSerialNumber(ON__UINT64 sn) <span class="keyword">const</span>;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="comment">/*</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> id - [in] id number to search for.</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> If the id is active, a pointer to</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> its element is returned.</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> Restrictions:</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> The returned pointer may become invalid after any</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> subsequent calls to any function in this class. </span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> If you need to save information in the returned</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> SN_ELEMENT for future use, you must copy the </span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> information into storage you are managing.</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"></span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> You may change the value of the SN_ELEMENT's m_value</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> field. You must NEVER change any other SN_ELEMENT</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> fields or you will break searching and possibly cause</span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> crashes.</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> */</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keyword">struct </span><a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">SN_ELEMENT</a>* FindId(<a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a>) <span class="keyword">const</span>;</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="comment">/*</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> Add a serial number to the map.</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> sn - [in] serial number to add.</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> If the serial number is valid (>0), a pointer to its</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> element is returned. When a new element is added, </span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> every byte of the m_value field is set to 0.</span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> If the serial number was already active, its element is</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> also returned. If you need to distinguish between new</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> and previously existing elements, then set an </span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> m_value field to something besides 0 after you add</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> a new serial number. The id associated with this</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> serial number will be zero and cannot be found using</span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> FindId().</span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> Restrictions:</span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> The returned pointer may become invalid after any</span></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> subsequent calls to any function in this class. </span></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> If you need to save information in the returned</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> SN_ELEMENT for future use, you must copy the </span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> information into storage you are managing.</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"></span></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> You may change the value of the SN_ELEMENT's m_value</span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> field. You must NEVER change any other SN_ELEMENT</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> fields or you will break searching and possibly cause</span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> crashes.</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> */</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <span class="keyword">struct </span><a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">SN_ELEMENT</a>* AddSerialNumber(ON__UINT64 sn);</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="comment">/*</span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> sn - [in] serial number to add.</span></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> id - [in] suggested id to add. If id is zero or</span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> already in use, another id will be assigned</span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> to the element.</span></div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> If the serial number is valid (>0), a pointer to its</span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> element is returned. When a new element is added, </span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> every byte of the m_value field is set to 0.</span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> If the serial number was already active, its element is</span></div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> also returned. If you need to distinguish between new</span></div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> and previously existing elements, then set an </span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> m_value field to something besides 0 after you add</span></div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> a new serial number. </span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> If the id parameter is nil, then a new uuid is created</span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> and added. If the id parameter is not nil but is active</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> on another element, a new uuid is created and added.</span></div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> You can inspect the value of m_id on the returned element</span></div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> to determine the id AddSerialNumberAndId() assigned to</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> the element.</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"></span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> Restrictions:</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> The returned pointer may become invalid after any</span></div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> subsequent calls to any function in this class. </span></div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> If you need to save information in the returned</span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> SN_ELEMENT for future use, you must copy the </span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> information into storage you are managing.</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"></span></div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> You may change the value of the SN_ELEMENT's m_value</span></div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> field. You must NEVER change any other SN_ELEMENT</span></div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> fields or you will break searching and possibly cause</span></div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"> crashes.</span></div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> */</span></div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  <span class="keyword">struct </span><a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">SN_ELEMENT</a>* AddSerialNumberAndId(ON__UINT64 sn, <a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> <span class="keywordtype">id</span>);</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span> </div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  <span class="comment">/*</span></div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> sn - [in] serial number of the element to remove.</span></div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> If the serial number was active, it is removed</span></div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> and a pointer to its element is returned. If</span></div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> the element's id was active, the id is also removed.</span></div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> Restrictions:</span></div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> The returned pointer may become invalid after any</span></div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment"> subsequent calls to any function in this class. </span></div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"> If you need to save information in the returned</span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"> SN_ELEMENT for future use, you must copy the </span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> information into storage you are managing.</span></div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"></span></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> You may change the value of the SN_ELEMENT's m_value</span></div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> field. You must NEVER change any other SN_ELEMENT</span></div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"> fields or you will break searching and possibly cause</span></div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> crashes.</span></div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> */</span></div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  <span class="keyword">struct </span><a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">SN_ELEMENT</a>* RemoveSerialNumberAndId(ON__UINT64 sn);</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> </div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  <span class="comment">/*</span></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> sn - [in] If > 0, this is the serial number</span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> of the element with the id. If 0, the</span></div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> field is ignored.</span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment"> id - [in] id to search for.</span></div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> If the id was active, it is removed and a pointer</span></div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment"> to its element is returned. The element's serial</span></div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"> remains active. To remove both the id and serial number,</span></div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"> use RemoveSerialNumberAndId().</span></div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> Restrictions:</span></div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"> The returned pointer may become invalid after any</span></div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment"> subsequent calls to any function in this class. </span></div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment"> If you need to save information in the returned</span></div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> SN_ELEMENT for future use, you must copy the </span></div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> information into storage you are managing.</span></div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"></span></div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> You may change the value of the SN_ELEMENT's m_value</span></div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> field. You must NEVER change any other SN_ELEMENT</span></div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> fields or you will break searching and possibly cause</span></div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"> crashes.</span></div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment"> */</span></div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  <span class="keyword">struct </span><a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">SN_ELEMENT</a>* RemoveId(ON__UINT64 sn, <a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> <span class="keywordtype">id</span>);</div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> </div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span>  <span class="comment">/*</span></div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment"> Finds all the elements whose serial numbers are</span></div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment"> in the range sn0 <= sn <= sn1 and appends them</span></div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment"> to the elements[] array. If max_count > 0, it</span></div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment"> specifies the maximum number of elements to append.</span></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"> sn0 - [in]</span></div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment"> Minimum serial number.</span></div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment"> sn1 - [in]</span></div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"> Maximum serial number</span></div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment"> max_count - [in]</span></div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"> If max_count > 0, this parameter specifies the</span></div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment"> maximum number of elements to append.</span></div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment"> elements - [out]</span></div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"> Elements are appended to this array</span></div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment"> Number of elements appended to elements[] array.</span></div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"> When many elements are returned, GetElements() can be</span></div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> substantially faster than repeated calls to FindElement().</span></div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> */</span></div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  ON__UINT64 GetElements(</div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  ON__UINT64 sn0,</div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  ON__UINT64 sn1, </div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  ON__UINT64 max_count,</div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  <a class="code" href="../../dc/dfe/class_o_n___simple_array.html">ON_SimpleArray<SN_ELEMENT></a>& elements</div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span> </div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span>  <span class="comment">/*</span></div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"> Empties the list.</span></div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> */</span></div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span>  <span class="keywordtype">void</span> EmptyList();</div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span> </div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span>  <span class="comment">/*</span></div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> Returns true if the map is valid. Returns false if the</span></div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> map is not valid. If an error is found and textlog</span></div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment"> is not null, then a description of the problem is sent</span></div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment"> to textlog.</span></div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> true if the list if valid.</span></div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment"> */</span></div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span>  <span class="keywordtype">bool</span> IsValid(</div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span>  <span class="keywordtype">bool</span> bBuildHashTable,</div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span>  <a class="code" href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a>* textlog</div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span> </div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span>  <span class="keywordtype">void</span> Dump(<a class="code" href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a>& text_log) <span class="keyword">const</span>;</div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span> </div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span>  <span class="comment">// prohibit copy construction and operator=</span></div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span>  <span class="comment">// no implementation</span></div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span>  <a class="code" href="../../d4/d1e/class_o_n___serial_number_map.html">ON_SerialNumberMap</a>(<span class="keyword">const</span> <a class="code" href="../../d4/d1e/class_o_n___serial_number_map.html">ON_SerialNumberMap</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00352"></a><span class="lineno"> 352</span>  <a class="code" href="../../d4/d1e/class_o_n___serial_number_map.html">ON_SerialNumberMap</a>& operator=(<span class="keyword">const</span> <a class="code" href="../../d4/d1e/class_o_n___serial_number_map.html">ON_SerialNumberMap</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span> </div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span>  ON__UINT64 m_maxsn = 0; <span class="comment">// largest sn stored anywhere</span></div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span> </div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span> </div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span>  <span class="comment">// Serial Number list counts</span></div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span>  ON__UINT64 m_sn_count = 0; <span class="comment">// total number of elements </span></div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span>  ON__UINT64 m_sn_purged = 0; <span class="comment">// total number of purged elements</span></div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span> </div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span>  <span class="comment">// The blocks in m_sn_list[] are alwasy sorted, disjoint,</span></div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span>  <span class="comment">// and in increasing order. m_sn_list is used when</span></div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span>  <span class="comment">// m_sn_block0.m_sn[] is not large enough.</span></div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span>  <span class="comment">// The sn list is partitioned into blocks to avoid</span></div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span>  <span class="comment">// requiring large amounts of contiguous memory for</span></div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span>  <span class="comment">// situations with millions of serial numbers.</span></div><div class="line"><a name="l00368"></a><span class="lineno"> 368</span>  ON__UINT64 m_snblk_list_capacity = 0; <span class="comment">// capacity of m_blk_list[]</span></div><div class="line"><a name="l00369"></a><span class="lineno"> 369</span>  ON__UINT64 m_snblk_list_count = 0; <span class="comment">// used elements in m_snblk_list[]</span></div><div class="line"><a name="l00370"></a><span class="lineno"> 370</span>  <span class="keyword">class </span>ON_SN_BLOCK** m_snblk_list = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00371"></a><span class="lineno"> 371</span> </div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span>  <span class="comment">// If FindElementHelper() returns a non-null pointer</span></div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span>  <span class="comment">// to an element, then m_e_blk points to the ON_SN_BLOCK</span></div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span>  <span class="comment">// that contains the returned element. In all other</span></div><div class="line"><a name="l00375"></a><span class="lineno"> 375</span>  <span class="comment">// situations the value in m_e_blk is undefined and</span></div><div class="line"><a name="l00376"></a><span class="lineno"> 376</span>  <span class="comment">// m_e_blk must not be dereferenced.</span></div><div class="line"><a name="l00377"></a><span class="lineno"> 377</span>  <span class="keyword">class </span>ON_SN_BLOCK* m_e_blk = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00378"></a><span class="lineno"> 378</span> </div><div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00380"></a><span class="lineno"> 380</span>  <span class="keyword">class </span>ON_SN_BLOCK& m_sn_block0;</div><div class="line"><a name="l00381"></a><span class="lineno"> 381</span> </div><div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00383"></a><span class="lineno"> 383</span>  <span class="keyword">struct </span><a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">SN_ELEMENT</a>* FindElementHelper(ON__UINT64 sn);</div><div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  <span class="keywordtype">void</span> UpdateMaxSNHelper();</div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  <span class="keywordtype">void</span> GarbageCollectHelper();</div><div class="line"><a name="l00386"></a><span class="lineno"> 386</span>  ON__UINT64 GarbageCollectMoveHelper(ON_SN_BLOCK* dst,ON_SN_BLOCK* src);</div><div class="line"><a name="l00387"></a><span class="lineno"> 387</span> </div><div class="line"><a name="l00388"></a><span class="lineno"> 388</span>  ON__UINT8 m_reserved1 = 0;</div><div class="line"><a name="l00389"></a><span class="lineno"> 389</span>  ON__UINT8 m_reserved2 = 0;</div><div class="line"><a name="l00390"></a><span class="lineno"> 390</span>  ON__UINT8 m_reserved3 = 0;</div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span> </div><div class="line"><a name="l00392"></a><span class="lineno"> 392</span>  <span class="comment">// When m_bHashTableIsValid == 1, the id hash table is valid.</span></div><div class="line"><a name="l00393"></a><span class="lineno"> 393</span>  <span class="comment">// Otherwise it is not built or out of date.</span></div><div class="line"><a name="l00394"></a><span class="lineno"> 394</span>  <span class="comment">// When m_bHashTableIsValid and nullptr != m_hash_table, </span></div><div class="line"><a name="l00395"></a><span class="lineno"> 395</span>  <span class="comment">// then m_hash1_count > 0 and m_hash_table[i][j] is a </span></div><div class="line"><a name="l00396"></a><span class="lineno"> 396</span>  <span class="comment">// linked list of elements whose id satisfies </span></div><div class="line"><a name="l00397"></a><span class="lineno"> 397</span>  <span class="comment">// i = e->m_id_crc32 % m_hash_block_count</span></div><div class="line"><a name="l00398"></a><span class="lineno"> 398</span>  <span class="comment">// j = (e->m_id_crc32/ID_HASH_BLOCK_CAPACITY) % ID_HASH_BLOCK_CAPACITY</span></div><div class="line"><a name="l00399"></a><span class="lineno"> 399</span>  <span class="keyword">mutable</span> ON__UINT8 m_bHashTableIsValid = 0;</div><div class="line"><a name="l00400"></a><span class="lineno"> 400</span> </div><div class="line"><a name="l00401"></a><span class="lineno"> 401</span>  <span class="keyword">mutable</span> ON__UINT32 m_hash_block_count = 0; <span class="comment">// number of blocks in m_hash_tableX[] </span></div><div class="line"><a name="l00402"></a><span class="lineno"> 402</span>  <span class="keyword">mutable</span> ON__UINT64 m_hash_capacity = 0; <span class="comment">// == m_hash_block_count*ID_HASH_BLOCK_CAPACITY</span></div><div class="line"><a name="l00403"></a><span class="lineno"> 403</span>  <span class="comment">// ideally, m_active_id_count/m_hash_capacity is close to 4</span></div><div class="line"><a name="l00404"></a><span class="lineno"> 404</span>  <span class="keyword">mutable</span> <span class="keyword">struct </span><a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">SN_ELEMENT</a>*** m_hash_table_blocks = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00405"></a><span class="lineno"> 405</span> </div><div class="line"><a name="l00406"></a><span class="lineno"> 406</span>  <span class="comment">// ID hash table counts (all ids in the hash table are active)</span></div><div class="line"><a name="l00407"></a><span class="lineno"> 407</span>  ON__UINT64 m_active_id_count = 0; <span class="comment">// number of active ids in the hash table</span></div><div class="line"><a name="l00408"></a><span class="lineno"> 408</span>  <a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> m_inactive_id = ON_nil_uuid; <span class="comment">// frequently an id is removed and</span></div><div class="line"><a name="l00409"></a><span class="lineno"> 409</span>  <span class="comment">// then added back. m_inactive_id</span></div><div class="line"><a name="l00410"></a><span class="lineno"> 410</span>  <span class="comment">// records the most recently removed</span></div><div class="line"><a name="l00411"></a><span class="lineno"> 411</span>  <span class="comment">// id so we don't have to waste time</span></div><div class="line"><a name="l00412"></a><span class="lineno"> 412</span>  <span class="comment">// searching the hash table for</span></div><div class="line"><a name="l00413"></a><span class="lineno"> 413</span>  <span class="comment">// an id that is not there.</span></div><div class="line"><a name="l00414"></a><span class="lineno"> 414</span> </div><div class="line"><a name="l00415"></a><span class="lineno"> 415</span>  <span class="keywordtype">void</span> Internal_HashTableInvalidate(); <span class="comment">// marks table as dirty</span></div><div class="line"><a name="l00416"></a><span class="lineno"> 416</span>  </div><div class="line"><a name="l00417"></a><span class="lineno"> 417</span>  <span class="keywordtype">bool</span> Internal_HashTableRemoveSerialNumberBlock(</div><div class="line"><a name="l00418"></a><span class="lineno"> 418</span>  <span class="keyword">const</span> <span class="keyword">class</span> ON_SN_BLOCK* blk</div><div class="line"><a name="l00419"></a><span class="lineno"> 419</span>  );</div><div class="line"><a name="l00420"></a><span class="lineno"> 420</span>  </div><div class="line"><a name="l00421"></a><span class="lineno"> 421</span>  <span class="comment">/*</span></div><div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="comment"> Number of active ids added to hash table.</span></div><div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="comment"> */</span></div><div class="line"><a name="l00425"></a><span class="lineno"> 425</span>  ON__UINT64 Internal_HashTableAddSerialNumberBlock(</div><div class="line"><a name="l00426"></a><span class="lineno"> 426</span>  <span class="keyword">class</span> ON_SN_BLOCK* blk</div><div class="line"><a name="l00427"></a><span class="lineno"> 427</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00428"></a><span class="lineno"> 428</span> </div><div class="line"><a name="l00429"></a><span class="lineno"> 429</span>  <span class="keywordtype">void</span> Internal_HashTableBuild() <span class="keyword">const</span>; <span class="comment">// prepares table for use</span></div><div class="line"><a name="l00430"></a><span class="lineno"> 430</span> </div><div class="line"><a name="l00431"></a><span class="lineno"> 431</span>  <span class="keyword">struct </span><a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">SN_ELEMENT</a>** Internal_HashTableBlock(</div><div class="line"><a name="l00432"></a><span class="lineno"> 432</span>  ON__UINT32 id_crc32</div><div class="line"><a name="l00433"></a><span class="lineno"> 433</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00434"></a><span class="lineno"> 434</span> </div><div class="line"><a name="l00435"></a><span class="lineno"> 435</span>  ON__UINT32 Internal_HashTableBlockIndex(</div><div class="line"><a name="l00436"></a><span class="lineno"> 436</span>  ON__UINT32 id_crc32</div><div class="line"><a name="l00437"></a><span class="lineno"> 437</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00438"></a><span class="lineno"> 438</span> </div><div class="line"><a name="l00439"></a><span class="lineno"> 439</span>  <span class="keyword">static</span> ON__UINT32 Internal_HashTableBlockRowIndex(</div><div class="line"><a name="l00440"></a><span class="lineno"> 440</span>  ON__UINT32 id_crc32</div><div class="line"><a name="l00441"></a><span class="lineno"> 441</span>  );</div><div class="line"><a name="l00442"></a><span class="lineno"> 442</span> </div><div class="line"><a name="l00443"></a><span class="lineno"> 443</span>  <span class="keyword">struct </span><a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">SN_ELEMENT</a>* Internal_HashTableFindId(</div><div class="line"><a name="l00444"></a><span class="lineno"> 444</span>  <a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> <span class="keywordtype">id</span>,</div><div class="line"><a name="l00445"></a><span class="lineno"> 445</span>  ON__UINT32 id_crc32,</div><div class="line"><a name="l00446"></a><span class="lineno"> 446</span>  <span class="keywordtype">bool</span> bBuildTableIfNeeded</div><div class="line"><a name="l00447"></a><span class="lineno"> 447</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00448"></a><span class="lineno"> 448</span> </div><div class="line"><a name="l00449"></a><span class="lineno"> 449</span>  <span class="keyword">struct </span><a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">SN_ELEMENT</a>* Internal_HashTableRemoveElement(</div><div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  <span class="keyword">struct</span> <a class="code" href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">SN_ELEMENT</a>* e,</div><div class="line"><a name="l00451"></a><span class="lineno"> 451</span>  <span class="keywordtype">bool</span> bRemoveFromHashBlock</div><div class="line"><a name="l00452"></a><span class="lineno"> 452</span>  );</div><div class="line"><a name="l00453"></a><span class="lineno"> 453</span> </div><div class="line"><a name="l00454"></a><span class="lineno"> 454</span>  <span class="keywordtype">void</span> Internal_HashTableGrow() <span class="keyword">const</span>;</div><div class="line"><a name="l00455"></a><span class="lineno"> 455</span> </div><div class="line"><a name="l00456"></a><span class="lineno"> 456</span>  <span class="keywordtype">void</span> Internal_HashTableInitialize() <span class="keyword">const</span>;</div><div class="line"><a name="l00457"></a><span class="lineno"> 457</span> </div><div class="line"><a name="l00458"></a><span class="lineno"> 458</span> };</div><div class="line"><a name="l00459"></a><span class="lineno"> 459</span> </div><div class="line"><a name="l00460"></a><span class="lineno"> 460</span> </div><div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t_html_a0e3c6f00627cf99b06e75f7f386f38fe"><div class="ttname"><a href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html#a0e3c6f00627cf99b06e75f7f386f38fe">ON_SerialNumberMap::SN_ELEMENT::m_sn</a></div><div class="ttdeci">ON__UINT64 m_sn</div><div class="ttdef"><b>Definition:</b> opennurbs_lookup.h:65</div></div>
|
|
<div class="ttc" id="class_o_n___serial_number_map_html"><div class="ttname"><a href="../../d4/d1e/class_o_n___serial_number_map.html">ON_SerialNumberMap</a></div><div class="ttdoc">ON_SerialNumberMap provides a way to map set of unique serial number - uuid pairs to application defi...</div><div class="ttdef"><b>Definition:</b> opennurbs_lookup.h:32</div></div>
|
|
<div class="ttc" id="struct_o_n___u_u_i_d__struct_html"><div class="ttname"><a href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID_struct</a></div><div class="ttdoc">ON_UUID is a 16 byte universally unique identifier. </div><div class="ttdef"><b>Definition:</b> opennurbs_uuid.h:32</div></div>
|
|
<div class="ttc" id="class_o_n___simple_array_html"><div class="ttname"><a href="../../dc/dfe/class_o_n___simple_array.html">ON_SimpleArray</a></div><div class="ttdef"><b>Definition:</b> opennurbs_array.h:36</div></div>
|
|
<div class="ttc" id="struct_o_n___serial_number_map_1_1_m_a_p___v_a_l_u_e_html"><div class="ttname"><a href="../../d0/df3/struct_o_n___serial_number_map_1_1_m_a_p___v_a_l_u_e.html">ON_SerialNumberMap::MAP_VALUE</a></div><div class="ttdef"><b>Definition:</b> opennurbs_lookup.h:38</div></div>
|
|
<div class="ttc" id="struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t_html"><div class="ttname"><a href="../../df/d03/struct_o_n___serial_number_map_1_1_s_n___e_l_e_m_e_n_t.html">ON_SerialNumberMap::SN_ELEMENT</a></div><div class="ttdef"><b>Definition:</b> opennurbs_lookup.h:52</div></div>
|
|
<div class="ttc" id="class_o_n___text_log_html"><div class="ttname"><a href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a></div><div class="ttdef"><b>Definition:</b> opennurbs_textlog.h:20</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- HTML footer for doxygen 1.8.13-->
|
|
<!-- start footer part -->
|
|
</div> <!-- page-content -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sat Feb 3 2018 11:08:27 for openNURBS SDK Help by <a href="http://www.doxygen.org/index.html">
|
|
<!-- <img class="footer" src="../../doxygen.png" alt="doxygen"/> -->
|
|
Doxygen
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</div> <!-- container -->
|
|
<!-- doxy-boot -->
|
|
<script type="text/javascript" src="../../doxy-boot.js"></script>
|
|
</body>
|
|
</html>
|