<!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="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_artist_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::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></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> & </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"> </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> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_artist_includes.html#a7dc6bb68d97a1294fb769a690dbe4203">releases</a> (const std::string &type)</td></tr> <tr><td class="mdescLeft"> </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> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_artist_includes.html#ab03da299269337598bc8c25ceb5e825d">vaReleases</a> (const std::string &type)</td></tr> <tr><td class="mdescLeft"> </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> & </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"> </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> & </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"> </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> & </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"> </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> & </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"> </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> & </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"> </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> & </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"> </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> & </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"> </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> & </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"> </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> </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"> </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> <div class="textblock"><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> </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>& MusicBrainz::ArtistIncludes::aliases </td> <td>(</td> <td class="paramname"></td><td>)</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>& MusicBrainz::ArtistIncludes::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="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>)</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>& MusicBrainz::ArtistIncludes::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="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>& MusicBrainz::ArtistIncludes::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="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>& MusicBrainz::ArtistIncludes::releaseEvents </td> <td>(</td> <td class="paramname"></td><td>)</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>& MusicBrainz::ArtistIncludes::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="a7dc6bb68d97a1294fb769a690dbe4203"></a><!-- doxytag: member="MusicBrainz::ArtistIncludes::releases" ref="a7dc6bb68d97a1294fb769a690dbe4203" args="(const std::string &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>& MusicBrainz::ArtistIncludes::releases </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>type</em></td><td>)</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>& MusicBrainz::ArtistIncludes::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="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>& MusicBrainz::ArtistIncludes::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="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>& MusicBrainz::ArtistIncludes::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> <a class="anchor" id="ab03da299269337598bc8c25ceb5e825d"></a><!-- doxytag: member="MusicBrainz::ArtistIncludes::vaReleases" ref="ab03da299269337598bc8c25ceb5e825d" args="(const std::string &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>& MusicBrainz::ArtistIncludes::vaReleases </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>type</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include VA releases of speficied type. </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_artist_includes.html">ArtistIncludes</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>