<!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::BomRootKey Struct 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>  <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 Page</span></a></li> <li><a href="pages.html"><span>Related 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 List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class 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('a00050.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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><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="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#friends">Friends</a> | <a href="a00594.html">List of all members</a> </div> <div class="headertitle"> <div class="title">stdair::BomRootKey Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p>Key of the BOM structure root. <a href="a00050.html#details">More...</a></p> <p><code>#include <<a class="el" href="a00313_source.html">stdair/bom/BomRootKey.hpp</a>></code></p> <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for stdair::BomRootKey:</div> <div id="dynsection-0-summary" class="dynsummary" style="display:block;"> </div> <div id="dynsection-0-content" class="dyncontent" style="display:none;"> <div class="center"> <img src="a00050.png" usemap="#stdair::BomRootKey_map" alt=""/> <map id="stdair::BomRootKey_map" name="stdair::BomRootKey_map"> <area href="a00116.html" title="Base class for the keys of Business Object Model (BOM) layer." alt="stdair::KeyAbstract" shape="rect" coords="0,0,120,24"/> </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:af8e6348de64e8a7a4bf9f141f7c2e864"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#af8e6348de64e8a7a4bf9f141f7c2e864">BomRootKey</a> ()</td></tr> <tr class="separator:af8e6348de64e8a7a4bf9f141f7c2e864"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2ab0c1d6b77bf30d06ab7cbe999a94db"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#a2ab0c1d6b77bf30d06ab7cbe999a94db">BomRootKey</a> (const std::string &iIdentification)</td></tr> <tr class="separator:a2ab0c1d6b77bf30d06ab7cbe999a94db"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab403b2759b7c49ce88f36f3c231c1750"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#ab403b2759b7c49ce88f36f3c231c1750">BomRootKey</a> (const <a class="el" href="a00050.html">BomRootKey</a> &)</td></tr> <tr class="separator:ab403b2759b7c49ce88f36f3c231c1750"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac0c5c1a29ae809b8a5bfd3ec5ad7b137"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#ac0c5c1a29ae809b8a5bfd3ec5ad7b137">~BomRootKey</a> ()</td></tr> <tr class="separator:ac0c5c1a29ae809b8a5bfd3ec5ad7b137"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a22389df489a258682ba3297bbf5c2839"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#a22389df489a258682ba3297bbf5c2839">getID</a> () const </td></tr> <tr class="separator:a22389df489a258682ba3297bbf5c2839"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae7537968b496d6bc24b130bbcfcc8cad"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#ae7537968b496d6bc24b130bbcfcc8cad">toStream</a> (std::ostream &ioOut) const </td></tr> <tr class="separator:ae7537968b496d6bc24b130bbcfcc8cad"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a57c854648f4591d424da5a4c7073679e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#a57c854648f4591d424da5a4c7073679e">fromStream</a> (std::istream &ioIn)</td></tr> <tr class="separator:a57c854648f4591d424da5a4c7073679e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af9293fcc3ede228e9607fa44a86ac7bd"><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#af9293fcc3ede228e9607fa44a86ac7bd">toString</a> () const </td></tr> <tr class="separator:af9293fcc3ede228e9607fa44a86ac7bd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa3cc2a78ad48440f422b642e29228dad"><td class="memTemplParams" colspan="2">template<class Archive > </td></tr> <tr class="memitem:aa3cc2a78ad48440f422b642e29228dad"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00050.html#aa3cc2a78ad48440f422b642e29228dad">serialize</a> (Archive &ar, const unsigned int iFileVersion)</td></tr> <tr class="separator:aa3cc2a78ad48440f422b642e29228dad"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> Friends</h2></td></tr> <tr class="memitem:ac98d07dd8f7b70e16ccb9a01abf56b9c"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00050.html#ac98d07dd8f7b70e16ccb9a01abf56b9c">boost::serialization::access</a></td></tr> <tr class="separator:ac98d07dd8f7b70e16ccb9a01abf56b9c"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Key of the BOM structure root. </p> <p>Definition at line <a class="el" href="a00313_source.html#l00025">25</a> of file <a class="el" href="a00313_source.html">BomRootKey.hpp</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="af8e6348de64e8a7a4bf9f141f7c2e864"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">stdair::BomRootKey::BomRootKey </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Default constructor. </p> <p>Definition at line <a class="el" href="a00312_source.html#l00018">18</a> of file <a class="el" href="a00312_source.html">BomRootKey.cpp</a>.</p> </div> </div> <a class="anchor" id="a2ab0c1d6b77bf30d06ab7cbe999a94db"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">stdair::BomRootKey::BomRootKey </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>iIdentification</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Constructor. </p> <p>Definition at line <a class="el" href="a00312_source.html#l00028">28</a> of file <a class="el" href="a00312_source.html">BomRootKey.cpp</a>.</p> </div> </div> <a class="anchor" id="ab403b2759b7c49ce88f36f3c231c1750"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">stdair::BomRootKey::BomRootKey </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00050.html">BomRootKey</a> & </td> <td class="paramname"><em>iBomRootKey</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Copy constructor. </p> <p>Definition at line <a class="el" href="a00312_source.html#l00023">23</a> of file <a class="el" href="a00312_source.html">BomRootKey.cpp</a>.</p> </div> </div> <a class="anchor" id="ac0c5c1a29ae809b8a5bfd3ec5ad7b137"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">stdair::BomRootKey::~BomRootKey </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Destructor. </p> <p>Definition at line <a class="el" href="a00312_source.html#l00033">33</a> of file <a class="el" href="a00312_source.html">BomRootKey.cpp</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a22389df489a258682ba3297bbf5c2839"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const std::string& stdair::BomRootKey::getID </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</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>Get the identification. </p> <p>Definition at line <a class="el" href="a00313_source.html#l00056">56</a> of file <a class="el" href="a00313_source.html">BomRootKey.hpp</a>.</p> </div> </div> <a class="anchor" id="ae7537968b496d6bc24b130bbcfcc8cad"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void stdair::BomRootKey::toStream </td> <td>(</td> <td class="paramtype">std::ostream & </td> <td class="paramname"><em>ioOut</em></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Dump a Business Object Key into an output stream.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ostream&</td><td>the output stream. </td></tr> </table> </dd> </dl> <p>Reimplemented from <a class="el" href="a00116.html#ad9318a9f273cb8ef22d0921ec4d9b515">stdair::KeyAbstract</a>.</p> <p>Definition at line <a class="el" href="a00312_source.html#l00037">37</a> of file <a class="el" href="a00312_source.html">BomRootKey.cpp</a>.</p> <p>References <a class="el" href="a00312_source.html#l00046">toString()</a>.</p> </div> </div> <a class="anchor" id="a57c854648f4591d424da5a4c7073679e"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void stdair::BomRootKey::fromStream </td> <td>(</td> <td class="paramtype">std::istream & </td> <td class="paramname"><em>ioIn</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Read a Business Object Key from an input stream.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">istream&</td><td>the input stream. </td></tr> </table> </dd> </dl> <p>Reimplemented from <a class="el" href="a00116.html#a4e9cc6f20637446d2967edf912bceea3">stdair::KeyAbstract</a>.</p> <p>Definition at line <a class="el" href="a00312_source.html#l00042">42</a> of file <a class="el" href="a00312_source.html">BomRootKey.cpp</a>.</p> </div> </div> <a class="anchor" id="af9293fcc3ede228e9607fa44a86ac7bd"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const std::string stdair::BomRootKey::toString </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Get the serialised version of the Business Object Key.</p> <p>That string is unique, at the level of a given Business Object, when among children of a given parent Business Object.</p> <p>For instance, "H" and "K" allow to differentiate among two marketing classes for the same segment-date. </p> <p>Reimplemented from <a class="el" href="a00116.html#a34218466c0685a92e37264f0adb3448c">stdair::KeyAbstract</a>.</p> <p>Definition at line <a class="el" href="a00312_source.html#l00046">46</a> of file <a class="el" href="a00312_source.html">BomRootKey.cpp</a>.</p> <p>Referenced by <a class="el" href="a00311_source.html#l00131">stdair::BomRoot::describeKey()</a>, <a class="el" href="a00312_source.html#l00037">toStream()</a>, and <a class="el" href="a00310_source.html#l00036">stdair::BomRoot::toString()</a>.</p> </div> </div> <a class="anchor" id="aa3cc2a78ad48440f422b642e29228dad"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class Archive > </div> <table class="memname"> <tr> <td class="memname">void stdair::BomRootKey::serialize </td> <td>(</td> <td class="paramtype">Archive & </td> <td class="paramname"><em>ar</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned int </td> <td class="paramname"><em>iFileVersion</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Serialisation. </p> <p>Definition at line <a class="el" href="a00312_source.html#l00068">68</a> of file <a class="el" href="a00312_source.html">BomRootKey.cpp</a>.</p> </div> </div> <h2 class="groupheader">Friends And Related Function Documentation</h2> <a class="anchor" id="ac98d07dd8f7b70e16ccb9a01abf56b9c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">friend class boost::serialization::access</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">friend</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Definition at line <a class="el" href="a00313_source.html#l00026">26</a> of file <a class="el" href="a00313_source.html">BomRootKey.hpp</a>.</p> </div> </div> <hr/>The documentation for this struct was generated from the following files:<ul> <li>stdair/bom/<a class="el" href="a00313_source.html">BomRootKey.hpp</a></li> <li>stdair/bom/<a class="el" href="a00312_source.html">BomRootKey.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>