Sophie

Sophie

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

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

<p><a href="class_music_brainz_1_1_artist_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_artist_includes.html">ArtistIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_artist_includes.html#a3b75f67d95f29f66bdeac7929beba675">aliases</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include aliases.  <a href="#a3b75f67d95f29f66bdeac7929beba675"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_artist_includes.html#a7dc6bb68d97a1294fb769a690dbe4203">releases</a> (const std::string &amp;type)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include releases of speficied type.  <a href="#a7dc6bb68d97a1294fb769a690dbe4203"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_artist_includes.html#ab03da299269337598bc8c25ceb5e825d">vaReleases</a> (const std::string &amp;type)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include VA releases of speficied type.  <a href="#ab03da299269337598bc8c25ceb5e825d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_artist_includes.html#ab6755ece9aa1809ac962a3425efc1c2e">releaseEvents</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include release events for included releases.  <a href="#ab6755ece9aa1809ac962a3425efc1c2e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_artist_includes.html#a9d189cc8b7a08ba67a455051e3775704">artistRelations</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include artist relations.  <a href="#a9d189cc8b7a08ba67a455051e3775704"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_artist_includes.html#a18207ebeed7a056578bf4c3973797fd0">labelRelations</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include label relations.  <a href="#a18207ebeed7a056578bf4c3973797fd0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_artist_includes.html#a87183b5f36f1cdac9e916d4d6318c838">releaseRelations</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include release relations.  <a href="#a87183b5f36f1cdac9e916d4d6318c838"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_artist_includes.html#ac63ead7a89592df883c9b332e66bbe3a">trackRelations</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include track relations.  <a href="#ac63ead7a89592df883c9b332e66bbe3a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_artist_includes.html#a477c29043154e9838e2f45722d9b1614">urlRelations</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include URL relations.  <a href="#a477c29043154e9838e2f45722d9b1614"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_artist_includes.html#aefea01db17197b5e5b787d92d0ce8a27">ratings</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include ratings.  <a href="#aefea01db17197b5e5b787d92d0ce8a27"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_artist_includes.html#a2b6b5ba0901e7e661d0fc1a483c0023f">tags</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include tags.  <a href="#a2b6b5ba0901e7e661d0fc1a483c0023f"></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_artist_includes.html#a47fcf6d606b5b6f23b892e170e2c5609">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="#a47fcf6d606b5b6f23b892e170e2c5609"></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 artist. </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"> ArtistIncludes inc = ArtistIncludes().aliases().urlRelations();
</pre></div> <hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3b75f67d95f29f66bdeac7929beba675"></a><!-- doxytag: member="MusicBrainz::ArtistIncludes::aliases" ref="a3b75f67d95f29f66bdeac7929beba675" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a>&amp; MusicBrainz::ArtistIncludes::aliases </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Include aliases. </p>

</div>
</div>
<a class="anchor" id="a9d189cc8b7a08ba67a455051e3775704"></a><!-- doxytag: member="MusicBrainz::ArtistIncludes::artistRelations" ref="a9d189cc8b7a08ba67a455051e3775704" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a>&amp; MusicBrainz::ArtistIncludes::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="a47fcf6d606b5b6f23b892e170e2c5609"></a><!-- doxytag: member="MusicBrainz::ArtistIncludes::createIncludeTags" ref="a47fcf6d606b5b6f23b892e170e2c5609" 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::ArtistIncludes::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="a18207ebeed7a056578bf4c3973797fd0"></a><!-- doxytag: member="MusicBrainz::ArtistIncludes::labelRelations" ref="a18207ebeed7a056578bf4c3973797fd0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a>&amp; MusicBrainz::ArtistIncludes::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="aefea01db17197b5e5b787d92d0ce8a27"></a><!-- doxytag: member="MusicBrainz::ArtistIncludes::ratings" ref="aefea01db17197b5e5b787d92d0ce8a27" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a>&amp; MusicBrainz::ArtistIncludes::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="ab6755ece9aa1809ac962a3425efc1c2e"></a><!-- doxytag: member="MusicBrainz::ArtistIncludes::releaseEvents" ref="ab6755ece9aa1809ac962a3425efc1c2e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a>&amp; MusicBrainz::ArtistIncludes::releaseEvents </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Include release events for included releases. </p>

</div>
</div>
<a class="anchor" id="a87183b5f36f1cdac9e916d4d6318c838"></a><!-- doxytag: member="MusicBrainz::ArtistIncludes::releaseRelations" ref="a87183b5f36f1cdac9e916d4d6318c838" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a>&amp; MusicBrainz::ArtistIncludes::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="a7dc6bb68d97a1294fb769a690dbe4203"></a><!-- doxytag: member="MusicBrainz::ArtistIncludes::releases" ref="a7dc6bb68d97a1294fb769a690dbe4203" args="(const std::string &amp;type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a>&amp; MusicBrainz::ArtistIncludes::releases </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>type</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Include releases of speficied type. </p>

</div>
</div>
<a class="anchor" id="a2b6b5ba0901e7e661d0fc1a483c0023f"></a><!-- doxytag: member="MusicBrainz::ArtistIncludes::tags" ref="a2b6b5ba0901e7e661d0fc1a483c0023f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a>&amp; MusicBrainz::ArtistIncludes::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="ac63ead7a89592df883c9b332e66bbe3a"></a><!-- doxytag: member="MusicBrainz::ArtistIncludes::trackRelations" ref="ac63ead7a89592df883c9b332e66bbe3a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a>&amp; MusicBrainz::ArtistIncludes::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="a477c29043154e9838e2f45722d9b1614"></a><!-- doxytag: member="MusicBrainz::ArtistIncludes::urlRelations" ref="a477c29043154e9838e2f45722d9b1614" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a>&amp; MusicBrainz::ArtistIncludes::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>
<a class="anchor" id="ab03da299269337598bc8c25ceb5e825d"></a><!-- doxytag: member="MusicBrainz::ArtistIncludes::vaReleases" ref="ab03da299269337598bc8c25ceb5e825d" args="(const std::string &amp;type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_artist_includes.html">ArtistIncludes</a>&amp; MusicBrainz::ArtistIncludes::vaReleases </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>type</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Include VA releases of speficied type. </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>