diff options
Diffstat (limited to 'freebsdtvision/doc/html/classTNSCollection.html')
| -rw-r--r-- | freebsdtvision/doc/html/classTNSCollection.html | 1102 |
1 files changed, 1102 insertions, 0 deletions
diff --git a/freebsdtvision/doc/html/classTNSCollection.html b/freebsdtvision/doc/html/classTNSCollection.html new file mode 100644 index 0000000..a3da129 --- /dev/null +++ b/freebsdtvision/doc/html/classTNSCollection.html @@ -0,0 +1,1102 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>TNSCollection class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.2.18 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> +<hr><h1>TNSCollection Class Reference</h1>Handles a non-streamable collection of objects. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="tvobjs_8h-source.html">tvobjs.h</a>></code> +<p> +<p>Inheritance diagram for TNSCollection: +<p><center><img src="classTNSCollection.png" usemap="#TNSCollection_map" border="0" alt=""></center> +<map name="TNSCollection_map"> +<area href="classTObject.html" alt="TObject" shape="rect" coords="417,0,546,24"> +<area href="classTCollection.html" alt="TCollection" shape="rect" coords="69,112,198,136"> +<area href="classTNSSortedCollection.html" alt="TNSSortedCollection" shape="rect" coords="417,112,546,136"> +<area href="classTPReadObjects.html" alt="TPReadObjects" shape="rect" coords="556,112,685,136"> +<area href="classTDirCollection.html" alt="TDirCollection" shape="rect" coords="0,168,129,192"> +<area href="classTSortedCollection.html" alt="TSortedCollection" shape="rect" coords="139,168,268,192"> +<area href="classTPWrittenObjects.html" alt="TPWrittenObjects" shape="rect" coords="278,168,407,192"> +<area href="classTSortedCollection.html" alt="TSortedCollection" shape="rect" coords="417,168,546,192"> +<area href="classTStreamableTypes.html" alt="TStreamableTypes" shape="rect" coords="556,168,685,192"> +<area href="classTFileCollection.html" alt="TFileCollection" shape="rect" coords="69,224,198,248"> +<area href="classTStringCollection.html" alt="TStringCollection" shape="rect" coords="208,224,337,248"> +<area href="classTFileCollection.html" alt="TFileCollection" shape="rect" coords="347,224,476,248"> +<area href="classTStringCollection.html" alt="TStringCollection" shape="rect" coords="486,224,615,248"> +<area href="classTResourceCollection.html" alt="TResourceCollection" shape="rect" coords="208,280,337,304"> +<area href="classTResourceCollection.html" alt="TResourceCollection" shape="rect" coords="486,280,615,304"> +</map> +<a href="classTNSCollection-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classTNSCollection.html#a0">TNSCollection</a> (<a class="el" href="ttypes_8h.html#a5">ccIndex</a> aLimit, <a class="el" href="ttypes_8h.html#a5">ccIndex</a> aDelta)</td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classTNSCollection.html#a1">~TNSCollection</a> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTNSCollection.html#a2">shutDown</a> ()</td></tr> +<tr><td nowrap align=right valign=top>void * </td><td valign=bottom><a class="el" href="classTNSCollection.html#a3">at</a> (<a class="el" href="ttypes_8h.html#a5">ccIndex</a> index)</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td><td valign=bottom><a class="el" href="classTNSCollection.html#a4">indexOf</a> (void *item)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTNSCollection.html#a5">atFree</a> (<a class="el" href="ttypes_8h.html#a5">ccIndex</a> index)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTNSCollection.html#a6">atRemove</a> (<a class="el" href="ttypes_8h.html#a5">ccIndex</a> index)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTNSCollection.html#a7">remove</a> (void *item)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTNSCollection.html#a8">removeAll</a> ()</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTNSCollection.html#a9">free</a> (void *item)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTNSCollection.html#a10">freeAll</a> ()</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTNSCollection.html#a11">atInsert</a> (<a class="el" href="ttypes_8h.html#a5">ccIndex</a> index, void *item)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTNSCollection.html#a12">atPut</a> (<a class="el" href="ttypes_8h.html#a5">ccIndex</a> index, void *item)</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td><td valign=bottom><a class="el" href="classTNSCollection.html#a13">insert</a> (void *item)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTNSCollection.html#a14">error</a> (<a class="el" href="ttypes_8h.html#a5">ccIndex</a> code, <a class="el" href="ttypes_8h.html#a5">ccIndex</a> info)</td></tr> +<tr><td nowrap align=right valign=top>void * </td><td valign=bottom><a class="el" href="classTNSCollection.html#a15">firstThat</a> (<a class="el" href="ttypes_8h.html#a6">ccTestFunc</a> Test, void *arg)</td></tr> +<tr><td nowrap align=right valign=top>void * </td><td valign=bottom><a class="el" href="classTNSCollection.html#a16">lastThat</a> (<a class="el" href="ttypes_8h.html#a6">ccTestFunc</a> Test, void *arg)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTNSCollection.html#a17">forEach</a> (<a class="el" href="ttypes_8h.html#a7">ccAppFunc</a> action, void *arg)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTNSCollection.html#a18">pack</a> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTNSCollection.html#a19">setLimit</a> (<a class="el" href="ttypes_8h.html#a5">ccIndex</a> aLimit)</td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td><td valign=bottom><a class="el" href="classTNSCollection.html#a20">getCount</a> ()</td></tr> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTNSCollection.html#d0">error</a> (<a class="el" href="ttypes_8h.html#a5">ccIndex</a> code, <a class="el" href="ttypes_8h.html#a5">ccIndex</a> info)</td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classTNSCollection.html#b0">TNSCollection</a> ()</td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>void ** </td><td valign=bottom><a class="el" href="classTNSCollection.html#n0">items</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td><td valign=bottom><a class="el" href="classTNSCollection.html#n1">count</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td><td valign=bottom><a class="el" href="classTNSCollection.html#n2">limit</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td><td valign=bottom><a class="el" href="classTNSCollection.html#n3">delta</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="ttypes_8h.html#a13">Boolean</a> </td><td valign=bottom><a class="el" href="classTNSCollection.html#n4">shouldDelete</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +TNSCollection implements a nonstreamable collection of items. It provides a base class for the streamable collection class, <a class="el" href="classTCollection.html">TCollection</a>. TNSCollection provides <a class="el" href="classTCollection.html">TCollection</a> with the functions for adding, accessing, and removing items from a collection. +<p> +This class stores an array of pointers to generic objects. This array may grow or shrink at run-time. +<p> +Note: type ccIndex is defined in file `<a class="el" href="ttypes_8h.html">ttypes.h</a>' as int. +<p> + +<p> +Definition at line <a class="el" href="tvobjs_8h-source.html#l00089">89</a> of file <a class="el" href="tvobjs_8h-source.html">tvobjs.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="TNSCollection::TNSCollection"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> TNSCollection::TNSCollection </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td> + <td class="mdname" nowrap> <em>aLimit</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td> + <td class="mdname" nowrap> <em>aDelta</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> +Creates a collection with limit set to `aLimit' and delta set to `aDelta'. count and items data members are both set to 0. <a class="el" href="classTNSCollection.html#n4">shouldDelete</a> is set True. +<p> +The initial number of items will be limited to `aLimit', but the collection is allowed to grow in increments of `aDelta' until memory runs out or the number of items reaches <a class="el" href="tvconfig_8h.html#a1">maxCollectionSize</a>. +<p> +<a class="el" href="tvconfig_8h.html#a1">maxCollectionSize</a> is defined in `<a class="el" href="tvconfig_8h.html">tvconfig.h</a>' as: +<p> +<pre> + const int maxCollectionSize = INT_MAX / sizeof(void *); + </pre> <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="tvconfig_8h.html#a1">maxCollectionSize</a> </dl> </td> + </tr> +</table> +<a name="a1" doxytag="TNSCollection::~TNSCollection"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> TNSCollection::~TNSCollection </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Destructor. +<p> +If <a class="el" href="classTNSCollection.html#n4">shouldDelete</a> is True, the destructor removes and destroys all items in the collection by calling <a class="el" href="classTNSCollection.html#a10">freeAll</a> and setting limit to 0. +<p> +If <a class="el" href="classTNSCollection.html#n4">shouldDelete</a> is False, the destructor sets limit to 0 but does not destroy the collection. </td> + </tr> +</table> +<a name="b0" doxytag="TNSCollection::TNSCollection"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> TNSCollection::TNSCollection </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> +This constructor sets variable <a class="el" href="classTNSCollection.html#n4">shouldDelete</a> to True and variables count, limit and delta to 0. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a3" doxytag="TNSCollection::at"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void* TNSCollection::at </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td> + <td class="mdname1" valign="top" nowrap> <em>index</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns a pointer to the item indexed by `index' in the collection. If `index' is less than 0 or greater than or equal to count, <a class="el" href="classTNSCollection.html#a14">error()</a> is called with an argument of coIndexError, and 0 is then returned. +<p> +Reimplemented in <a class="el" href="classTFileCollection.html#a1">TFileCollection</a>, and <a class="el" href="classTDirCollection.html#a1">TDirCollection</a>. +<p> +Referenced by <a class="el" href="stddlg_8h-source.html#l01009">TDirCollection::at()</a>, and <a class="el" href="stddlg_8h-source.html#l00209">TFileCollection::at()</a>. </td> + </tr> +</table> +<a name="a5" doxytag="TNSCollection::atFree"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void TNSCollection::atFree </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td> + <td class="mdname1" valign="top" nowrap> <em>index</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Removes the object at position `index' from the array. +<p> +Then calls delete on the object. </td> + </tr> +</table> +<a name="a11" doxytag="TNSCollection::atInsert"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void TNSCollection::atInsert </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td> + <td class="mdname" nowrap> <em>index</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>item</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Inserts a new object at position `index'. +<p> +Moves the following items down by one position, then inserts `item' at the `index' position. If `index' is less than 0 or greater than count data member, <a class="el" href="classTNSCollection.html#a14">error()</a> is called with an argument of coIndexError and the new item is not inserted. +<p> +If count is equal to limit data member before the call to <a class="el" href="classTNSCollection.html#a11">atInsert()</a>, the allocated size of the collection is expanded by delta items using a call to <a class="el" href="classTNSCollection.html#a19">setLimit()</a>. +<p> +If the <a class="el" href="classTNSCollection.html#a19">setLimit()</a> call fails to expand the collection, the <a class="el" href="classTNSCollection.html#a14">error()</a> member function is called with an argument of coOverflow and the new item is not inserted. +<p> +Referenced by <a class="el" href="stddlg_8h-source.html#l01038">TDirCollection::atInsert()</a>, and <a class="el" href="stddlg_8h-source.html#l00237">TFileCollection::atInsert()</a>. </td> + </tr> +</table> +<a name="a12" doxytag="TNSCollection::atPut"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void TNSCollection::atPut </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td> + <td class="mdname" nowrap> <em>index</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>item</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Replaces the object at position `index'. +<p> +Replaces the item at position `index' with the given `item'. If `index' is less than 0 or greater than or equal to count, <a class="el" href="classTNSCollection.html#a14">error()</a> is called with an argument of coIndexError. +<p> +Old object is lost. +<p> +Referenced by <a class="el" href="stddlg_8h-source.html#l01044">TDirCollection::atPut()</a>, and <a class="el" href="stddlg_8h-source.html#l00242">TFileCollection::atPut()</a>. </td> + </tr> +</table> +<a name="a6" doxytag="TNSCollection::atRemove"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void TNSCollection::atRemove </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td> + <td class="mdname1" valign="top" nowrap> <em>index</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Removes the object at position `index' from the array. +<p> +Removes the item at the position `index' by moving the following items up by one position. count is decremented by 1, but the memory allocated to the collection is not reduced. If `index' is greater than or equal to count, <a class="el" href="classTNSCollection.html#a14">error()</a> is called. +<p> +The item itself is not destroyed. </td> + </tr> +</table> +<a name="d0" doxytag="TNSCollection::error"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void TNSCollection::error </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td> + <td class="mdname" nowrap> <em>code</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td> + <td class="mdname" nowrap> <em>info</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Called whenever a collection error is encountered. By default, this member function produces a run-time error of (212 - `code'). </td> + </tr> +</table> +<a name="a14" doxytag="TNSCollection::error"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void TNSCollection::error </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td> + <td class="mdname" nowrap> <em>code</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td> + <td class="mdname" nowrap> <em>info</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This function is called on error conditions. +<p> +By default calls function exit() to terminate the program. </td> + </tr> +</table> +<a name="a15" doxytag="TNSCollection::firstThat"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void* TNSCollection::firstThat </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="ttypes_8h.html#a6">ccTestFunc</a> </td> + <td class="mdname" nowrap> <em>Test</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>arg</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<a class="el" href="classTNSCollection.html#a15">firstThat()</a> applies a <a class="el" href="ttypes_8h.html#a13">Boolean</a> function `Test', along with an argument list given by `arg' to each item in the collection until the tested function returns True. The result is the item pointer for which the call returns True, or 0 if the call returned False for all items. +<p> +`Test' is a pointer to a function whose type ccTestFunc is defined as: +<p> +<pre> + typedef Boolean (*ccTestFunc)(void *, void *) + </pre> +<p> +This method returns when one object of the array passes the test or when each object is tested without success. In the first case it returns the address of the object. In the latter case it returns 0. `arg' stores the argument of the function (if any). +<p> +This method scans the array forward. This is an example: +<p> +<pre> + define Uses_TNSCollection + + include "<a class="el" href="tv_8h.html">tv.h</a>" + + class XObject { + int value; + public: + XObject(int aValue): value(aValue) {} + int getValue() { return value; } + }; + + Boolean matchTest(void *obj, void *value) + { + if (((XObject *) obj)->getValue() == *((int *) value)) return True; + return False; + } + + void main() + { + TNSCollection array(10, 5); + array.insert(new XObject(14)); + array.insert(new XObject(32)); + array.insert(new XObject(23)); + array.insert(new XObject(41)); + int find = 23; + XObject *p = (XObject *) array.firstThat(&matchTest, &find); + if (p != 0) array.free(p); + } + </pre> <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTNSCollection.html#a17">TNSCollection::forEach</a> , <a class="el" href="classTNSCollection.html#a16">TNSCollection::lastThat</a> </dl> +<p> +Reimplemented in <a class="el" href="classTFileCollection.html#a8">TFileCollection</a>, and <a class="el" href="classTDirCollection.html#a8">TDirCollection</a>. +<p> +Referenced by <a class="el" href="stddlg_8h-source.html#l01129">TDirCollection::firstThat()</a>, and <a class="el" href="stddlg_8h-source.html#l00335">TFileCollection::firstThat()</a>. </td> + </tr> +</table> +<a name="a17" doxytag="TNSCollection::forEach"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void TNSCollection::forEach </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="ttypes_8h.html#a7">ccAppFunc</a> </td> + <td class="mdname" nowrap> <em>action</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>arg</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The <a class="el" href="classTNSCollection.html#a17">forEach()</a> iterator applies an action, given by the function `action', to each item in the collection. The `arg' pointer can be used to pass additional arguments to the action. +<p> +`action' is a pointer to a function whose type ccAppFunc is defined as: +<p> +<pre> + typedef void (*ccAppFunc)(void *, void *); + </pre> +<p> +This method scans the array forward. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTNSCollection.html#a15">TNSCollection::firstThat</a> , <a class="el" href="classTNSCollection.html#a16">TNSCollection::lastThat</a> </dl> </td> + </tr> +</table> +<a name="a9" doxytag="TNSCollection::free"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void TNSCollection::free </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void * </td> + <td class="mdname1" valign="top" nowrap> <em>item</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Removes and destroys the given item. +<p> +It just does `atRemove(indexOf(item))'. Then calls delete on the object. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTNSCollection.html#a6">TNSCollection::atRemove</a> , <a class="el" href="classTNSCollection.html#a4">TNSCollection::indexOf</a> </dl> +<p> +Referenced by <a class="el" href="stddlg_8h-source.html#l01029">TDirCollection::free()</a>, and <a class="el" href="stddlg_8h-source.html#l00227">TFileCollection::free()</a>. </td> + </tr> +</table> +<a name="a10" doxytag="TNSCollection::freeAll"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void TNSCollection::freeAll </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Removes and destroys all items in the collection and sets count to 0. +<p> +The array is cleared out but not deleted. +<p> +Referenced by <a class="el" href="tobjstrm_8h-source.html#l00294">TPWrittenObjects::removeAll()</a>. </td> + </tr> +</table> +<a name="a20" doxytag="TNSCollection::getCount"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="ttypes_8h.html#a5">ccIndex</a> TNSCollection::getCount </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the number of items stored in the collection, up to <a class="el" href="tvconfig_8h.html#a1">maxCollectionSize</a>. +<p> +Definition at line <a class="el" href="tvobjs_8h-source.html#l00351">351</a> of file <a class="el" href="tvobjs_8h-source.html">tvobjs.h</a>. +<p> +References <a class="el" href="ttypes_8h-source.html#l00072">ccIndex</a>, and <a class="el" href="tvobjs_8h-source.html#l00371">count</a>. </td> + </tr> +</table> +<a name="a4" doxytag="TNSCollection::indexOf"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="ttypes_8h.html#a5">ccIndex</a> TNSCollection::indexOf </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void * </td> + <td class="mdname1" valign="top" nowrap> <em>item</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the index of the given item; that is, the converse operation to <a class="el" href="classTNSCollection.html#a3">at()</a>. If the item is not in the collection, <a class="el" href="classTNSCollection.html#a4">indexOf()</a> calls <a class="el" href="classTNSCollection.html#a14">error()</a>. +<p> +The address of the item is passed in the `item' parameter. +<p> +Reimplemented in <a class="el" href="classTNSSortedCollection.html#a2">TNSSortedCollection</a>. +<p> +Referenced by <a class="el" href="stddlg_8h-source.html#l01015">TDirCollection::indexOf()</a>. </td> + </tr> +</table> +<a name="a13" doxytag="TNSCollection::insert"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="ttypes_8h.html#a5">ccIndex</a> TNSCollection::insert </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void * </td> + <td class="mdname1" valign="top" nowrap> <em>item</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Inserts `item' into the collection, and adjusts other indexes if necessary. By default, insertions are made at the end of the collection by calling <a class="el" href="classTNSCollection.html#a11">atInsert()</a>. +<p> +Reimplemented in <a class="el" href="classTNSSortedCollection.html#a3">TNSSortedCollection</a>. +<p> +Referenced by <a class="el" href="stddlg_8h-source.html#l01052">TDirCollection::insert()</a>. </td> + </tr> +</table> +<a name="a16" doxytag="TNSCollection::lastThat"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void* TNSCollection::lastThat </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="ttypes_8h.html#a6">ccTestFunc</a> </td> + <td class="mdname" nowrap> <em>Test</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>arg</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<a class="el" href="classTNSCollection.html#a16">lastThat()</a> applies the <a class="el" href="ttypes_8h.html#a13">Boolean</a> function `Test', together with the `arg' argument list to each item in the collection, starting at the last item, and scanning in reverse order until the tested function returns True. The result is the item pointer for which the call returns True, or 0 if the call returned False for all items. +<p> +This method scans the array backward. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTNSCollection.html#a15">TNSCollection::firstThat</a> , <a class="el" href="classTNSCollection.html#a17">TNSCollection::forEach</a> </dl> +<p> +Reimplemented in <a class="el" href="classTFileCollection.html#a9">TFileCollection</a>, and <a class="el" href="classTDirCollection.html#a9">TDirCollection</a>. +<p> +Referenced by <a class="el" href="stddlg_8h-source.html#l01134">TDirCollection::lastThat()</a>, and <a class="el" href="stddlg_8h-source.html#l00340">TFileCollection::lastThat()</a>. </td> + </tr> +</table> +<a name="a18" doxytag="TNSCollection::pack"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void TNSCollection::pack </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Packs the array by removing null pointers from it. +<p> +Deletes all null pointers in the collection and moves items up to fill any gaps. </td> + </tr> +</table> +<a name="a7" doxytag="TNSCollection::remove"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void TNSCollection::remove </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void * </td> + <td class="mdname1" valign="top" nowrap> <em>item</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Removes the item given by `item' from the collection. +<p> +Equivalent to `atRemove(indexOf(item))'. Does not call delete on the object. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTNSCollection.html#a6">TNSCollection::atRemove</a> , <a class="el" href="classTNSCollection.html#a4">TNSCollection::indexOf</a> </dl> +<p> +Referenced by <a class="el" href="stddlg_8h-source.html#l01022">TDirCollection::remove()</a>, and <a class="el" href="stddlg_8h-source.html#l00221">TFileCollection::remove()</a>. </td> + </tr> +</table> +<a name="a8" doxytag="TNSCollection::removeAll"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void TNSCollection::removeAll </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Removes all items from the collection by just setting count to 0. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTNSCollection.html#n1">TNSCollection::count</a> </dl> +<p> +Reimplemented in <a class="el" href="classTPWrittenObjects.html#a0">TPWrittenObjects</a>, and <a class="el" href="classTPReadObjects.html#a0">TPReadObjects</a>. +<p> +Referenced by <a class="el" href="tobjstrm_8h-source.html#l00383">TPReadObjects::removeAll()</a>. </td> + </tr> +</table> +<a name="a19" doxytag="TNSCollection::setLimit"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void TNSCollection::setLimit </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="ttypes_8h.html#a5">ccIndex</a> </td> + <td class="mdname1" valign="top" nowrap> <em>aLimit</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Expands or shrinks the collection by changing the allocated size to `aLimit'. +<p> +<ol> +<li>If `aLimit' is less than count, it is set to count.<li>if `aLimit' is greater than <a class="el" href="tvconfig_8h.html#a1">maxCollectionSize</a>, it is set to <a class="el" href="tvconfig_8h.html#a1">maxCollectionSize</a>. Integer constant maxCollectionSize is defined in file `<a class="el" href="tvconfig_8h.html">tvconfig.h</a>' as:</ol> +<pre> + const int maxCollectionSize = INT_MAX / sizeof(void *); + </pre> +<p> +Then, if `aLimit' is different from the current limit, a new items array of `aLimit' elements is allocated, the old items array is copied into the new array, and the old array is deleted. +<p> +Referenced by <a class="el" href="objects_8h-source.html#l00365">TCollection::TCollection()</a>, and <a class="el" href="tvobjs_8h-source.html#l00427">TNSSortedCollection::TNSSortedCollection()</a>. </td> + </tr> +</table> +<a name="a2" doxytag="TNSCollection::shutDown"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void TNSCollection::shutDown </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Releases all the resources allocated by this class. +<p> +If class flag <a class="el" href="classTNSCollection.html#n4">shouldDelete</a> is True the function <a class="el" href="classTNSCollection.html#a10">freeAll()</a> is called. This will delete each object of the array. +<p> +Reimplemented from <a class="el" href="classTObject.html#a1">TObject</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="n1" doxytag="TNSCollection::count"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="ttypes_8h.html#a5">ccIndex</a> TNSCollection::count<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This variable stores the number of objects in the array. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTNSCollection.html#n0">TNSCollection::items</a> , <a class="el" href="classTNSCollection.html#n2">TNSCollection::limit</a> </dl> +<p> +Definition at line <a class="el" href="tvobjs_8h-source.html#l00371">371</a> of file <a class="el" href="tvobjs_8h-source.html">tvobjs.h</a>. +<p> +Referenced by <a class="el" href="tvobjs_8h-source.html#l00351">getCount()</a>. </td> + </tr> +</table> +<a name="n3" doxytag="TNSCollection::delta"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="ttypes_8h.html#a5">ccIndex</a> TNSCollection::delta<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This value is used every time the array must be enlarged. In this case a number of delta pointers will be added to the array. +<p> +delta is the number of items by which to increase the items list whenever it becomes full. If delta is zero, the collection cannot grow beyond the size set by limit. +<p> +Definition at line <a class="el" href="tvobjs_8h-source.html#l00385">385</a> of file <a class="el" href="tvobjs_8h-source.html">tvobjs.h</a>. +<p> +Referenced by <a class="el" href="objects_8h-source.html#l00365">TCollection::TCollection()</a>, and <a class="el" href="tvobjs_8h-source.html#l00427">TNSSortedCollection::TNSSortedCollection()</a>. </td> + </tr> +</table> +<a name="n0" doxytag="TNSCollection::items"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void** TNSCollection::items<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +A pointer to an array of generic item pointers. This variable stores the array starting address. +<p> +Definition at line <a class="el" href="tvobjs_8h-source.html#l00365">365</a> of file <a class="el" href="tvobjs_8h-source.html">tvobjs.h</a>. </td> + </tr> +</table> +<a name="n2" doxytag="TNSCollection::limit"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="ttypes_8h.html#a5">ccIndex</a> TNSCollection::limit<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The currently allocated size (in elements) of the items list. Current size of the array. Greater or equal than count. +<p> +Definition at line <a class="el" href="tvobjs_8h-source.html#l00376">376</a> of file <a class="el" href="tvobjs_8h-source.html">tvobjs.h</a>. </td> + </tr> +</table> +<a name="n4" doxytag="TNSCollection::shouldDelete"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="ttypes_8h.html#a13">Boolean</a> TNSCollection::shouldDelete<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +If set True (the default), the TNSCollection destructor will call <a class="el" href="classTNSCollection.html#a10">freeAll()</a> before setting limit to 0. All objects will be deleted when method <a class="el" href="classTNSCollection.html#a2">shutDown()</a> is called. +<p> +If set False, the destructor simply sets limit to 0. +<p> +Definition at line <a class="el" href="tvobjs_8h-source.html#l00393">393</a> of file <a class="el" href="tvobjs_8h-source.html">tvobjs.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="tvobjs_8h-source.html">tvobjs.h</a></ul> +<hr><address style="align: right;"><small>Generated on Wed Apr 2 22:13:15 2003 for TVision by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.18 </small></address> +</body> +</html> |