<!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"/>
<title>libcollection: Constants defining add modes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libcollection <span id="projectnumber">0.1.3</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> </div>
<div class="headertitle">
<div class="title">Constants defining add modes</div> </div>
<div class="ingroups"><a class="el" href="group__collection.html">COLLECTION interface</a></div></div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae2fca8f8be1327f2dd9d6d47701e91f8"></a><!-- doxytag: member="addmodes::COL_ADD_MODE_REFERENCE" ref="gae2fca8f8be1327f2dd9d6d47701e91f8" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__addmodes.html#gae2fca8f8be1327f2dd9d6d47701e91f8">COL_ADD_MODE_REFERENCE</a>   0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a collection into a collection as a reference. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__addmodes.html#ga56ce7a9dfa0754961cb6fffb4135c353">COL_ADD_MODE_EMBED</a>   1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Embed the collection into another collection. <a href="#ga56ce7a9dfa0754961cb6fffb4135c353"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__addmodes.html#ga44d60c2e4c5be30183c189d0d0b1ecd5">COL_ADD_MODE_CLONE</a>   2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform a deep copy. <a href="#ga44d60c2e4c5be30183c189d0d0b1ecd5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__addmodes.html#ga6777a9bfcebbf1f082e8492d071a2c4b">COL_ADD_MODE_FLAT</a>   3</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a flattened copy. <a href="#ga6777a9bfcebbf1f082e8492d071a2c4b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__addmodes.html#gae24e0decac0d1467c12cc5089bd4da82">COL_ADD_MODE_FLATDOT</a>   4</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a flattened copy with constructed names. <a href="#gae24e0decac0d1467c12cc5089bd4da82"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>The following constants define how one collection can be added to another. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga44d60c2e4c5be30183c189d0d0b1ecd5"></a><!-- doxytag: member="collection.h::COL_ADD_MODE_CLONE" ref="ga44d60c2e4c5be30183c189d0d0b1ecd5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COL_ADD_MODE_CLONE   2</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Perform a deep copy. </p>
<p>Perform a deep copy of a collection with all its sub collections </p>
</div>
</div>
<a class="anchor" id="ga56ce7a9dfa0754961cb6fffb4135c353"></a><!-- doxytag: member="collection.h::COL_ADD_MODE_EMBED" ref="ga56ce7a9dfa0754961cb6fffb4135c353" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COL_ADD_MODE_EMBED   1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Embed the collection into another collection. </p>
<p>The collection will become part of another collection. After this operation the handle to the collection being added should not be used or freed. Embedding a collection can be done only once. If the collection is referenced by another collection, the operation will fail. </p>
</div>
</div>
<a class="anchor" id="ga6777a9bfcebbf1f082e8492d071a2c4b"></a><!-- doxytag: member="collection.h::COL_ADD_MODE_FLAT" ref="ga6777a9bfcebbf1f082e8492d071a2c4b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COL_ADD_MODE_FLAT   3</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a flattened copy. </p>
<p>Create a deep copy of a collection with its sub collections flattening and NOT resolving duplicates. </p>
</div>
</div>
<a class="anchor" id="gae24e0decac0d1467c12cc5089bd4da82"></a><!-- doxytag: member="collection.h::COL_ADD_MODE_FLATDOT" ref="gae24e0decac0d1467c12cc5089bd4da82" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COL_ADD_MODE_FLATDOT   4</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a flattened copy with constructed names. </p>
<p>Creates a deep copy of a collection with its sub collections flattening and NOT resolving duplicates. Names are constructed in dotted notation. For example the sub collection named "sub" containing "foo" and "bar" will be flattened as: "sub.foo", "sub.bar". </p>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Sep 15 2011 for libcollection by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
