<!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>mrpt::system::CFileSystemWatcher Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div> <div align="right"> <a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a> </div> <!-- Generated by Doxygen 1.7.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <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 class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <div class="left"> <form id="FSearchBox" action="search.php" method="get"> <img id="MSearchSelect" src="search/mag.png" alt=""/> <input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)"/> </form> </div><div class="right"></div> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <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="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespacemrpt.html">mrpt</a> </li> <li class="navelem"><a class="el" href="namespacemrpt_1_1system.html">system</a> </li> <li class="navelem"><a class="el" href="classmrpt_1_1system_1_1_c_file_system_watcher.html">CFileSystemWatcher</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="#pri-attribs">Private Attributes</a> </div> <div class="headertitle"> <div class="title">mrpt::system::CFileSystemWatcher Class Reference<div class="ingroups"><a class="el" href="group__mrpt__base__grp.html">[mrpt-base]</a></div></div> </div> </div> <div class="contents"> <!-- doxytag: class="mrpt::system::CFileSystemWatcher" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>This class subscribes to notifications of file system changes, thus it can be used to efficiently stay informed about changes in a directory tree. </p> <ul> <li>Windows: Requires Windows 2000 or newer.</li> <li>Linux: Requires kernel 2.6.13 or newer. Using this class in an old Linux or other unsoported system (Unix,etc...) has no effect, i.e. no notification will be ever received. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1system_1_1_c_directory_explorer.html" title="This class allows the enumeration of the files/directories that exist into a given path...">CDirectoryExplorer</a> </dd></dl> </li> </ul> </div> <p><code>#include <<a class="el" href="_c_file_system_watcher_8h_source.html">mrpt/system/CFileSystemWatcher.h</a>></code></p> <p><a href="classmrpt_1_1system_1_1_c_file_system_watcher-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="nested-classes"></a> Classes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html">TFileSystemChange</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Each of the changes detected by utils::CFileSystemWatcher. <a href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#details">More...</a><br/></td></tr> <tr><td colspan="2"><h2><a name="pub-types"></a> Public Types</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classstd_1_1deque.html">std::deque</a><br class="typebreak"/> < <a class="el" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html">TFileSystemChange</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1system_1_1_c_file_system_watcher.html#ac173fee6e9ae444aa792fb3b7be2ffc1">TFileSystemChangeList</a></td></tr> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1system_1_1_c_file_system_watcher.html#a62046bb72d7db0651ed865658b27bbf1">CFileSystemWatcher</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &path)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates the subscription to a specified path. <a href="#a62046bb72d7db0651ed865658b27bbf1"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1system_1_1_c_file_system_watcher.html#ad48817e4abffd0003173c8e3429b754b">~CFileSystemWatcher</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ad48817e4abffd0003173c8e3429b754b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1system_1_1_c_file_system_watcher.html#a7beaf664e622c4949ed4855657fac883">getChanges</a> (<a class="el" href="classmrpt_1_1system_1_1_c_file_system_watcher.html#ac173fee6e9ae444aa792fb3b7be2ffc1">TFileSystemChangeList</a> &out_list)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Call this method sometimes to get the list of changes in the watched directory. <a href="#a7beaf664e622c4949ed4855657fac883"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="pri-attribs"></a> Private Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1system_1_1_c_file_system_watcher.html#ab8d6793467721e8b7e7b8ec7963ed156">m_watchedDirectory</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Ended in "/". <a href="#ab8d6793467721e8b7e7b8ec7963ed156"></a><br/></td></tr> </table> <hr/><h2>Member Typedef Documentation</h2> <a class="anchor" id="ac173fee6e9ae444aa792fb3b7be2ffc1"></a><!-- doxytag: member="mrpt::system::CFileSystemWatcher::TFileSystemChangeList" ref="ac173fee6e9ae444aa792fb3b7be2ffc1" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="classstd_1_1deque.html">std::deque</a><<a class="el" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html">TFileSystemChange</a>> <a class="el" href="classmrpt_1_1system_1_1_c_file_system_watcher.html#ac173fee6e9ae444aa792fb3b7be2ffc1">mrpt::system::CFileSystemWatcher::TFileSystemChangeList</a></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_c_file_system_watcher_8h_source.html#l00075">75</a> of file <a class="el" href="_c_file_system_watcher_8h_source.html">CFileSystemWatcher.h</a>.</p> </div> </div> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a62046bb72d7db0651ed865658b27bbf1"></a><!-- doxytag: member="mrpt::system::CFileSystemWatcher::CFileSystemWatcher" ref="a62046bb72d7db0651ed865658b27bbf1" args="(const std::string &path)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">mrpt::system::CFileSystemWatcher::CFileSystemWatcher </td> <td>(</td> <td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td> <td class="paramname"><em>path</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Creates the subscription to a specified path. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">path</td><td>The file or directory to watch. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ad48817e4abffd0003173c8e3429b754b"></a><!-- doxytag: member="mrpt::system::CFileSystemWatcher::~CFileSystemWatcher" ref="ad48817e4abffd0003173c8e3429b754b" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual mrpt::system::CFileSystemWatcher::~CFileSystemWatcher </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Destructor. </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a7beaf664e622c4949ed4855657fac883"></a><!-- doxytag: member="mrpt::system::CFileSystemWatcher::getChanges" ref="a7beaf664e622c4949ed4855657fac883" args="(TFileSystemChangeList &out_list)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mrpt::system::CFileSystemWatcher::getChanges </td> <td>(</td> <td class="paramtype"><a class="el" href="classmrpt_1_1system_1_1_c_file_system_watcher.html#ac173fee6e9ae444aa792fb3b7be2ffc1">TFileSystemChangeList</a> & </td> <td class="paramname"><em>out_list</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Call this method sometimes to get the list of changes in the watched directory. </p> <dl class="see"><dt><b>See also:</b></dt><dd>processChange </dd></dl> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="ab8d6793467721e8b7e7b8ec7963ed156"></a><!-- doxytag: member="mrpt::system::CFileSystemWatcher::m_watchedDirectory" ref="ab8d6793467721e8b7e7b8ec7963ed156" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> <a class="el" href="classmrpt_1_1system_1_1_c_file_system_watcher.html#ab8d6793467721e8b7e7b8ec7963ed156">mrpt::system::CFileSystemWatcher::m_watchedDirectory</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Ended in "/". </p> <p>Definition at line <a class="el" href="_c_file_system_watcher_8h_source.html#l00092">92</a> of file <a class="el" href="_c_file_system_watcher_8h_source.html">CFileSystemWatcher.h</a>.</p> </div> </div> </div> <br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>