Sophie

Sophie

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

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::ReleaseIncludes 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_release_includes.html">MusicBrainz::ReleaseIncludes</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::ReleaseIncludes Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="MusicBrainz::ReleaseIncludes" --><!-- doxytag: inherits="MusicBrainz::IIncludes" -->
<p>A specification on how much data to return with a release.  
<a href="#_details">More...</a></p>
<div class="dynheader">
Inheritance diagram for MusicBrainz::ReleaseIncludes:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_music_brainz_1_1_release_includes.png" usemap="#MusicBrainz::ReleaseIncludes_map" alt=""/>
  <map id="MusicBrainz::ReleaseIncludes_map" name="MusicBrainz::ReleaseIncludes_map">
<area href="class_music_brainz_1_1_i_includes.html" alt="MusicBrainz::IIncludes" shape="rect" coords="0,0,180,24"/>
</map>
</div>

<p><a href="class_music_brainz_1_1_release_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_release_includes.html">ReleaseIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_includes.html#ae1ec63326c5b7d2a2228dc6049dafe4f">artist</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include artist.  <a href="#ae1ec63326c5b7d2a2228dc6049dafe4f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_includes.html#a0c6acc818a6fc3fe065ea108cafb3ca9">counts</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include counts.  <a href="#a0c6acc818a6fc3fe065ea108cafb3ca9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_includes.html#ae109f2ea8bb12658bde3ea740bb066dd">releaseEvents</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include release events.  <a href="#ae109f2ea8bb12658bde3ea740bb066dd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_includes.html#a4cd91eb1c6fe86cc300ceb830852499b">discs</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include discs.  <a href="#a4cd91eb1c6fe86cc300ceb830852499b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_includes.html#a1d533a67f0f79025764f68e422bd345a">tracks</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include tracks.  <a href="#a1d533a67f0f79025764f68e422bd345a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_includes.html#a3c2d692f811fb49d4e79c4993e43487b">artistRelations</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include artist relations.  <a href="#a3c2d692f811fb49d4e79c4993e43487b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_includes.html#afb9af627d2aa6c06c0c61904e3b1463e">labelRelations</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include label relations.  <a href="#afb9af627d2aa6c06c0c61904e3b1463e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_includes.html#a3be16736d602e141b36090bc82fd4d0f">releaseRelations</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include release relations.  <a href="#a3be16736d602e141b36090bc82fd4d0f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_includes.html#a83f3225bf47a24ed9ebb4ec5a7a48ab6">trackRelations</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include track relations.  <a href="#a83f3225bf47a24ed9ebb4ec5a7a48ab6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_includes.html#a0bdb42dc4d5a6c8e8242f03dee053f0c">urlRelations</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include URL relations.  <a href="#a0bdb42dc4d5a6c8e8242f03dee053f0c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_includes.html#a00971e41d7004de582da0073f0d33f46">isrcs</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include ISRCs.  <a href="#a00971e41d7004de582da0073f0d33f46"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_includes.html#ad98086e6754863a5a41fd710d1c95ec2">ratings</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include ratings.  <a href="#ad98086e6754863a5a41fd710d1c95ec2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_includes.html#a520533567951d16159630c43f04754ba">tags</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include tags.  <a href="#a520533567951d16159630c43f04754ba"></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_release_includes.html#a526a0933394ff5b73b002f3b4496720f">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="#a526a0933394ff5b73b002f3b4496720f"></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 release. </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"> ReleaseIncludes inc = ReleaseIncludes().releaseEvents().disc();
</pre></div> <hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae1ec63326c5b7d2a2228dc6049dafe4f"></a><!-- doxytag: member="MusicBrainz::ReleaseIncludes::artist" ref="ae1ec63326c5b7d2a2228dc6049dafe4f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a>&amp; MusicBrainz::ReleaseIncludes::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="a3c2d692f811fb49d4e79c4993e43487b"></a><!-- doxytag: member="MusicBrainz::ReleaseIncludes::artistRelations" ref="a3c2d692f811fb49d4e79c4993e43487b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a>&amp; MusicBrainz::ReleaseIncludes::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="a0c6acc818a6fc3fe065ea108cafb3ca9"></a><!-- doxytag: member="MusicBrainz::ReleaseIncludes::counts" ref="a0c6acc818a6fc3fe065ea108cafb3ca9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a>&amp; MusicBrainz::ReleaseIncludes::counts </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Include counts. </p>

</div>
</div>
<a class="anchor" id="a526a0933394ff5b73b002f3b4496720f"></a><!-- doxytag: member="MusicBrainz::ReleaseIncludes::createIncludeTags" ref="a526a0933394ff5b73b002f3b4496720f" 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::ReleaseIncludes::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="a4cd91eb1c6fe86cc300ceb830852499b"></a><!-- doxytag: member="MusicBrainz::ReleaseIncludes::discs" ref="a4cd91eb1c6fe86cc300ceb830852499b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a>&amp; MusicBrainz::ReleaseIncludes::discs </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Include discs. </p>

</div>
</div>
<a class="anchor" id="a00971e41d7004de582da0073f0d33f46"></a><!-- doxytag: member="MusicBrainz::ReleaseIncludes::isrcs" ref="a00971e41d7004de582da0073f0d33f46" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a>&amp; MusicBrainz::ReleaseIncludes::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="afb9af627d2aa6c06c0c61904e3b1463e"></a><!-- doxytag: member="MusicBrainz::ReleaseIncludes::labelRelations" ref="afb9af627d2aa6c06c0c61904e3b1463e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a>&amp; MusicBrainz::ReleaseIncludes::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="ad98086e6754863a5a41fd710d1c95ec2"></a><!-- doxytag: member="MusicBrainz::ReleaseIncludes::ratings" ref="ad98086e6754863a5a41fd710d1c95ec2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a>&amp; MusicBrainz::ReleaseIncludes::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="ae109f2ea8bb12658bde3ea740bb066dd"></a><!-- doxytag: member="MusicBrainz::ReleaseIncludes::releaseEvents" ref="ae109f2ea8bb12658bde3ea740bb066dd" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a>&amp; MusicBrainz::ReleaseIncludes::releaseEvents </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Include release events. </p>

</div>
</div>
<a class="anchor" id="a3be16736d602e141b36090bc82fd4d0f"></a><!-- doxytag: member="MusicBrainz::ReleaseIncludes::releaseRelations" ref="a3be16736d602e141b36090bc82fd4d0f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a>&amp; MusicBrainz::ReleaseIncludes::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="a520533567951d16159630c43f04754ba"></a><!-- doxytag: member="MusicBrainz::ReleaseIncludes::tags" ref="a520533567951d16159630c43f04754ba" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a>&amp; MusicBrainz::ReleaseIncludes::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="a83f3225bf47a24ed9ebb4ec5a7a48ab6"></a><!-- doxytag: member="MusicBrainz::ReleaseIncludes::trackRelations" ref="a83f3225bf47a24ed9ebb4ec5a7a48ab6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a>&amp; MusicBrainz::ReleaseIncludes::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="a1d533a67f0f79025764f68e422bd345a"></a><!-- doxytag: member="MusicBrainz::ReleaseIncludes::tracks" ref="a1d533a67f0f79025764f68e422bd345a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a>&amp; MusicBrainz::ReleaseIncludes::tracks </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Include tracks. </p>

</div>
</div>
<a class="anchor" id="a0bdb42dc4d5a6c8e8242f03dee053f0c"></a><!-- doxytag: member="MusicBrainz::ReleaseIncludes::urlRelations" ref="a0bdb42dc4d5a6c8e8242f03dee053f0c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_release_includes.html">ReleaseIncludes</a>&amp; MusicBrainz::ReleaseIncludes::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>