<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>CVC3: Context Management</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">CVC3
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Context Management</div> </div>
<div class="ingroups"><a class="el" href="group__BuildingBlocks.html">Building Blocks</a></div></div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Context Management:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__Context.gif" border="0" alt="" usemap="#group____Context"/>
<map name="group____Context" id="group____Context">
<area shape="rect" id="node1" href="group__BuildingBlocks.html" title="Code providing basic infrastructure." alt="" coords="5,5,117,32"/></map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classCVC3_1_1Scope.html">CVC3::Scope</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classCVC3_1_1ContextObjChain.html">CVC3::ContextObjChain</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classCVC3_1_1ContextObj.html">CVC3::ContextObj</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classCVC3_1_1Context.html">CVC3::Context</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classCVC3_1_1ContextManager.html">CVC3::ContextManager</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Manager for multiple contexts. Also holds current context. <a href="classCVC3_1_1ContextManager.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classCVC3_1_1ContextNotifyObj.html">CVC3::ContextNotifyObj</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga3a1efd364586330635a668eae3d2612d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#ga3a1efd364586330635a668eae3d2612d">CVC3::Scope::isCurrent</a> (void) const </td></tr>
<tr class="separator:ga3a1efd364586330635a668eae3d2612d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3fcf473cd27da6c7498f462650f75ac8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#ga3fcf473cd27da6c7498f462650f75ac8">CVC3::Scope::addToChain</a> (ContextObjChain *obj)</td></tr>
<tr class="memdesc:ga3fcf473cd27da6c7498f462650f75ac8"><td class="mdescLeft"> </td><td class="mdescRight">Called by <a class="el" href="classCVC3_1_1ContextObj.html">ContextObj</a> when created. <a href="#ga3fcf473cd27da6c7498f462650f75ac8"></a><br/></td></tr>
<tr class="separator:ga3fcf473cd27da6c7498f462650f75ac8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga745d55cc6d3ab3bea1afe675fd7ce7a7"><td class="memItemLeft" align="right" valign="top">Scope * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#ga745d55cc6d3ab3bea1afe675fd7ce7a7">CVC3::Scope::topScope</a> () const </td></tr>
<tr class="separator:ga745d55cc6d3ab3bea1afe675fd7ce7a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1b0a5ef8d8aef498218f0dfddea851a7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#ga1b0a5ef8d8aef498218f0dfddea851a7">CVC3::Scope::restore</a> (void)</td></tr>
<tr class="memdesc:ga1b0a5ef8d8aef498218f0dfddea851a7"><td class="mdescLeft"> </td><td class="mdescRight">Restore all the values. <a href="#ga1b0a5ef8d8aef498218f0dfddea851a7"></a><br/></td></tr>
<tr class="separator:ga1b0a5ef8d8aef498218f0dfddea851a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab3133d36e9074eb69255c4f36ccc3aad"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#gab3133d36e9074eb69255c4f36ccc3aad">CVC3::ContextObj::ContextObj</a> (Context *context)</td></tr>
<tr class="memdesc:gab3133d36e9074eb69255c4f36ccc3aad"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="classCVC3_1_1ContextObj.html">ContextObj</a>. <a href="#gab3133d36e9074eb69255c4f36ccc3aad"></a><br/></td></tr>
<tr class="separator:gab3133d36e9074eb69255c4f36ccc3aad"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Infrastructure for backtrackable data structures. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga3a1efd364586330635a668eae3d2612d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool CVC3::Scope::isCurrent </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="context_8h_source.html#l00347">347</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga3fcf473cd27da6c7498f462650f75ac8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CVC3::Scope::addToChain </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCVC3_1_1ContextObjChain.html">ContextObjChain</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called by <a class="el" href="classCVC3_1_1ContextObj.html">ContextObj</a> when created. </p>
<p>Definition at line <a class="el" href="context_8h_source.html#l00350">350</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p>References <a class="el" href="context_8h_source.html#l00139">CVC3::ContextObjChain::d_restoreChainNext</a>, and <a class="el" href="context_8h_source.html#l00144">CVC3::ContextObjChain::d_restoreChainPrev</a>.</p>
<p>Referenced by <a class="el" href="cdflags_8cpp_source.html#l00031">CVC3::CDFlags::update()</a>.</p>
</div>
</div>
<a class="anchor" id="ga745d55cc6d3ab3bea1afe675fd7ce7a7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Scope * CVC3::Scope::topScope </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="context_8h_source.html#l00358">358</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p>References <a class="el" href="context_8h_source.html#l00358">CVC3::Scope::topScope()</a>.</p>
<p>Referenced by <a class="el" href="context_8h_source.html#l00358">CVC3::Scope::topScope()</a>.</p>
</div>
</div>
<a class="anchor" id="ga1b0a5ef8d8aef498218f0dfddea851a7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CVC3::Scope::restore </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Restore all the values. </p>
<p>Definition at line <a class="el" href="context_8h_source.html#l00360">360</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p>Referenced by <a class="el" href="context_8cpp_source.html#l00266">CVC3::Context::pop()</a>.</p>
</div>
</div>
<a class="anchor" id="gab3133d36e9074eb69255c4f36ccc3aad"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CVC3::ContextObj::ContextObj </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCVC3_1_1Context.html">Context</a> * </td>
<td class="paramname"><em>context</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new <a class="el" href="classCVC3_1_1ContextObj.html">ContextObj</a>. </p>
<p>The initial scope is set to the bottom scope by default, to reduce the work of <a class="el" href="group__ExprStream__Manip.html#gaddb050a787be87116afc51791293d3be" title="Restore the indentation.">pop()</a> (otherwise, if the object is defined only on a very high scope, its scope will be moved down with each pop). If 'atBottomScope' == false, the scope is set to the current scope. </p>
<p>Definition at line <a class="el" href="context_8h_source.html#l00371">371</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p>References <a class="el" href="context_8h_source.html#l00156">CVC3::ContextObjChain::ContextObjChain()</a>, <a class="el" href="context_8h_source.html#l00147">CVC3::ContextObjChain::d_restore</a>, <a class="el" href="debug_8h_source.html#l00408">DebugAssert</a>, and <a class="el" href="debug_8h_source.html#l00406">IF_DEBUG</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 16 2013 13:25:16 for CVC3 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
</body>
</html>
