<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>ICU 3.8: ValueRuns Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.1 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li id="current"><a href="classes.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li> <form action="search.php" method="get"> <table cellspacing="0" cellpadding="0" border="0"> <tr> <td><label> <u>S</u>earch for </label></td> <td><input type="text" name="query" value="" size="20" accesskey="s"/></td> </tr> </table> </form> </li> </ul></div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul></div> <h1>ValueRuns Class Reference</h1><!-- doxytag: class="ValueRuns" --><!-- doxytag: inherits="RunArray" -->The <code><a class="el" href="classValueRuns.html">ValueRuns</a></code> class associates integer values with runs of text. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="RunArrays_8h-source.html">RunArrays.h</a>></code> <p> <p>Inheritance diagram for ValueRuns: <p><center><img src="classValueRuns.png" usemap="#ValueRuns_map" border="0" alt=""></center> <map name="ValueRuns_map"> <area href="classRunArray.html" alt="RunArray" shape="rect" coords="0,112,73,136"> <area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,73,80"> <area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,73,24"> </map> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classValueRuns.html#8f584dddcce036fa85e7f8280913b712">ValueRuns</a> (const <a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> *values, const <a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> *limits, <a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> count)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <code><a class="el" href="classValueRuns.html">ValueRuns</a></code> object from pre-existing arrays of values and limit indices. <a href="#8f584dddcce036fa85e7f8280913b712"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classValueRuns.html#589c53a2af3fd559b333e70a0a89cde8">ValueRuns</a> (<a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> initialCapacity)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an empty <code><a class="el" href="classValueRuns.html">ValueRuns</a></code> object. <a href="#589c53a2af3fd559b333e70a0a89cde8"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classValueRuns.html#4215abc5599e2315b20d0c08ed904e1c">~ValueRuns</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The destructor; virtual so that subclass destructors are invoked as well. <a href="#4215abc5599e2315b20d0c08ed904e1c"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classValueRuns.html#648a082e0ba93d07fbfbe5cc999f7058">getValue</a> (<a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> run) const</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the integer value assoicated with the given run of text. <a href="#648a082e0ba93d07fbfbe5cc999f7058"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classValueRuns.html#e7a118f5861bb27220b14b64bddff53c">add</a> (<a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> value, <a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> limit)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add an integer value and limit index pair to the data arrays and return the run index where the data was stored. <a href="#e7a118f5861bb27220b14b64bddff53c"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classValueRuns.html#29d6ef5dc9c3c1c94969e634e7c74cbc">getDynamicClassID</a> () const</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for the actual class. <a href="#29d6ef5dc9c3c1c94969e634e7c74cbc"></a><br></td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classValueRuns.html#abeaef6897245191ee77d30ed6765928">getStaticClassID</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for this class. <a href="#abeaef6897245191ee77d30ed6765928"></a><br></td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classValueRuns.html#c19d6e6dbba7e66516bf2451e95ef8fd">init</a> (<a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> capacity)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a data array with the given initial size. <a href="#c19d6e6dbba7e66516bf2451e95ef8fd"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classValueRuns.html#b72ad12ee037660be28f3ab785a4a7c7">grow</a> (<a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> capacity)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Grow a data array to the given initial size. <a href="#b72ad12ee037660be28f3ab785a4a7c7"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> The <code><a class="el" href="classValueRuns.html">ValueRuns</a></code> class associates integer values with runs of text. <p> <dl compact><dt><b><a class="el" href="stable.html#_stable003491">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> <p> <p> Definition at line <a class="el" href="RunArrays_8h-source.html#l00543">543</a> of file <a class="el" href="RunArrays_8h-source.html">RunArrays.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="8f584dddcce036fa85e7f8280913b712"></a><!-- doxytag: member="ValueRuns::ValueRuns" ref="8f584dddcce036fa85e7f8280913b712" args="(const le_int32 *values, const le_int32 *limits, le_int32 count)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ValueRuns::ValueRuns </td> <td>(</td> <td class="paramtype">const <a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> * </td> <td class="paramname"> <em>values</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> * </td> <td class="paramname"> <em>limits</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td> <td class="paramname"> <em>count</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Construct a <code><a class="el" href="classValueRuns.html">ValueRuns</a></code> object from pre-existing arrays of values and limit indices. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>values</em> </td><td>is the address of an array of integer. This array must remain valid until the <code><a class="el" href="classValueRuns.html">ValueRuns</a></code> object is destroyed.</td></tr> <tr><td valign="top"></td><td valign="top"><em>limits</em> </td><td>is the address of an array of limit indices. This array must remain valid until the <code><a class="el" href="classValueRuns.html">ValueRuns</a></code> object is destroyed.</td></tr> <tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>is the number of entries in the two arrays.</td></tr> </table> </dl> <dl compact><dt><b><a class="el" href="stable.html#_stable003519">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> <p> Definition at line <a class="el" href="RunArrays_8h-source.html#l00666">666</a> of file <a class="el" href="RunArrays_8h-source.html">RunArrays.h</a>. <p> References <a class="el" href="RunArrays_8h-source.html#l00666">ValueRuns()</a>. <p> Referenced by <a class="el" href="RunArrays_8h-source.html#l00666">ValueRuns()</a>. </div> </div><p> <a class="anchor" name="589c53a2af3fd559b333e70a0a89cde8"></a><!-- doxytag: member="ValueRuns::ValueRuns" ref="589c53a2af3fd559b333e70a0a89cde8" args="(le_int32 initialCapacity)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ValueRuns::ValueRuns </td> <td>(</td> <td class="paramtype"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td> <td class="paramname"> <em>initialCapacity</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Construct an empty <code><a class="el" href="classValueRuns.html">ValueRuns</a></code> object. <p> Clients can add value and limit indices arrays using the <code>add</code> method.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>initialCapacity</em> </td><td>is the initial size of the value and limit indices arrays. If this value is zero, no arrays will be allocated.</td></tr> </table> </dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classValueRuns.html#e7a118f5861bb27220b14b64bddff53c">add</a></dd></dl> <dl compact><dt><b><a class="el" href="stable.html#_stable003520">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> </div> </div><p> <a class="anchor" name="4215abc5599e2315b20d0c08ed904e1c"></a><!-- doxytag: member="ValueRuns::~ValueRuns" ref="4215abc5599e2315b20d0c08ed904e1c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual ValueRuns::~ValueRuns </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> The destructor; virtual so that subclass destructors are invoked as well. <p> <dl compact><dt><b><a class="el" href="stable.html#_stable003521">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="648a082e0ba93d07fbfbe5cc999f7058"></a><!-- doxytag: member="ValueRuns::getValue" ref="648a082e0ba93d07fbfbe5cc999f7058" args="(le_int32 run) const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> ValueRuns::getValue </td> <td>(</td> <td class="paramtype"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td> <td class="paramname"> <em>run</em> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> Get the integer value assoicated with the given run of text. <p> Use <code>RunArray::getLimit(run)</code> to get the corresponding limit index.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>run</em> </td><td>is the index into the font and limit indices arrays.</td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>the integer value associated with the given text run.</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classRunArray.html#6c248b70d1e15018f535fe0d30b09ede">RunArray::getLimit</a></dd></dl> <dl compact><dt><b><a class="el" href="stable.html#_stable003522">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> </div> </div><p> <a class="anchor" name="e7a118f5861bb27220b14b64bddff53c"></a><!-- doxytag: member="ValueRuns::add" ref="e7a118f5861bb27220b14b64bddff53c" args="(le_int32 value, le_int32 limit)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> ValueRuns::add </td> <td>(</td> <td class="paramtype"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td> <td class="paramname"> <em>value</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td> <td class="paramname"> <em>limit</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Add an integer value and limit index pair to the data arrays and return the run index where the data was stored. <p> This method calls <code>RunArray::add(limit)</code> which will create or grow the arrays as needed.<p> If the <code><a class="el" href="classValueRuns.html">ValueRuns</a></code> object was created with a client-supplied font and limit indices arrays, this method will return a run index of -1.<p> Subclasses should not override this method. Rather they should provide a new <code>add</code> method which takes an integer value and a limit index along with whatever other data they implement. The new <code>add</code> method should first call this method to grow the font and limit indices arrays, and use the returned run index to store data their own arrays.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>is the integer value to add</td></tr> <tr><td valign="top"></td><td valign="top"><em>limit</em> </td><td>is the limit index to add</td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>the run index where the value and limit index were stored, or -1 if the data cannot be stored.</dd></dl> <dl compact><dt><b><a class="el" href="stable.html#_stable003523">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> </div> </div><p> <a class="anchor" name="abeaef6897245191ee77d30ed6765928"></a><!-- doxytag: member="ValueRuns::getStaticClassID" ref="abeaef6897245191ee77d30ed6765928" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> ValueRuns::getStaticClassID </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline, static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> ICU "poor man's RTTI", returns a UClassID for this class. <p> <dl compact><dt><b><a class="el" href="stable.html#_stable003524">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> <p> Reimplemented from <a class="el" href="classRunArray.html#b9bc82428042aa0ab416de2cf5ece3df">RunArray</a>. <p> Definition at line <a class="el" href="RunArrays_8h-source.html#l00626">626</a> of file <a class="el" href="RunArrays_8h-source.html">RunArrays.h</a>. </div> </div><p> <a class="anchor" name="29d6ef5dc9c3c1c94969e634e7c74cbc"></a><!-- doxytag: member="ValueRuns::getDynamicClassID" ref="29d6ef5dc9c3c1c94969e634e7c74cbc" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> ValueRuns::getDynamicClassID </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> ICU "poor man's RTTI", returns a UClassID for the actual class. <p> <dl compact><dt><b><a class="el" href="stable.html#_stable003525">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> <p> Reimplemented from <a class="el" href="classRunArray.html#577d2bbecf2bb8c818e229ce43fa1606">RunArray</a>. <p> Definition at line <a class="el" href="RunArrays_8h-source.html#l00633">633</a> of file <a class="el" href="RunArrays_8h-source.html">RunArrays.h</a>. <p> References <a class="el" href="RunArrays_8h-source.html#l00155">RunArray::getStaticClassID()</a>. </div> </div><p> <a class="anchor" name="c19d6e6dbba7e66516bf2451e95ef8fd"></a><!-- doxytag: member="ValueRuns::init" ref="c19d6e6dbba7e66516bf2451e95ef8fd" args="(le_int32 capacity)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void ValueRuns::init </td> <td>(</td> <td class="paramtype"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td> <td class="paramname"> <em>capacity</em> </td> <td> ) </td> <td width="100%"><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create a data array with the given initial size. <p> This method will be called by the <code>add</code> method if there is no limit indices array. Subclasses which override this method must also call it from the overriding method to create the limit indices array.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>capacity</em> </td><td>is the initial size of the data array.</td></tr> </table> </dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classValueRuns.html#e7a118f5861bb27220b14b64bddff53c">add</a></dd></dl> <dl compact><dt><b><a class="el" href="stable.html#_stable003502">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> <p> Reimplemented from <a class="el" href="classRunArray.html#4a4822936fdabd6c9336134fb659a32d">RunArray</a>. </div> </div><p> <a class="anchor" name="b72ad12ee037660be28f3ab785a4a7c7"></a><!-- doxytag: member="ValueRuns::grow" ref="b72ad12ee037660be28f3ab785a4a7c7" args="(le_int32 capacity)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void ValueRuns::grow </td> <td>(</td> <td class="paramtype"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td> <td class="paramname"> <em>capacity</em> </td> <td> ) </td> <td width="100%"><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Grow a data array to the given initial size. <p> This method will be called by the <code>add</code> method if the limit indices array is full. Subclasses which override this method must also call it from the overriding method to grow the limit indices array.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>capacity</em> </td><td>is the initial size of the data array.</td></tr> </table> </dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classValueRuns.html#e7a118f5861bb27220b14b64bddff53c">add</a></dd></dl> <dl compact><dt><b><a class="el" href="stable.html#_stable003503">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> <p> Reimplemented from <a class="el" href="classRunArray.html#c09e01408d8afa1272027a8937a4e1a1">RunArray</a>. </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="RunArrays_8h-source.html">RunArrays.h</a></ul> <hr size="1"><address style="align: right;"><small>Generated on Fri Sep 14 12:59:51 2007 for ICU 3.8 by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address> </body> </html>