Sophie

Sophie

distrib > Fedora > 18 > i386 > by-pkgid > 0551a44115f6e0f4237e274e52a253d8 > files > 77

stdair-doc-1.00.1-4.fc18.noarch.rpm

<!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 name="robots" content="index,follow"/>
	<title>stdair::BomJSONExport Class Reference</title>
	<link rel="shortcut icon" href="favicon.ico">
	<link href="tabs.css" rel="stylesheet" type="text/css"/>
	<link href="stdair.css" rel="stylesheet" type="text/css"/>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</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>
	<script type="text/javascript">
	  var _gaq = _gaq || [];
	  _gaq.push(['_setAccount', 'UA-24867310-1']);
	  _gaq.push(['_setDomainName', 'none']);
	  _gaq.push(['_setAllowLinker', true]);
	  _gaq.push(['_trackPageview']);
	  (function() {
      var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
      ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
      var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
	  })();
	</script>
	<script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
  </head>
  <body>
	<div id="top"><!-- do not remove this div! -->
	  <div id="titlearea">
		<table width="100%">
		  <tbody>
			<tr style="height: 56px;">
			  <td style="padding-left: 0.5em;">
				<div id="projectname"><a href="http://stdair.sourceforge.net"><img height="45px" alt="StdAir Logo" src="stdair_logo.png"></a>
				  &#160;<span id="projectnumber">1.00.1</span>
				</div>
				<div id="projectbrief">C++ Standard Airline IT Object Library</div>
			  </td>
			  <!-- begin SOURCEFORGE_CUSTOM-->
			  <td>
				<div id="sflogo"><a href="http://stdair.sourceforge.net"><img height="45px" alt="SourceForge Logo" src="sfx_logo.png"></a></div>
			  </td>
			  <!-- end SOURCEFORGE_CUSTOM-->
			</tr>
		  </tbody>
		</table>
	  </div>
<!-- Generated by Doxygen 1.8.3.1 -->
<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</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">
        <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&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </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">
$(document).ready(function(){initNavTree('a00044.html','');});
</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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</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 class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="a00588.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">stdair::BomJSONExport Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Utility class to export StdAir objects in a JSON format.  
 <a href="a00044.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00302_source.html">stdair/bom/BomJSONExport.hpp</a>&gt;</code></p>
<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:a310bfc5f38c716bd9f60686fe4cfd756"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a310bfc5f38c716bd9f60686fe4cfd756">jsonExportFlightDateList</a> (std::ostream &amp;, const <a class="el" href="a00049.html">BomRoot</a> &amp;, const <a class="el" href="a00535.html#ac0ab9f765621de3140cc27d6472f5581">AirlineCode_T</a> &amp;iAirlineCode=&quot;all&quot;, const <a class="el" href="a00535.html#abb24a0796f29fe921b6dbe3ba0fa638e">FlightNumber_T</a> &amp;iFlightNumber=0)</td></tr>
<tr class="separator:a310bfc5f38c716bd9f60686fe4cfd756"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c9b0625fd48f4a0c5c85a46f6d623fa"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a0c9b0625fd48f4a0c5c85a46f6d623fa">jsonExportFlightDateObjects</a> (std::ostream &amp;, const <a class="el" href="a00103.html">FlightDate</a> &amp;)</td></tr>
<tr class="separator:a0c9b0625fd48f4a0c5c85a46f6d623fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7dc8c7bd588accd9c4559807af6d5343"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a7dc8c7bd588accd9c4559807af6d5343">jsonExportBookingRequestObject</a> (std::ostream &amp;, const <a class="el" href="a00086.html">EventStruct</a> &amp;)</td></tr>
<tr class="separator:a7dc8c7bd588accd9c4559807af6d5343"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c68becb551b0c1814bab4cdc681890e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a3c68becb551b0c1814bab4cdc681890e">jsonExportBreakPointObject</a> (std::ostream &amp;, const <a class="el" href="a00086.html">EventStruct</a> &amp;)</td></tr>
<tr class="separator:a3c68becb551b0c1814bab4cdc681890e"><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>Utility class to export StdAir objects in a JSON format. </p>

<p>Definition at line <a class="el" href="a00302_source.html#l00042">42</a> of file <a class="el" href="a00302_source.html">BomJSONExport.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a310bfc5f38c716bd9f60686fe4cfd756"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void stdair::BomJSONExport::jsonExportFlightDateList </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>oStream</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00049.html">BomRoot</a> &amp;&#160;</td>
          <td class="paramname"><em>iBomRoot</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00535.html#ac0ab9f765621de3140cc27d6472f5581">AirlineCode_T</a> &amp;&#160;</td>
          <td class="paramname"><em>iAirlineCode</em> = <code>&quot;all&quot;</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00535.html#abb24a0796f29fe921b6dbe3ba0fa638e">FlightNumber_T</a> &amp;&#160;</td>
          <td class="paramname"><em>iFlightNumber</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</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>Export (dump in the underlying output log stream and in JSON format) a list of flight date objects.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">std::ostream&amp;</td><td>Output stream in which the flight date objects should be logged/dumped. </td></tr>
    <tr><td class="paramname">const</td><td><a class="el" href="a00049.html" title="Class representing the actual attributes for the Bom root.">BomRoot</a>&amp; Root of the BOM tree containing flight-dates to be exported. </td></tr>
    <tr><td class="paramname">const</td><td>AirlineCode&amp; Airline for which the flight-dates should be displayed. If set to "all" (default), all the inventories will be displayed. </td></tr>
    <tr><td class="paramname">const</td><td>FlightNumber_T&amp; Flight number for which all the departure dates should be displayed. If set to 0 (the default), all the flight numbers will be displayed. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="a00301_source.html#l00035">35</a> of file <a class="el" href="a00301_source.html">BomJSONExport.cpp</a>.</p>

<p>References <a class="el" href="a00374_source.html#l00056">stdair::Inventory::getAirlineCode()</a>, <a class="el" href="a00362_source.html#l00067">stdair::FlightDate::getDepartureDate()</a>, and <a class="el" href="a00362_source.html#l00062">stdair::FlightDate::getFlightNumber()</a>.</p>

<p>Referenced by <a class="el" href="a00502_source.html#l00242">stdair::STDAIR_Service::jsonExportFlightDateList()</a>.</p>

</div>
</div>
<a class="anchor" id="a0c9b0625fd48f4a0c5c85a46f6d623fa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void stdair::BomJSONExport::jsonExportFlightDateObjects </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>oStream</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00103.html">FlightDate</a> &amp;&#160;</td>
          <td class="paramname"><em>iFlightDate</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</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>Recursively export (dump in the underlying output log stream and in JSON format) the objects of the BOM tree using the given <a class="el" href="a00103.html" title="Class representing the actual attributes for an airline flight-date.">FlightDate</a> as root.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">std::ostream&amp;</td><td>Output stream in which the BOM tree should be logged/dumped. </td></tr>
    <tr><td class="paramname">const</td><td><a class="el" href="a00103.html" title="Class representing the actual attributes for an airline flight-date.">FlightDate</a>&amp; Root of the BOM tree to be exported. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="a00301_source.html#l00163">163</a> of file <a class="el" href="a00301_source.html">BomJSONExport.cpp</a>.</p>

<p>References <a class="el" href="a00361_source.html#l00037">stdair::FlightDate::getAirlineCode()</a>, <a class="el" href="a00362_source.html#l00067">stdair::FlightDate::getDepartureDate()</a>, and <a class="el" href="a00362_source.html#l00062">stdair::FlightDate::getFlightNumber()</a>.</p>

<p>Referenced by <a class="el" href="a00502_source.html#l00262">stdair::STDAIR_Service::jsonExportFlightDateObjects()</a>.</p>

</div>
</div>
<a class="anchor" id="a7dc8c7bd588accd9c4559807af6d5343"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void stdair::BomJSONExport::jsonExportBookingRequestObject </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>oStream</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00086.html">EventStruct</a> &amp;&#160;</td>
          <td class="paramname"><em>iEventStruct</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</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>Export (dump in the underlying output log stream and in JSON format) the booking request object contained in the event structure.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">std::ostream&amp;</td><td>Output stream in which the events should be logged/dumped. </td></tr>
    <tr><td class="paramname">const</td><td><a class="el" href="a00086.html">EventStruct</a>&amp; Booking request to be stored in JSON-ified format. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="a00301_source.html#l00660">660</a> of file <a class="el" href="a00301_source.html">BomJSONExport.cpp</a>.</p>

<p>References <a class="el" href="a00240_source.html#l00018">stdair::EventType::BKG_REQ</a>, <a class="el" href="a00320_source.html#l00070">stdair::BookingRequestStruct::getBookingChannel()</a>, <a class="el" href="a00344_source.html#l00059">stdair::EventStruct::getBookingRequest()</a>, <a class="el" href="a00320_source.html#l00035">stdair::BookingRequestStruct::getDestination()</a>, <a class="el" href="a00344_source.html#l00041">stdair::EventStruct::getEventType()</a>, <a class="el" href="a00239_source.html#l00083">stdair::EventType::getLabel()</a>, <a class="el" href="a00320_source.html#l00030">stdair::BookingRequestStruct::getOrigin()</a>, <a class="el" href="a00320_source.html#l00065">stdair::BookingRequestStruct::getPartySize()</a>, <a class="el" href="a00320_source.html#l00040">stdair::BookingRequestStruct::getPOS()</a>, <a class="el" href="a00320_source.html#l00045">stdair::BookingRequestStruct::getPreferedDepartureDate()</a>, <a class="el" href="a00320_source.html#l00060">stdair::BookingRequestStruct::getPreferredCabin()</a>, <a class="el" href="a00320_source.html#l00050">stdair::BookingRequestStruct::getPreferredDepartureTime()</a>, <a class="el" href="a00320_source.html#l00055">stdair::BookingRequestStruct::getRequestDateTime()</a>, <a class="el" href="a00320_source.html#l00080">stdair::BookingRequestStruct::getStayDuration()</a>, and <a class="el" href="a00320_source.html#l00090">stdair::BookingRequestStruct::getWTP()</a>.</p>

<p>Referenced by <a class="el" href="a00502_source.html#l00312">stdair::STDAIR_Service::jsonExportEventObject()</a>.</p>

</div>
</div>
<a class="anchor" id="a3c68becb551b0c1814bab4cdc681890e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void stdair::BomJSONExport::jsonExportBreakPointObject </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>oStream</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00086.html">EventStruct</a> &amp;&#160;</td>
          <td class="paramname"><em>iEventStruct</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</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>Export (dump in the underlying output log stream and in JSON format) the break point object contained in the event structure.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">std::ostream&amp;</td><td>Output stream in which the events should be logged/dumped. </td></tr>
    <tr><td class="paramname">const</td><td><a class="el" href="a00086.html">EventStruct</a>&amp; Break point to be stored in JSON-ified format. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="a00301_source.html#l00749">749</a> of file <a class="el" href="a00301_source.html">BomJSONExport.cpp</a>.</p>

<p>References <a class="el" href="a00240_source.html#l00025">stdair::EventType::BRK_PT</a>, <a class="el" href="a00344_source.html#l00118">stdair::EventStruct::getBreakPoint()</a>, <a class="el" href="a00323_source.html#l00022">stdair::BreakPointStruct::getBreakPointTime()</a>, <a class="el" href="a00344_source.html#l00041">stdair::EventStruct::getEventType()</a>, and <a class="el" href="a00239_source.html#l00083">stdair::EventType::getLabel()</a>.</p>

<p>Referenced by <a class="el" href="a00502_source.html#l00312">stdair::STDAIR_Service::jsonExportEventObject()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>stdair/bom/<a class="el" href="a00302_source.html">BomJSONExport.hpp</a></li>
<li>stdair/bom/<a class="el" href="a00301_source.html">BomJSONExport.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
		
		<li class="footer">Generated on Wed May 22 2013 10:52:01 for StdAir by
		  <a href="http://www.doxygen.org/index.html">
			<img class="footer" src="doxygen.png" alt="doxygen"/></a> 
		  1.8.3.1
		</li>
		<li class="footer">
		  <a href="http://sourceforge.net/projects/stdair"><img class="footer" src="http://sflogo.sourceforge.net/sflogo.php?group_id=267760&type=12&format=.png" alt="SourceForge Logo"></a>
		</li>
	  </ul>
	</div>
  </body>
</html>