Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > 964aecd60fac62d5dc5479d22a0c53ef > files > 162

libmusicbrainz3-devel-3.0.3-2.fc14.x86_64.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"/>
<title>libmusicbrainz3: MusicBrainz::TrackIncludes Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul class="tablist">
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;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>
    </ul>
  </div>
  <div class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath">
    <ul>
      <li><a class="el" href="namespace_music_brainz.html">MusicBrainz</a>      </li>
      <li><a class="el" href="class_music_brainz_1_1_track_includes.html">MusicBrainz::TrackIncludes</a>      </li>
    </ul>
  </div>
</div>
<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>

<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> &amp;&nbsp;</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">&nbsp;</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> &amp;&nbsp;</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">&nbsp;</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> &amp;&nbsp;</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">&nbsp;</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> &amp;&nbsp;</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">&nbsp;</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> &amp;&nbsp;</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">&nbsp;</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> &amp;&nbsp;</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">&nbsp;</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> &amp;&nbsp;</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">&nbsp;</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> &amp;&nbsp;</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">&nbsp;</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> &amp;&nbsp;</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">&nbsp;</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> &amp;&nbsp;</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">&nbsp;</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> &amp;&nbsp;</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">&nbsp;</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>&nbsp;</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">&nbsp;</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>
<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> <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>&amp; MusicBrainz::TrackIncludes::artist </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</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>&amp; MusicBrainz::TrackIncludes::artistRelations </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</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>&nbsp;)&nbsp;</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>&amp; MusicBrainz::TrackIncludes::isrcs </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</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>&amp; MusicBrainz::TrackIncludes::labelRelations </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</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>&amp; MusicBrainz::TrackIncludes::puids </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</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>&amp; MusicBrainz::TrackIncludes::ratings </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</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>&amp; MusicBrainz::TrackIncludes::releaseRelations </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</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>&amp; MusicBrainz::TrackIncludes::releases </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</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>&amp; MusicBrainz::TrackIncludes::tags </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</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>&amp; MusicBrainz::TrackIncludes::trackRelations </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</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>&amp; MusicBrainz::TrackIncludes::urlRelations </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Include URL relations. </p>

</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>