<!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"/> <title>libmusicbrainz3: MusicBrainz::TrackIncludes Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.7.3 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">libmusicbrainz3 <span id="projectnumber">3.0.3</span></div> </td> </tr> </tbody> </table> </div> <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 id="searchli"> <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> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('class_music_brainz_1_1_track_includes.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <h1>MusicBrainz::TrackIncludes Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="MusicBrainz::TrackIncludes" --><!-- doxytag: inherits="MusicBrainz::IIncludes" --> <p>A specification on how much data to return with a track. <a href="#_details">More...</a></p> <div class="dynheader"> Inheritance diagram for MusicBrainz::TrackIncludes:</div> <div class="dyncontent"> <div class="center"> <img src="class_music_brainz_1_1_track_includes.png" usemap="#MusicBrainz::TrackIncludes_map" alt=""/> <map id="MusicBrainz::TrackIncludes_map" name="MusicBrainz::TrackIncludes_map"> <area href="class_music_brainz_1_1_i_includes.html" alt="MusicBrainz::IIncludes" shape="rect" coords="0,0,167,24"/> </map> </div></div> <p><a href="class_music_brainz_1_1_track_includes-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_track_includes.html#ae91c507bb41717e05dd66f7266484813">artist</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include artist. <a href="#ae91c507bb41717e05dd66f7266484813"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_track_includes.html#a22e736df38e6a1abeeee88413bbe5f3a">releases</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include releases. <a href="#a22e736df38e6a1abeeee88413bbe5f3a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_track_includes.html#a5148a6efa0e16676c3777c5a5389949e">puids</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include PUIDs. <a href="#a5148a6efa0e16676c3777c5a5389949e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_track_includes.html#afd850f882763979aaef90525ac583662">artistRelations</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include artist relations. <a href="#afd850f882763979aaef90525ac583662"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_track_includes.html#aabb1ef9bb45cbc0e04d9c47b1a723256">labelRelations</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include label relations. <a href="#aabb1ef9bb45cbc0e04d9c47b1a723256"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_track_includes.html#ae3e8a30f4444100ca2d3e42e84df0e08">releaseRelations</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include release relations. <a href="#ae3e8a30f4444100ca2d3e42e84df0e08"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_track_includes.html#a69bef3958e5153f6e5d92d91e9f8466c">trackRelations</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include track relations. <a href="#a69bef3958e5153f6e5d92d91e9f8466c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_track_includes.html#aaf4adc106eef0d849085031f8e11ae35">urlRelations</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include URL relations. <a href="#aaf4adc106eef0d849085031f8e11ae35"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_track_includes.html#a6f314864b69d1971e1daae2229252d6a">isrcs</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include ISRCs. <a href="#a6f314864b69d1971e1daae2229252d6a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_track_includes.html#a310f2496169069df0eb9cf9e69d95124">ratings</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include ratings. <a href="#a310f2496169069df0eb9cf9e69d95124"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_track_includes.html#af50b76d9b0b4c1acf167195916b2683f">tags</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include tags. <a href="#af50b76d9b0b4c1acf167195916b2683f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_i_includes.html#afecd9a28c3be5892ec4ce11bcb4fd66e">IncludeList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_track_includes.html#ad5b3a08c1f9fdcd757609a60c28a6f9b">createIncludeTags</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of strings containing include parameters for the <a class="el" href="class_music_brainz_1_1_web_service.html" title="An interface to the MusicBrainz XML web service via HTTP.">WebService</a>. <a href="#ad5b3a08c1f9fdcd757609a60c28a6f9b"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>A specification on how much data to return with a track. </p> <p>This implementation uses <em>method</em> <em>chaining</em> to define list of includes.</p> <p>Example usage: </p> <div class="fragment"><pre class="fragment"> TrackIncludes inc = TrackIncludes().artist().puids().trackRelations(); </pre></div> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ae91c507bb41717e05dd66f7266484813"></a><!-- doxytag: member="MusicBrainz::TrackIncludes::artist" ref="ae91c507bb41717e05dd66f7266484813" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a>& MusicBrainz::TrackIncludes::artist </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include artist. </p> </div> </div> <a class="anchor" id="afd850f882763979aaef90525ac583662"></a><!-- doxytag: member="MusicBrainz::TrackIncludes::artistRelations" ref="afd850f882763979aaef90525ac583662" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a>& MusicBrainz::TrackIncludes::artistRelations </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include artist relations. </p> </div> </div> <a class="anchor" id="ad5b3a08c1f9fdcd757609a60c28a6f9b"></a><!-- doxytag: member="MusicBrainz::TrackIncludes::createIncludeTags" ref="ad5b3a08c1f9fdcd757609a60c28a6f9b" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_i_includes.html#afecd9a28c3be5892ec4ce11bcb4fd66e">IncludeList</a> MusicBrainz::TrackIncludes::createIncludeTags </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns a list of strings containing include parameters for the <a class="el" href="class_music_brainz_1_1_web_service.html" title="An interface to the MusicBrainz XML web service via HTTP.">WebService</a>. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>a list of strings </dd></dl> <p>Implements <a class="el" href="class_music_brainz_1_1_i_includes.html#abb1b62f7882ada1f52f09c044f8f0a0c">MusicBrainz::IIncludes</a>.</p> </div> </div> <a class="anchor" id="a6f314864b69d1971e1daae2229252d6a"></a><!-- doxytag: member="MusicBrainz::TrackIncludes::isrcs" ref="a6f314864b69d1971e1daae2229252d6a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a>& MusicBrainz::TrackIncludes::isrcs </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include ISRCs. </p> </div> </div> <a class="anchor" id="aabb1ef9bb45cbc0e04d9c47b1a723256"></a><!-- doxytag: member="MusicBrainz::TrackIncludes::labelRelations" ref="aabb1ef9bb45cbc0e04d9c47b1a723256" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a>& MusicBrainz::TrackIncludes::labelRelations </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include label relations. </p> </div> </div> <a class="anchor" id="a5148a6efa0e16676c3777c5a5389949e"></a><!-- doxytag: member="MusicBrainz::TrackIncludes::puids" ref="a5148a6efa0e16676c3777c5a5389949e" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a>& MusicBrainz::TrackIncludes::puids </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include PUIDs. </p> </div> </div> <a class="anchor" id="a310f2496169069df0eb9cf9e69d95124"></a><!-- doxytag: member="MusicBrainz::TrackIncludes::ratings" ref="a310f2496169069df0eb9cf9e69d95124" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a>& MusicBrainz::TrackIncludes::ratings </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include ratings. </p> </div> </div> <a class="anchor" id="ae3e8a30f4444100ca2d3e42e84df0e08"></a><!-- doxytag: member="MusicBrainz::TrackIncludes::releaseRelations" ref="ae3e8a30f4444100ca2d3e42e84df0e08" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a>& MusicBrainz::TrackIncludes::releaseRelations </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include release relations. </p> </div> </div> <a class="anchor" id="a22e736df38e6a1abeeee88413bbe5f3a"></a><!-- doxytag: member="MusicBrainz::TrackIncludes::releases" ref="a22e736df38e6a1abeeee88413bbe5f3a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a>& MusicBrainz::TrackIncludes::releases </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include releases. </p> </div> </div> <a class="anchor" id="af50b76d9b0b4c1acf167195916b2683f"></a><!-- doxytag: member="MusicBrainz::TrackIncludes::tags" ref="af50b76d9b0b4c1acf167195916b2683f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a>& MusicBrainz::TrackIncludes::tags </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include tags. </p> </div> </div> <a class="anchor" id="a69bef3958e5153f6e5d92d91e9f8466c"></a><!-- doxytag: member="MusicBrainz::TrackIncludes::trackRelations" ref="a69bef3958e5153f6e5d92d91e9f8466c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a>& MusicBrainz::TrackIncludes::trackRelations </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include track relations. </p> </div> </div> <a class="anchor" id="aaf4adc106eef0d849085031f8e11ae35"></a><!-- doxytag: member="MusicBrainz::TrackIncludes::urlRelations" ref="aaf4adc106eef0d849085031f8e11ae35" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a>& MusicBrainz::TrackIncludes::urlRelations </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include URL relations. </p> </div> </div> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespace_music_brainz.html">MusicBrainz</a> </li> <li class="navelem"><a class="el" href="class_music_brainz_1_1_track_includes.html">TrackIncludes</a> </li> <li class="footer">Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li> </ul> </div> <!--- 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>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> </body> </html>