<!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>C++ API frePPLe: frepple::utils::ScopeMutexLock Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="../styles.css" rel="stylesheet" type="text/css">
</head>
<body>
<div id="container">
<div id="menubar">
<div id="logo" align="center">
<br/><img src='../frepple.bmp' alt="frepple" /><br/>
<a href='http://www.frepple.com/'>
<strong>a Free<br/>Production Planning<br/>Library</strong>
</a>
</div>
<div id="menu">
<br/>
<h3><a href='../Main/HomePage.html'>Main</a></h3>
<h3><a href='../UI/Main.html'>User Manual</a></h3>
<h3><a href='../Tutorial/Main.html'>Tutorial</a></h3>
<h3><a href='../Frepple/Main.html'>Reference Manual</a></h3>
<h3><a href='../Main/FAQ.html'>FAQ</a></h3>
<h3><a href='index.html'>C++ API</a></h3>
<br/>
</div>
</div>
<div id="content">
<br/>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00256.html">frepple</a>::<a class="el" href="a00257.html">utils</a>::<a class="el" href="a00163.html">ScopeMutexLock</a>
</div>
</div>
<div class="contents">
<h1>frepple::utils::ScopeMutexLock Class Reference</h1><!-- doxytag: class="frepple::utils::ScopeMutexLock" --><!-- doxytag: inherits="frepple::utils::NonCopyable" -->
<p>This is a convenience class that makes it easy (and exception-safe) to lock a mutex in a scope.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00252_source.html">utils.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for frepple::utils::ScopeMutexLock:</div>
<div class="dynsection">
<div class="center"><img src="a00628.png" border="0" usemap="#frepple_1_1utils_1_1_scope_mutex_lock_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1utils_1_1_scope_mutex_lock_inherit__map" id="frepple_1_1utils_1_1_scope_mutex_lock_inherit__map">
<area shape="rect" id="node2" href="a00119.html" title="Class NonCopyable is a base class. Derive your own class from it when you want to..." alt="" coords="17,6,193,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00629.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#a2b94680e02aae5c91a8feedd1065dba7">ScopeMutexLock</a> (<a class="el" href="a00117.html">Mutex</a> &imtx)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#a2c28ebb21d751564c4782963e513e577">~ScopeMutexLock</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00117.html">Mutex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#a83a307dc6109728de1091890a0de6cf6">mtx</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This is a convenience class that makes it easy (and exception-safe) to lock a mutex in a scope. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l00836">836</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2b94680e02aae5c91a8feedd1065dba7"></a><!-- doxytag: member="frepple::utils::ScopeMutexLock::ScopeMutexLock" ref="a2b94680e02aae5c91a8feedd1065dba7" args="(Mutex &imtx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::ScopeMutexLock::ScopeMutexLock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00117.html">Mutex</a> & </td>
<td class="paramname"> <em>imtx</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00252_source.html#l00841">841</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2c28ebb21d751564c4782963e513e577"></a><!-- doxytag: member="frepple::utils::ScopeMutexLock::~ScopeMutexLock" ref="a2c28ebb21d751564c4782963e513e577" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::ScopeMutexLock::~ScopeMutexLock </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00252_source.html#l00842">842</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a83a307dc6109728de1091890a0de6cf6"></a><!-- doxytag: member="frepple::utils::ScopeMutexLock::mtx" ref="a83a307dc6109728de1091890a0de6cf6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00117.html">Mutex</a>& <a class="el" href="a00163.html#a83a307dc6109728de1091890a0de6cf6">frepple::utils::ScopeMutexLock::mtx</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00252_source.html#l00839">839</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00252_source.html">utils.h</a></li>
</ul>
</div>
<hr size="1"/><address style="align: right;"><small>Documentation generated for frePPLe by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"/></a></small></address>
</div>
</div>
</body>
</html>
