git.maemo.org Git - urpo/blob - www/apidoc/html/class_urpo_job.html

   1 <!-- This comment will put IE 6, 7 and 8 in quirks mode -->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <title>Urpo: UrpoJob Class Reference</title>
   7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   8 <link href="search/search.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javaScript" src="search/search.js"></script>
  10 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  11 </head>
  12 <body onload='searchBox.OnSelectItem(0);'>
  13 <!-- Generated by Doxygen 1.6.3 -->
  14 <script type="text/javascript"><!--
  15 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  16 --></script>
  17 <div class="navigation" id="top">
  18   <div class="tabs">
  19     <ul>
  20       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  21       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  22       <li><a href="files.html"><span>Files</span></a></li>
  23       <li>
  24         <div id="MSearchBox" class="MSearchBoxInactive">
  25         <img id="MSearchSelect" src="search/search.png"
  26              onmouseover="return searchBox.OnSearchSelectShow()"
  27              onmouseout="return searchBox.OnSearchSelectHide()"
  28              alt=""/>
  29         <input type="text" id="MSearchField" value="Search" accesskey="S"
  30              onfocus="searchBox.OnSearchFieldFocus(true)"
  31              onblur="searchBox.OnSearchFieldFocus(false)"
  32              onkeyup="searchBox.OnSearchFieldChange(event)"/>
  33         <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  34         </div>
  35       </li>
  36     </ul>
  37   </div>
  38   <div class="tabs">
  39     <ul>
  40       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  41       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  42       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  43     </ul>
  44   </div>
  45 </div>
  46 <div class="contents">
  47 <h1>UrpoJob Class Reference</h1><!-- doxytag: class="UrpoJob" -->
  48 <p>Base class for jobs (abstract).
  49 <a href="#_details">More...</a></p>
  50
  51 <p><code>#include &lt;<a class="el" href="urpojob_8h_source.html">urpojob.h</a>&gt;</code></p>
  52 <div class="dynheader">
  53 Inheritance diagram for UrpoJob:</div>
  54 <div class="dynsection">
  55  <div class="center">
  56   <img src="class_urpo_job.png" usemap="#UrpoJob_map" alt=""/>
  57   <map id="UrpoJob_map" name="UrpoJob_map">
  58 <area href="class_printer_list_job.html" alt="PrinterListJob" shape="rect" coords="0,56,90,80"/>
  59 <area href="class_print_job.html" alt="PrintJob" shape="rect" coords="100,56,190,80"/>
  60 </map>
  61  </div>
  62 </div>
  63
  64 <p><a href="class_urpo_job-members.html">List of all members.</a></p>
  65 <table border="0" cellpadding="0" cellspacing="0">
  66 <tr><td colspan="2"><h2>Public Types</h2></td></tr>
  67 <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>JobStatus</b> { <br/>
  68 &nbsp;&nbsp;<b>Ready</b>,
  69 <b>Running</b>,
  70 <b>Successed</b>,
  71 <b>Failed</b>,
  72 <br/>
  73 &nbsp;&nbsp;<b>Cancelled</b>
  74 <br/>
  75  }</td></tr>
  76 <tr><td colspan="2"><h2>Public Slots</h2></td></tr>
  77 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae4549ace1bc2331462d22281b8cbdf0f"></a><!-- doxytag: member="UrpoJob::start" ref="ae4549ace1bc2331462d22281b8cbdf0f" args="()" -->
  78 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#ae4549ace1bc2331462d22281b8cbdf0f">start</a> ()</td></tr>
  79 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start job. <br/></td></tr>
  80 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a652109c42b7d8493a335d07ade7a0b0b"></a><!-- doxytag: member="UrpoJob::cancel" ref="a652109c42b7d8493a335d07ade7a0b0b" args="()" -->
  81 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#a652109c42b7d8493a335d07ade7a0b0b">cancel</a> ()</td></tr>
  82 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cancel job. <br/></td></tr>
  83 <tr><td colspan="2"><h2>Signals</h2></td></tr>
  84 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1d96b9fac5621bd926289fe795ec371"></a><!-- doxytag: member="UrpoJob::debugMessage" ref="aa1d96b9fac5621bd926289fe795ec371" args="(QString message)" -->
  85 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>debugMessage</b> (QString message)</td></tr>
  86 <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>
  87 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Job finished (successed of failed).  <a href="#ab931a6a72a6f49c8919dcd695197288e"></a><br/></td></tr>
  88 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
  89 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1baca70c87d4734d26da8b10bda0f80c"></a><!-- doxytag: member="UrpoJob::UrpoJob" ref="a1baca70c87d4734d26da8b10bda0f80c" args="(UrpoConnection *connection)" -->
  90 &nbsp;</td><td class="memItemRight" valign="bottom"><b>UrpoJob</b> (<a class="el" href="class_urpo_connection.html">UrpoConnection</a> *connection)</td></tr>
  91 <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>
  92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Job status.  <a href="#af07522b7d875bfc36a694f07d580fc8b"></a><br/></td></tr>
  93 <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
  94 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08decf8e7432c1d627391a58aa7b790b"></a><!-- doxytag: member="UrpoJob::startJob" ref="a08decf8e7432c1d627391a58aa7b790b" args="()=0" -->
  95 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>startJob</b> ()=0</td></tr>
  96 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acec414a2b0d84c0bd29efa52d1e42481"></a><!-- doxytag: member="UrpoJob::cancelJob" ref="acec414a2b0d84c0bd29efa52d1e42481" args="()=0" -->
  97 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>cancelJob</b> ()=0</td></tr>
  98 <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>
  99 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finish job.  <a href="#adca3f19275978d0514229c26871e8a19"></a><br/></td></tr>
 100 <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>
 101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finish failed job.  <a href="#a79d4688e55e26b373e103cb7238df9b6"></a><br/></td></tr>
 102 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c06ededd10c78ca736df20e1df1e269"></a><!-- doxytag: member="UrpoJob::getConnection" ref="a5c06ededd10c78ca736df20e1df1e269" args="()" -->
 103 <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>
 104 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get connection pointer. <br/></td></tr>
 105 <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>
 106 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send debug message.  <a href="#a6105276a7d9c7431aa5f24d374e33f84"></a><br/></td></tr>
 107 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab54ee3b2ba06bfc71c310c746a846c48"></a><!-- doxytag: member="UrpoJob::newProcess" ref="ab54ee3b2ba06bfc71c310c746a846c48" args="()" -->
 108 <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>
 109 <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>
 110 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89534d211decc6ab45de2b468045eef1"></a><!-- doxytag: member="UrpoJob::setStatus" ref="a89534d211decc6ab45de2b468045eef1" args="(JobStatus status)" -->
 111 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#a89534d211decc6ab45de2b468045eef1">setStatus</a> (JobStatus status)</td></tr>
 112 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set job status. <br/></td></tr>
 113 </table>
 114 <hr/><a name="_details"></a><h2>Detailed Description</h2>
 115 <p>Base class for jobs (abstract). </p>
 116 <dl class="author"><dt><b>Author:</b></dt><dd>Arto Hyvättinen </dd></dl>
 117 <dl class="version"><dt><b>Version:</b></dt><dd>0 </dd></dl>
 118 <dl class="date"><dt><b>Date:</b></dt><dd>2010-06-11 </dd></dl>
 119
 120 <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>
 121 <hr/><h2>Member Function Documentation</h2>
 122 <a class="anchor" id="a79d4688e55e26b373e103cb7238df9b6"></a><!-- doxytag: member="UrpoJob::fail" ref="a79d4688e55e26b373e103cb7238df9b6" args="(QString errorString)" -->
 123 <div class="memitem">
 124 <div class="memproto">
 125       <table class="memname">
 126         <tr>
 127           <td class="memname">void UrpoJob::fail </td>
 128           <td>(</td>
 129           <td class="paramtype">QString&nbsp;</td>
 130           <td class="paramname"> <em>errorString</em></td>
 131           <td>&nbsp;)&nbsp;</td>
 132           <td><code> [protected]</code></td>
 133         </tr>
 134       </table>
 135 </div>
 136 <div class="memdoc">
 137
 138 <p>Finish failed job. </p>
 139 <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>
 140
 141 <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>
 142
 143 </div>
 144 </div>
 145 <a class="anchor" id="adca3f19275978d0514229c26871e8a19"></a><!-- doxytag: member="UrpoJob::finish" ref="adca3f19275978d0514229c26871e8a19" args="(JobStatus status)" -->
 146 <div class="memitem">
 147 <div class="memproto">
 148       <table class="memname">
 149         <tr>
 150           <td class="memname">void UrpoJob::finish </td>
 151           <td>(</td>
 152           <td class="paramtype">JobStatus&nbsp;</td>
 153           <td class="paramname"> <em>status</em></td>
 154           <td>&nbsp;)&nbsp;</td>
 155           <td><code> [protected]</code></td>
 156         </tr>
 157       </table>
 158 </div>
 159 <div class="memdoc">
 160
 161 <p>Finish job. </p>
 162 <ul>
 163 <li>status Job status (Successed, Failed, Cancelled) </li>
 164 </ul>
 165
 166 <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>
 167
 168 </div>
 169 </div>
 170 <a class="anchor" id="ab931a6a72a6f49c8919dcd695197288e"></a><!-- doxytag: member="UrpoJob::finished" ref="ab931a6a72a6f49c8919dcd695197288e" args="(bool successed, QString errorStr=QString())" -->
 171 <div class="memitem">
 172 <div class="memproto">
 173       <table class="memname">
 174         <tr>
 175           <td class="memname">void UrpoJob::finished </td>
 176           <td>(</td>
 177           <td class="paramtype">bool&nbsp;</td>
 178           <td class="paramname"> <em>successed</em>, </td>
 179         </tr>
 180         <tr>
 181           <td class="paramkey"></td>
 182           <td></td>
 183           <td class="paramtype">QString&nbsp;</td>
 184           <td class="paramname"> <em>errorStr</em> = <code>QString()</code></td><td>&nbsp;</td>
 185         </tr>
 186         <tr>
 187           <td></td>
 188           <td>)</td>
 189           <td></td><td></td><td><code> [signal]</code></td>
 190         </tr>
 191       </table>
 192 </div>
 193 <div class="memdoc">
 194
 195 <p>Job finished (successed of failed). </p>
 196 <dl><dt><b>Parameters:</b></dt><dd>
 197   <table border="0" cellspacing="2" cellpadding="0">
 198     <tr><td valign="top"></td><td valign="top"><em>successed</em>&nbsp;</td><td>True if job successed, false if failed </td></tr>
 199   </table>
 200   </dd>
 201 </dl>
 202
 203 </div>
 204 </div>
 205 <a class="anchor" id="af07522b7d875bfc36a694f07d580fc8b"></a><!-- doxytag: member="UrpoJob::getStatus" ref="af07522b7d875bfc36a694f07d580fc8b" args="() const " -->
 206 <div class="memitem">
 207 <div class="memproto">
 208       <table class="memname">
 209         <tr>
 210           <td class="memname">JobStatus UrpoJob::getStatus </td>
 211           <td>(</td>
 212           <td class="paramname"></td>
 213           <td>&nbsp;)&nbsp;</td>
 214           <td> const<code> [inline]</code></td>
 215         </tr>
 216       </table>
 217 </div>
 218 <div class="memdoc">
 219
 220 <p>Job status. </p>
 221 <dl class="return"><dt><b>Returns:</b></dt><dd>Job status (Ready, Running, Successed, Failed </dd></dl>
 222
 223 <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>
 224
 225 </div>
 226 </div>
 227 <a class="anchor" id="a6105276a7d9c7431aa5f24d374e33f84"></a><!-- doxytag: member="UrpoJob::sendDebugMessage" ref="a6105276a7d9c7431aa5f24d374e33f84" args="(QString message)" -->
 228 <div class="memitem">
 229 <div class="memproto">
 230       <table class="memname">
 231         <tr>
 232           <td class="memname">void UrpoJob::sendDebugMessage </td>
 233           <td>(</td>
 234           <td class="paramtype">QString&nbsp;</td>
 235           <td class="paramname"> <em>message</em></td>
 236           <td>&nbsp;)&nbsp;</td>
 237           <td><code> [protected]</code></td>
 238         </tr>
 239       </table>
 240 </div>
 241 <div class="memdoc">
 242
 243 <p>Send debug message. </p>
 244 <dl><dt><b>Parameters:</b></dt><dd>
 245   <table border="0" cellspacing="2" cellpadding="0">
 246     <tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>Message to debug monitor</td></tr>
 247   </table>
 248   </dd>
 249 </dl>
 250 <p>If debug monitor has been connected, send message to debug monitor </p>
 251
 252 <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>
 253
 254 </div>
 255 </div>
 256 <hr/>The documentation for this class was generated from the following files:<ul>
 257 <li>/holvi/arto/ohjelmointi/urpo-0.0/urpo/<a class="el" href="urpojob_8h_source.html">urpojob.h</a></li>
 258 <li>/holvi/arto/ohjelmointi/urpo-0.0/urpo/<a class="el" href="urpojob_8cpp_source.html">urpojob.cpp</a></li>
 259 </ul>
 260 </div>
 261 <!--- window showing the filter options -->
 262 <div id="MSearchSelectWindow"
 263      onmouseover="return searchBox.OnSearchSelectShow()"
 264      onmouseout="return searchBox.OnSearchSelectHide()"
 265      onkeydown="return searchBox.OnSearchSelectKey(event)">
 266 <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>
 267
 268 <!-- iframe showing the search results (closed by default) -->
 269 <div id="MSearchResultsWindow">
 270 <iframe src="" frameborder="0"
 271         name="MSearchResults" id="MSearchResults">
 272 </iframe>
 273 </div>
 274
 275 <hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Jun 21 21:38:16 2010 for Urpo by&nbsp;
 276 <a href="http://www.doxygen.org/index.html">
 277 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 278 </body>
 279 </html>