<!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>Tutorials</title>
<link rel="shortcut icon" href="favicon.ico">
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="trademgen.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-25000976-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://trademgen.sourceforge.net"><img height="45px" alt="TraDemGen Logo" src="trademgen_logo.png"></a>
 <span id="projectnumber">1.00.0</span>
</div>
<div id="projectbrief">C++ Simulated Travel Demand Generation Library</div>
</td>
<!-- begin SOURCEFORGE_CUSTOM-->
<td>
<div id="sflogo"><a href="http://trademgen.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 Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><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><!-- 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('a00014.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"> </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>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><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 class="header">
<div class="headertitle">
<div class="title">Tutorials </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="tut_toc"></a>
Table of Contents</h1>
<ul>
<li><a class="el" href="a00014.html#tut_introduction">Introduction</a><ul>
<li><a class="el" href="a00014.html#tut_intro_configuration">Preparing the StdAir Project for Development</a></li>
</ul>
</li>
<li><a class="el" href="a00014.html#tut_build_bom_tree">Build a Predefined BOM Tree</a><ul>
<li><a class="el" href="a00014.html#tut_build_bom_root">Instanciate the BOM Root Object</a></li>
<li><a class="el" href="a00014.html#tut_build_inventory">Instanciate the (Airline) Inventory Object</a></li>
<li><a class="el" href="a00014.html#tut_build_link">Link the Inventory Object with the BOM Root</a></li>
<li><a class="el" href="a00014.html#tut_build_inventory_another">Build Another Airline Inventory</a></li>
<li><a class="el" href="a00014.html#tut_dump_bom_tree">Dump The BOM Tree Content</a></li>
<li><a class="el" href="a00014.html#tut_result_output">Result of the Tutorial Program</a></li>
</ul>
</li>
<li><a class="el" href="a00014.html#tut_extend_bom_tree">Extend the Pre-Defined BOM Tree</a><ul>
<li><a class="el" href="a00014.html#tut_extend_inventory">Extend an Airline Inventory Object</a></li>
<li><a class="el" href="a00014.html#tut_extend_build">Build the Specific BOM Objects</a></li>
<li><a class="el" href="a00014.html#tut_extend_result_output">Result of the Tutorial Program</a></li>
</ul>
</li>
</ul>
<h1><a class="anchor" id="tut_introduction"></a>
Introduction</h1>
<p>This page contains some tutorial examples that will help you getting started using StdAir. Most examples show how to construct some simple business objects, i.e., instances of the so-named Business Object Model (BOM).</p>
<h2><a class="anchor" id="tut_intro_configuration"></a>
Preparing the StdAir Project for Development</h2>
<p>The source code for these examples can be found in the <code>batches</code> and <code>test/stdair</code> directories. They are compiled along with the rest of the <code>StdAir</code> project. See the User Guide (<a class="el" href="a00011.html">Users Guide</a>) for more details on how to build the <code>StdAir</code> project.</p>
<h1><a class="anchor" id="tut_build_bom_tree"></a>
Build a Predefined BOM Tree</h1>
<p>A few steps:</p>
<ul>
<li><a class="el" href="a00014.html#tut_build_bom_root">Instanciate the BOM Root Object</a></li>
<li><a class="el" href="a00014.html#tut_build_inventory">Instanciate the (Airline) Inventory Object</a></li>
<li><a class="el" href="a00014.html#tut_build_link">Link the Inventory Object with the BOM Root</a></li>
</ul>
<h2><a class="anchor" id="tut_build_bom_root"></a>
Instanciate the BOM Root Object</h2>
<p>First, a BOM root object (i.e., a root for all the classes in the project) is instantiated by the <code>stdair::STDAIR_ServiceContext</code> context object, when the <code>stdair::STDAIR_Service</code> is itself instantiated. The corresponding <code>StdAir</code> type (class) is <code>stdair::BomRoot</code>.</p>
<p>In the following sample, that object is named <code>ioBomRoot</code>, and is given as input/output parameter of the <code>stdair::CmdBomManager::buildSampleBom()</code> method:</p>
<p><div class="fragment"></div><!-- fragment --></p>
<h2><a class="anchor" id="tut_build_inventory"></a>
Instanciate the (Airline) Inventory Object</h2>
<p>An airline inventory object can then be instantiated. Let us give it the "BA" airline code (corresponding to <a href="http://www.ba.com">British Airways</a>) as the object key. That is, an object (let us name it <code>lBAKey</code>) of type (class) <code>stdair::InventoryKey</code> has first to be instantiated.</p>
<p><div class="fragment"></div><!-- fragment --></p>
<p>Thanks to that key, an airline inventory object, i.e. of type (class) <code>stdair::Inventory</code>, can be instantiated. Let us name that airline inventory object <code>lBAInv</code>.</p>
<p><div class="fragment"></div><!-- fragment --></p>
<h2><a class="anchor" id="tut_build_link"></a>
Link the Inventory Object with the BOM Root</h2>
<p>Then, both objects have to be linked: the airline inventory object (<code>stdair::Inventory</code>) has to be linked with the root of the BOM tree (<code>stdair::BomRoot</code>). That operation is as simple as using the <code>stdair::FacBomManager::addToListAndMap()</code> method:</p>
<p><div class="fragment"></div><!-- fragment --></p>
<h2><a class="anchor" id="tut_build_inventory_another"></a>
Build Another Airline Inventory</h2>
<p>Another airline inventory object, corresponding to the Air France (<a href="http://www.airfrance.com">Air France</a>) company, is instantiated the same way:</p>
<p><div class="fragment"></div><!-- fragment --></p>
<p>See the corresponding full program (cmd_bom_manager_cpp) for more details.</p>
<h2><a class="anchor" id="tut_dump_bom_tree"></a>
Dump The BOM Tree Content</h2>
<p>From the <code>BomRoot</code> (of type <code>stdair::BomRoot</code>) object instance, the list of airline inventories (of type <code>stdair::Inventory</code>) can then be retrieved...</p>
<p><div class="fragment"></div><!-- fragment --></p>
<p>... and browsed: <div class="fragment"></div><!-- fragment --></p>
<p>See the corresponding full program (bom_display_cpp) for more details.</p>
<h2><a class="anchor" id="tut_result_output"></a>
Result of the Tutorial Program</h2>
<p>When the <code>stdair.cpp</code> program is run (with the <code>-b</code> option), the output should look like:</p>
<div class="fragment"></div><!-- fragment --><p>See the corresponding full program (batch_stdair_cpp) for more details.</p>
<h1><a class="anchor" id="tut_extend_bom_tree"></a>
Extend the Pre-Defined BOM Tree</h1>
<p>Now that we master how to instantiate the pre-defined StdAir classes, let us see how to extend that BOM.</p>
<h2><a class="anchor" id="tut_extend_inventory"></a>
Extend an Airline Inventory Object</h2>
<p>For instance, let us assume that some (IT) provider (e.g., you) would like to have a specific implementation of the <code>Inventory</code> object. The corresponding class has just to extend the <code>stdair::Inventory</code> class:</p>
<p><div class="fragment"></div><!-- fragment --></p>
<p>The STL containers have to be defined accordingly too:</p>
<p><div class="fragment"></div><!-- fragment --></p>
<p>See the full class definition (test_archi_inv_hpp) and implementation (test_archi_inv_cpp) for more details.</p>
<h2><a class="anchor" id="tut_extend_build"></a>
Build the Specific BOM Objects</h2>
<p>The BOM root object (<code>stdair::BomRoot</code>) is instantiated the classical way:</p>
<p><div class="fragment"></div><!-- fragment --></p>
<p>Then, the specific implementation of the airline inventory object (<code>myprovider::Inventory</code>) can be instantiated the same way as a standard Inventory (<code>stdair::Inventory</code>) would be:</p>
<p><div class="fragment"></div><!-- fragment --></p>
<p>Then, the specific implementation of the airline inventory object (<code>myprovider::Inventory</code>) is linked to the root of the BOM tree (<code>stdair::BomRoot</code>) the same way as the standard Inventory (<code>stdair::Inventory</code>) would be:</p>
<p><div class="fragment"></div><!-- fragment --></p>
<p>Another specific airline inventory object is instantiated the same way:</p>
<p><div class="fragment"></div><!-- fragment --></p>
<p>From the <code>BomRoot</code> (of type <code>stdair::BomRoot</code>) object instance, the list of specific airline inventories (of type <code>stdair::Inventory</code>) can then be retrieved...</p>
<p><div class="fragment"></div><!-- fragment --></p>
<p>... and browsed: <div class="fragment"></div><!-- fragment --></p>
<h2><a class="anchor" id="tut_extend_result_output"></a>
Result of the Tutorial Program</h2>
<p>When this program is run, the output should look like:</p>
<div class="fragment"></div><!-- fragment --><p>See the corresponding full program (StandardAirlineITTestSuite_cpp) for more details. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<li class="footer">Generated on Wed May 22 2013 22:01:49 for TraDemGen 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/trademgen"><img class="footer" src="http://sflogo.sourceforge.net/sflogo.php?group_id=264773&type=12&format=.png" alt="SourceForge Logo"></a>
</li>
</ul>
</div>
</body>
</html>
