<!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"/> <meta name="generator" content="Doxygen 1.8.8"/> <title>Exiv2: Action::TaskFactory Class Reference</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="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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">Exiv2 </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.8 --> <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="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="examples.html"><span>Examples</span></a></li> <li> <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 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> <!-- 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>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</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> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceAction.html">Action</a></li><li class="navelem"><a class="el" href="classAction_1_1TaskFactory.html">TaskFactory</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="classAction_1_1TaskFactory-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Action::TaskFactory Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><a class="el" href="classAction_1_1Task.html" title="Abstract base class for all concrete actions. ">Task</a> factory. <a href="classAction_1_1TaskFactory.html#details">More...</a></p> <p><code>#include <actions.hpp></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:aecfc2194d99c852300437ac2e96dc4b8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aecfc2194d99c852300437ac2e96dc4b8"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAction_1_1TaskFactory.html#aecfc2194d99c852300437ac2e96dc4b8">cleanup</a> ()</td></tr> <tr class="memdesc:aecfc2194d99c852300437ac2e96dc4b8"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr> <tr class="separator:aecfc2194d99c852300437ac2e96dc4b8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a55ca06f5a6cf3dff1bb30fd5cad4286b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classAction_1_1Task.html#a76329f48810f8e555b233d9f699faadd">Task::AutoPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAction_1_1TaskFactory.html#a55ca06f5a6cf3dff1bb30fd5cad4286b">create</a> (<a class="el" href="namespaceAction.html#a71af957ce05611bb128a23679e43b3d2">TaskType</a> type)</td></tr> <tr class="memdesc:a55ca06f5a6cf3dff1bb30fd5cad4286b"><td class="mdescLeft"> </td><td class="mdescRight">Create a task. <a href="#a55ca06f5a6cf3dff1bb30fd5cad4286b">More...</a><br /></td></tr> <tr class="separator:a55ca06f5a6cf3dff1bb30fd5cad4286b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5ea557e379916fb47f0785022a8eab78"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAction_1_1TaskFactory.html#a5ea557e379916fb47f0785022a8eab78">registerTask</a> (<a class="el" href="namespaceAction.html#a71af957ce05611bb128a23679e43b3d2">TaskType</a> type, <a class="el" href="classAction_1_1Task.html#a76329f48810f8e555b233d9f699faadd">Task::AutoPtr</a> task)</td></tr> <tr class="memdesc:a5ea557e379916fb47f0785022a8eab78"><td class="mdescLeft"> </td><td class="mdescRight">Register a task prototype together with its type. <a href="#a5ea557e379916fb47f0785022a8eab78">More...</a><br /></td></tr> <tr class="separator:a5ea557e379916fb47f0785022a8eab78"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:a27c920b95806b9b18ebb58553d8b4fa4"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classAction_1_1TaskFactory.html">TaskFactory</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAction_1_1TaskFactory.html#a27c920b95806b9b18ebb58553d8b4fa4">instance</a> ()</td></tr> <tr class="memdesc:a27c920b95806b9b18ebb58553d8b4fa4"><td class="mdescLeft"> </td><td class="mdescRight">Get access to the task factory. <a href="#a27c920b95806b9b18ebb58553d8b4fa4">More...</a><br /></td></tr> <tr class="separator:a27c920b95806b9b18ebb58553d8b4fa4"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p><a class="el" href="classAction_1_1Task.html" title="Abstract base class for all concrete actions. ">Task</a> factory. </p> <p>Creates an instance of the task of the requested type. The factory is implemented as a singleton, which can be accessed only through the static member function <a class="el" href="classAction_1_1TaskFactory.html#a27c920b95806b9b18ebb58553d8b4fa4" title="Get access to the task factory. ">instance()</a>. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a55ca06f5a6cf3dff1bb30fd5cad4286b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classAction_1_1Task.html#a76329f48810f8e555b233d9f699faadd">Task::AutoPtr</a> Action::TaskFactory::create </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceAction.html#a71af957ce05611bb128a23679e43b3d2">TaskType</a> </td> <td class="paramname"><em>type</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Create a task. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">type</td><td>Identifies the type of task to create. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>An auto pointer that owns a task of the requested type. If the task type is not supported, the pointer is 0. </dd></dl> <dl class="section remark"><dt>Remarks</dt><dd>The caller of the function should check the content of the returned auto pointer and take appropriate action (e.g., throw an exception) if it is 0. </dd></dl> <p>References <a class="el" href="classAction_1_1Task.html#a782c3b402c06625c7982cf4b668ffb4e">Action::Task::clone()</a>.</p> </div> </div> <a class="anchor" id="a27c920b95806b9b18ebb58553d8b4fa4"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classAction_1_1TaskFactory.html">TaskFactory</a> & Action::TaskFactory::instance </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Get access to the task factory. </p> <p>Clients access the task factory exclusively through this method. </p> </div> </div> <a class="anchor" id="a5ea557e379916fb47f0785022a8eab78"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Action::TaskFactory::registerTask </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceAction.html#a71af957ce05611bb128a23679e43b3d2">TaskType</a> </td> <td class="paramname"><em>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classAction_1_1Task.html#a76329f48810f8e555b233d9f699faadd">Task::AutoPtr</a> </td> <td class="paramname"><em>task</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Register a task prototype together with its type. </p> <p>The task factory creates new tasks of a given type by cloning its associated prototype. Additional tasks can be registered. If called for a type which already exists in the list, the corresponding prototype is replaced.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">type</td><td><a class="el" href="classAction_1_1Task.html" title="Abstract base class for all concrete actions. ">Task</a> type. </td></tr> <tr><td class="paramname">task</td><td>Pointer to the prototype. Ownership is transfered to the task factory. That's what the auto pointer indicates. </td></tr> </table> </dd> </dl> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="actions_8hpp.html">actions.hpp</a></li> <li>actions.cpp</li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Mar 4 2016 17:51:50 for Exiv2 by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.8 </small></address> </body> </html>