sweproj.com
/
openPilotLog
mirror of https://github.com/fiffty-50/openPilotLog


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>openPilotLog: OPL::Row 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom_dark_theme.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 id="projectlogo"><img alt="Logo" src="icon_main.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">openPilotLog
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_o_p_l_1_1_row.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_o_p_l_1_1_row-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">OPL::Row Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The <a class="el" href="class_o_p_l_1_1_row.html" title="The Row class provides an interface for retreiving and submitting entries from the database.">Row</a> class provides an interface for retreiving and submitting entries from the database.  
 <a href="class_o_p_l_1_1_row.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="row_8h_source.html">row.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for OPL::Row:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_o_p_l_1_1_row.png" usemap="#OPL::Row_map" alt=""/>
  <map id="OPL::Row_map" name="OPL::Row_map">
<area href="class_o_p_l_1_1_aircraft_entry.html" title="A Row representing an Aircraft entry. See Row class for details." alt="OPL::AircraftEntry" shape="rect" coords="0,56,127,80"/>
<area href="class_o_p_l_1_1_airport_entry.html" title="A Row representing an Airport entry. See Row class for details." alt="OPL::AirportEntry" shape="rect" coords="137,56,264,80"/>
<area href="class_o_p_l_1_1_currency_entry.html" title="A Row representing a Currency entry. See Row class for details." alt="OPL::CurrencyEntry" shape="rect" coords="274,56,401,80"/>
<area href="class_o_p_l_1_1_flight_entry.html" title="A Row representing a Flight entry. See Row class for details." alt="OPL::FlightEntry" shape="rect" coords="411,56,538,80"/>
<area href="class_o_p_l_1_1_pilot_entry.html" title="A Row representing a Pilot entry. See Row class for details." alt="OPL::PilotEntry" shape="rect" coords="548,56,675,80"/>
<area href="class_o_p_l_1_1_simulator_entry.html" title="A Row representing a Simulator entry. See Row class for details." alt="OPL::SimulatorEntry" shape="rect" coords="685,56,812,80"/>
<area href="class_o_p_l_1_1_tail_entry.html" title="A Row representing a Tail (Registration) entry. See Row class for details." alt="OPL::TailEntry" shape="rect" coords="822,56,949,80"/>
  </map>
</div></div>
<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:a003f47f80870a64052f9f800aa533c6e"><td class="memItemLeft" align="right" valign="top"><a id="a003f47f80870a64052f9f800aa533c6e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Row</b> (<a class="el" href="namespace_o_p_l.html#ada86eb02cea54d91c8c11c9112ec1cf7">OPL::DbTable</a> table_name, int row_id, const RowData_T &amp;row_data)</td></tr>
<tr class="separator:a003f47f80870a64052f9f800aa533c6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7de776b1e5ec66ae704735027f7f9838"><td class="memItemLeft" align="right" valign="top"><a id="a7de776b1e5ec66ae704735027f7f9838"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Row</b> (<a class="el" href="namespace_o_p_l.html#ada86eb02cea54d91c8c11c9112ec1cf7">OPL::DbTable</a> table_name, int row_id)</td></tr>
<tr class="separator:a7de776b1e5ec66ae704735027f7f9838"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c590facaf2f2c45086b756c67ab2415"><td class="memItemLeft" align="right" valign="top"><a id="a9c590facaf2f2c45086b756c67ab2415"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Row</b> (<a class="el" href="namespace_o_p_l.html#ada86eb02cea54d91c8c11c9112ec1cf7">OPL::DbTable</a> table_name)</td></tr>
<tr class="separator:a9c590facaf2f2c45086b756c67ab2415"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a043692e09011cacbcaeb0e88c1802fd1"><td class="memItemLeft" align="right" valign="top"><a id="a043692e09011cacbcaeb0e88c1802fd1"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Row</b> (const <a class="el" href="class_o_p_l_1_1_row.html">Row</a> &amp;)=default</td></tr>
<tr class="separator:a043692e09011cacbcaeb0e88c1802fd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e97ce33358fb9a011441341646bd46b"><td class="memItemLeft" align="right" valign="top"><a id="a2e97ce33358fb9a011441341646bd46b"></a>
<a class="el" href="class_o_p_l_1_1_row.html">Row</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="class_o_p_l_1_1_row.html">Row</a> &amp;)=default</td></tr>
<tr class="separator:a2e97ce33358fb9a011441341646bd46b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a799fbf35c18c0d8dc824d6d1a11902c3"><td class="memItemLeft" align="right" valign="top"><a id="a799fbf35c18c0d8dc824d6d1a11902c3"></a>
RowData_T&#160;</td><td class="memItemRight" valign="bottom"><b>getData</b> () const</td></tr>
<tr class="separator:a799fbf35c18c0d8dc824d6d1a11902c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3ae77fc913896d00e6b947254b06ce9"><td class="memItemLeft" align="right" valign="top"><a id="ad3ae77fc913896d00e6b947254b06ce9"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setData</b> (const RowData_T &amp;value)</td></tr>
<tr class="separator:ad3ae77fc913896d00e6b947254b06ce9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa70580fe157b6e0a408fc975e833e85e"><td class="memItemLeft" align="right" valign="top"><a id="aa70580fe157b6e0a408fc975e833e85e"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>getRowId</b> () const</td></tr>
<tr class="separator:aa70580fe157b6e0a408fc975e833e85e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa029e0507bbf31d2b190eaf218fb6a2c"><td class="memItemLeft" align="right" valign="top"><a id="aa029e0507bbf31d2b190eaf218fb6a2c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setRowId</b> (int value)</td></tr>
<tr class="separator:aa029e0507bbf31d2b190eaf218fb6a2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72b25aafde960b2de1c28650322652e4"><td class="memItemLeft" align="right" valign="top"><a id="a72b25aafde960b2de1c28650322652e4"></a>
<a class="el" href="namespace_o_p_l.html#ada86eb02cea54d91c8c11c9112ec1cf7">OPL::DbTable</a>&#160;</td><td class="memItemRight" valign="bottom"><b>getTable</b> () const</td></tr>
<tr class="separator:a72b25aafde960b2de1c28650322652e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca589fb076426b9b6c13c2f0207b5213"><td class="memItemLeft" align="right" valign="top"><a id="aca589fb076426b9b6c13c2f0207b5213"></a>
const QString&#160;</td><td class="memItemRight" valign="bottom"><b>getTableName</b> () const</td></tr>
<tr class="separator:aca589fb076426b9b6c13c2f0207b5213"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a983d75a3ebc620d58453b28178cc40fa"><td class="memItemLeft" align="right" valign="top"><a id="a983d75a3ebc620d58453b28178cc40fa"></a>
const QString&#160;</td><td class="memItemRight" valign="bottom"><b>getPosition</b> () const</td></tr>
<tr class="separator:a983d75a3ebc620d58453b28178cc40fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2edff39e0fc3f65181e8c5c9227c7a1"><td class="memItemLeft" align="right" valign="top"><a id="aa2edff39e0fc3f65181e8c5c9227c7a1"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>isValid</b> () const</td></tr>
<tr class="separator:aa2edff39e0fc3f65181e8c5c9227c7a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f39ccb98dd4ad8a9ee3d72c65144e80"><td class="memItemLeft" align="right" valign="top"><a id="a2f39ccb98dd4ad8a9ee3d72c65144e80"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_p_l_1_1_row.html#a2f39ccb98dd4ad8a9ee3d72c65144e80">operator QString</a> () const</td></tr>
<tr class="memdesc:a2f39ccb98dd4ad8a9ee3d72c65144e80"><td class="mdescLeft">&#160;</td><td class="mdescRight">operator QString can be used for printing debug information to stdout <br /></td></tr>
<tr class="separator:a2f39ccb98dd4ad8a9ee3d72c65144e80"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:af03987eb9f44d2feb3a9f155ed1f2cce"><td class="memItemLeft" align="right" valign="top"><a id="af03987eb9f44d2feb3a9f155ed1f2cce"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>hasData</b></td></tr>
<tr class="separator:af03987eb9f44d2feb3a9f155ed1f2cce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4adb1dca9ed05fb35e02c6bd464411aa"><td class="memItemLeft" align="right" valign="top"><a id="a4adb1dca9ed05fb35e02c6bd464411aa"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>valid</b> = true</td></tr>
<tr class="separator:a4adb1dca9ed05fb35e02c6bd464411aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="class_o_p_l_1_1_row.html" title="The Row class provides an interface for retreiving and submitting entries from the database.">Row</a> class provides an interface for retreiving and submitting entries from the database. </p>
<p>The <a class="el" href="class_o_p_l_1_1_row.html" title="The Row class provides an interface for retreiving and submitting entries from the database.">Row</a> class is a base class and when instantiated, the appropriate subclass should be used.</p>
<p>The database holds all the data related to the logbook in different tables. Each of these tables is composed of rows. Each row has different columns and each column contains the data. As such, an entry can be thought of as a row in the database. The row class encapsulates the data contained in each row.</p>
<p>A row is uniquely identified by its position in the database, consisting of the table name (QString) and the row id (int). A new entry, which is not yet in the database has the row id 0. If a new row object is created, the hasData bool is set to false. Before submitting the entry to the database, setData() has to be called to fill the row with data and toggle the verification bit.</p>
<p>The <a class="el" href="class_o_p_l_1_1_row.html" title="The Row class provides an interface for retreiving and submitting entries from the database.">Row</a> Object holds all the necessary information the <a class="el" href="class_o_p_l_1_1_database.html" title="The DB class encapsulates the SQL database by providing fast access to hot database data.">Database</a> class needs to commit (create or update) it. The Identifying information can be accessed with getRowId and getTable() / getTableName().</p>
<p>For convenience and readabilty, subclasses exist that have the table property pre-set. These rows are then referred to as entries. See <a class="el" href="class_o_p_l_1_1_aircraft_entry.html" title="A Row representing an Aircraft entry. See Row class for details.">AircraftEntry</a>, <a class="el" href="class_o_p_l_1_1_flight_entry.html" title="A Row representing a Flight entry. See Row class for details.">FlightEntry</a> etc. </p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li>src/database/<a class="el" href="row_8h_source.html">row.h</a></li>
<li>src/database/row.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespace_o_p_l.html">OPL</a></li><li class="navelem"><a class="el" href="class_o_p_l_1_1_row.html">Row</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
  </ul>
</div>
</body>
</html>