Add www pages
[urpo] / www / apidoc / html / class_urpo_job.html
diff --git a/www/apidoc/html/class_urpo_job.html b/www/apidoc/html/class_urpo_job.html
new file mode 100644 (file)
index 0000000..981f648
--- /dev/null
@@ -0,0 +1,279 @@
+<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
+<!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>Urpo: UrpoJob Class Reference</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.6.3 -->
+<script type="text/javascript"><!--
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+--></script>
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="index.html"><span>Main&nbsp;Page</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">
+        <img id="MSearchSelect" src="search/search.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)"/>
+        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+        </div>
+      </li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
+      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+    </ul>
+  </div>
+</div>
+<div class="contents">
+<h1>UrpoJob Class Reference</h1><!-- doxytag: class="UrpoJob" -->
+<p>Base class for jobs (abstract).  
+<a href="#_details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="urpojob_8h_source.html">urpojob.h</a>&gt;</code></p>
+<div class="dynheader">
+Inheritance diagram for UrpoJob:</div>
+<div class="dynsection">
+ <div class="center">
+  <img src="class_urpo_job.png" usemap="#UrpoJob_map" alt=""/>
+  <map id="UrpoJob_map" name="UrpoJob_map">
+<area href="class_printer_list_job.html" alt="PrinterListJob" shape="rect" coords="0,56,90,80"/>
+<area href="class_print_job.html" alt="PrintJob" shape="rect" coords="100,56,190,80"/>
+</map>
+ </div>
+</div>
+
+<p><a href="class_urpo_job-members.html">List of all members.</a></p>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td colspan="2"><h2>Public Types</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>JobStatus</b> { <br/>
+&nbsp;&nbsp;<b>Ready</b>, 
+<b>Running</b>, 
+<b>Successed</b>, 
+<b>Failed</b>, 
+<br/>
+&nbsp;&nbsp;<b>Cancelled</b>
+<br/>
+ }</td></tr>
+<tr><td colspan="2"><h2>Public Slots</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae4549ace1bc2331462d22281b8cbdf0f"></a><!-- doxytag: member="UrpoJob::start" ref="ae4549ace1bc2331462d22281b8cbdf0f" args="()" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#ae4549ace1bc2331462d22281b8cbdf0f">start</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start job. <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a652109c42b7d8493a335d07ade7a0b0b"></a><!-- doxytag: member="UrpoJob::cancel" ref="a652109c42b7d8493a335d07ade7a0b0b" args="()" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#a652109c42b7d8493a335d07ade7a0b0b">cancel</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cancel job. <br/></td></tr>
+<tr><td colspan="2"><h2>Signals</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1d96b9fac5621bd926289fe795ec371"></a><!-- doxytag: member="UrpoJob::debugMessage" ref="aa1d96b9fac5621bd926289fe795ec371" args="(QString message)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><b>debugMessage</b> (QString message)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#ab931a6a72a6f49c8919dcd695197288e">finished</a> (bool successed, QString errorStr=QString())</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Job finished (successed of failed).  <a href="#ab931a6a72a6f49c8919dcd695197288e"></a><br/></td></tr>
+<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1baca70c87d4734d26da8b10bda0f80c"></a><!-- doxytag: member="UrpoJob::UrpoJob" ref="a1baca70c87d4734d26da8b10bda0f80c" args="(UrpoConnection *connection)" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><b>UrpoJob</b> (<a class="el" href="class_urpo_connection.html">UrpoConnection</a> *connection)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">JobStatus&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#af07522b7d875bfc36a694f07d580fc8b">getStatus</a> () const </td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Job status.  <a href="#af07522b7d875bfc36a694f07d580fc8b"></a><br/></td></tr>
+<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08decf8e7432c1d627391a58aa7b790b"></a><!-- doxytag: member="UrpoJob::startJob" ref="a08decf8e7432c1d627391a58aa7b790b" args="()=0" -->
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>startJob</b> ()=0</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acec414a2b0d84c0bd29efa52d1e42481"></a><!-- doxytag: member="UrpoJob::cancelJob" ref="acec414a2b0d84c0bd29efa52d1e42481" args="()=0" -->
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>cancelJob</b> ()=0</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#adca3f19275978d0514229c26871e8a19">finish</a> (JobStatus status)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finish job.  <a href="#adca3f19275978d0514229c26871e8a19"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#a79d4688e55e26b373e103cb7238df9b6">fail</a> (QString errorString)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finish failed job.  <a href="#a79d4688e55e26b373e103cb7238df9b6"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c06ededd10c78ca736df20e1df1e269"></a><!-- doxytag: member="UrpoJob::getConnection" ref="a5c06ededd10c78ca736df20e1df1e269" args="()" -->
+<a class="el" href="class_urpo_connection.html">UrpoConnection</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#a5c06ededd10c78ca736df20e1df1e269">getConnection</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get connection pointer. <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#a6105276a7d9c7431aa5f24d374e33f84">sendDebugMessage</a> (QString message)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send debug message.  <a href="#a6105276a7d9c7431aa5f24d374e33f84"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab54ee3b2ba06bfc71c310c746a846c48"></a><!-- doxytag: member="UrpoJob::newProcess" ref="ab54ee3b2ba06bfc71c310c746a846c48" args="()" -->
+<a class="el" href="class_urpo_process.html">UrpoProcess</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#ab54ee3b2ba06bfc71c310c746a846c48">newProcess</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create new <a class="el" href="class_urpo_process.html" title="Process running ssh/scp command.">UrpoProcess</a>. <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89534d211decc6ab45de2b468045eef1"></a><!-- doxytag: member="UrpoJob::setStatus" ref="a89534d211decc6ab45de2b468045eef1" args="(JobStatus status)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#a89534d211decc6ab45de2b468045eef1">setStatus</a> (JobStatus status)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set job status. <br/></td></tr>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p>Base class for jobs (abstract). </p>
+<dl class="author"><dt><b>Author:</b></dt><dd>Arto Hyvättinen </dd></dl>
+<dl class="version"><dt><b>Version:</b></dt><dd>0 </dd></dl>
+<dl class="date"><dt><b>Date:</b></dt><dd>2010-06-11 </dd></dl>
+
+<p>Definition at line <a class="el" href="urpojob_8h_source.html#l00040">40</a> of file <a class="el" href="urpojob_8h_source.html">urpojob.h</a>.</p>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="a79d4688e55e26b373e103cb7238df9b6"></a><!-- doxytag: member="UrpoJob::fail" ref="a79d4688e55e26b373e103cb7238df9b6" args="(QString errorString)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void UrpoJob::fail </td>
+          <td>(</td>
+          <td class="paramtype">QString&nbsp;</td>
+          <td class="paramname"> <em>errorString</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [protected]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Finish failed job. </p>
+<p>emit <a class="el" href="class_urpo_job.html#ab931a6a72a6f49c8919dcd695197288e" title="Job finished (successed of failed).">finished()</a> with error status and message </p>
+
+<p>Definition at line <a class="el" href="urpojob_8cpp_source.html#l00061">61</a> of file <a class="el" href="urpojob_8cpp_source.html">urpojob.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="adca3f19275978d0514229c26871e8a19"></a><!-- doxytag: member="UrpoJob::finish" ref="adca3f19275978d0514229c26871e8a19" args="(JobStatus status)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void UrpoJob::finish </td>
+          <td>(</td>
+          <td class="paramtype">JobStatus&nbsp;</td>
+          <td class="paramname"> <em>status</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [protected]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Finish job. </p>
+<ul>
+<li>status Job status (Successed, Failed, Cancelled) </li>
+</ul>
+
+<p>Definition at line <a class="el" href="urpojob_8cpp_source.html#l00052">52</a> of file <a class="el" href="urpojob_8cpp_source.html">urpojob.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="ab931a6a72a6f49c8919dcd695197288e"></a><!-- doxytag: member="UrpoJob::finished" ref="ab931a6a72a6f49c8919dcd695197288e" args="(bool successed, QString errorStr=QString())" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void UrpoJob::finished </td>
+          <td>(</td>
+          <td class="paramtype">bool&nbsp;</td>
+          <td class="paramname"> <em>successed</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">QString&nbsp;</td>
+          <td class="paramname"> <em>errorStr</em> = <code>QString()</code></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td><code> [signal]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Job finished (successed of failed). </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>successed</em>&nbsp;</td><td>True if job successed, false if failed </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a class="anchor" id="af07522b7d875bfc36a694f07d580fc8b"></a><!-- doxytag: member="UrpoJob::getStatus" ref="af07522b7d875bfc36a694f07d580fc8b" args="() const " -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">JobStatus UrpoJob::getStatus </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td> const<code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Job status. </p>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Job status (Ready, Running, Successed, Failed </dd></dl>
+
+<p>Definition at line <a class="el" href="urpojob_8h_source.html#l00059">59</a> of file <a class="el" href="urpojob_8h_source.html">urpojob.h</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a6105276a7d9c7431aa5f24d374e33f84"></a><!-- doxytag: member="UrpoJob::sendDebugMessage" ref="a6105276a7d9c7431aa5f24d374e33f84" args="(QString message)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void UrpoJob::sendDebugMessage </td>
+          <td>(</td>
+          <td class="paramtype">QString&nbsp;</td>
+          <td class="paramname"> <em>message</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [protected]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Send debug message. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>Message to debug monitor</td></tr>
+  </table>
+  </dd>
+</dl>
+<p>If debug monitor has been connected, send message to debug monitor </p>
+
+<p>Definition at line <a class="el" href="urpojob_8cpp_source.html#l00039">39</a> of file <a class="el" href="urpojob_8cpp_source.html">urpojob.cpp</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following files:<ul>
+<li>/holvi/arto/ohjelmointi/urpo-0.0/urpo/<a class="el" href="urpojob_8h_source.html">urpojob.h</a></li>
+<li>/holvi/arto/ohjelmointi/urpo-0.0/urpo/<a class="el" href="urpojob_8cpp_source.html">urpojob.cpp</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">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Enumerator</a></div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Jun 21 21:38:16 2010 for Urpo by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
+</body>
+</html>