Sophie

Sophie

distrib > Fedora > 18 > i386 > by-pkgid > 7bf6d961059fc8db3cc3e1742009f47c > files > 189

trademgen-doc-1.00.0-2.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>TRADEMGEN::Trademgener Struct Reference</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>
				  &#160;<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&#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('a00077.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>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><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-methods">Public Member Functions</a> &#124;
<a href="a00174.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">TRADEMGEN::Trademgener Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Wrapper structure around the C++ API, so as to expose a Python API.  
 <a href="a00077.html#details">More...</a></p>
<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:aed8ccc744262fe828441590202fb2207"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00077.html#aed8ccc744262fe828441590202fb2207">trademgen</a> (const <a class="el" href="a00113.html#a380b74883e1b57be9e8afae6833d2f99">NbOfRuns_T</a> &amp;iNbOfRuns, const std::string &amp;iDemandGenerationMethodString)</td></tr>
<tr class="separator:aed8ccc744262fe828441590202fb2207"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1de6a9d9b0a8f321ed25006074fa74a9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00077.html#a1de6a9d9b0a8f321ed25006074fa74a9">Trademgener</a> ()</td></tr>
<tr class="separator:a1de6a9d9b0a8f321ed25006074fa74a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37a1bd62b6d6877d3ce9c0183e040819"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00077.html#a37a1bd62b6d6877d3ce9c0183e040819">Trademgener</a> (const <a class="el" href="a00077.html">Trademgener</a> &amp;iTrademgener)</td></tr>
<tr class="separator:a37a1bd62b6d6877d3ce9c0183e040819"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e26129bcb28d98f806e9a5e282d7ffd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00077.html#a1e26129bcb28d98f806e9a5e282d7ffd">~Trademgener</a> ()</td></tr>
<tr class="separator:a1e26129bcb28d98f806e9a5e282d7ffd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac194f6f382edec9a716d39fc27a4bee8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00077.html#ac194f6f382edec9a716d39fc27a4bee8">init</a> (const std::string &amp;iLogFilepath, const stdair::RandomSeed_T &amp;iRandomSeed, const bool isBuiltin, const stdair::Filename_T &amp;iDemandInputFilename)</td></tr>
<tr class="separator:ac194f6f382edec9a716d39fc27a4bee8"><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>Wrapper structure around the C++ API, so as to expose a Python API. </p>

<p>Definition at line <a class="el" href="a00136_source.html#l00070">70</a> of file <a class="el" href="a00136_source.html">pytrademgen.cpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a1de6a9d9b0a8f321ed25006074fa74a9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">TRADEMGEN::Trademgener::Trademgener </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>

<p>Definition at line <a class="el" href="a00136_source.html#l00266">266</a> of file <a class="el" href="a00136_source.html">pytrademgen.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a37a1bd62b6d6877d3ce9c0183e040819"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">TRADEMGEN::Trademgener::Trademgener </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00077.html">Trademgener</a> &amp;&#160;</td>
          <td class="paramname"><em>iTrademgener</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Default copy constructor. </p>

<p>Definition at line <a class="el" href="a00136_source.html#l00270">270</a> of file <a class="el" href="a00136_source.html">pytrademgen.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a1e26129bcb28d98f806e9a5e282d7ffd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">TRADEMGEN::Trademgener::~Trademgener </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>

<p>Definition at line <a class="el" href="a00136_source.html#l00276">276</a> of file <a class="el" href="a00136_source.html">pytrademgen.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aed8ccc744262fe828441590202fb2207"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::string TRADEMGEN::Trademgener::trademgen </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00113.html#a380b74883e1b57be9e8afae6833d2f99">NbOfRuns_T</a> &amp;&#160;</td>
          <td class="paramname"><em>iNbOfRuns</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>iDemandGenerationMethodString</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">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Wrapper around the travel demand generation use case. </p>

<p>Definition at line <a class="el" href="a00136_source.html#l00076">76</a> of file <a class="el" href="a00136_source.html">pytrademgen.cpp</a>.</p>

<p>References <a class="el" href="a00137_source.html#l00468">TRADEMGEN::TRADEMGEN_Service::csvDisplay()</a>, <a class="el" href="a00137_source.html#l00663">TRADEMGEN::TRADEMGEN_Service::generateFirstRequests()</a>, <a class="el" href="a00137_source.html#l00689">TRADEMGEN::TRADEMGEN_Service::generateNextRequest()</a>, <a class="el" href="a00137_source.html#l00596">TRADEMGEN::TRADEMGEN_Service::getExpectedTotalNumberOfRequestsToBeGenerated()</a>, <a class="el" href="a00137_source.html#l00729">TRADEMGEN::TRADEMGEN_Service::isQueueDone()</a>, <a class="el" href="a00137_source.html#l00713">TRADEMGEN::TRADEMGEN_Service::popEvent()</a>, <a class="el" href="a00137_source.html#l00811">TRADEMGEN::TRADEMGEN_Service::reset()</a>, and <a class="el" href="a00136_source.html#l00047">TRADEMGEN::stat_display()</a>.</p>

<p>Referenced by <a class="el" href="a00136_source.html#l00355">BOOST_PYTHON_MODULE()</a>.</p>

</div>
</div>
<a class="anchor" id="ac194f6f382edec9a716d39fc27a4bee8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool TRADEMGEN::Trademgener::init </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>iLogFilepath</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const stdair::RandomSeed_T &amp;&#160;</td>
          <td class="paramname"><em>iRandomSeed</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const bool&#160;</td>
          <td class="paramname"><em>isBuiltin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const stdair::Filename_T &amp;&#160;</td>
          <td class="paramname"><em>iDemandInputFilename</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">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Wrapper around the search use case. </p>

<p>Definition at line <a class="el" href="a00136_source.html#l00284">284</a> of file <a class="el" href="a00136_source.html">pytrademgen.cpp</a>.</p>

<p>References <a class="el" href="a00137_source.html#l00310">TRADEMGEN::TRADEMGEN_Service::buildSampleBom()</a>, and <a class="el" href="a00137_source.html#l00241">TRADEMGEN::TRADEMGEN_Service::parseAndLoad()</a>.</p>

<p>Referenced by <a class="el" href="a00136_source.html#l00355">BOOST_PYTHON_MODULE()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>trademgen/python/<a class="el" href="a00136_source.html">pytrademgen.cpp</a></li>
</ul>
</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>