Sophie

Sophie

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

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::ReleaseEvent 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_event.html">MusicBrainz::ReleaseEvent</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::ReleaseEvent Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="MusicBrainz::ReleaseEvent" -->
<p>A release event, indicating where and when a release took place.  
<a href="#_details">More...</a></p>

<p><a href="class_music_brainz_1_1_release_event-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_event.html#af2c468c39b7d6d6f07d6d957866e13b8">ReleaseEvent</a> (const std::string &amp;country=std::string(), const std::string &amp;dateStr=std::string())</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#af2c468c39b7d6d6f07d6d957866e13b8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_event.html#a8b29772bf4a2df3d332818101ca0e586">~ReleaseEvent</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#a8b29772bf4a2df3d332818101ca0e586"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_event.html#a6d9b96da01506dd24575c43150f2a7af">getCountry</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the country a release took place.  <a href="#a6d9b96da01506dd24575c43150f2a7af"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_event.html#a8762011afffc5da1c9904e51330668c2">setCountry</a> (const std::string &amp;country)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the country a release took place.  <a href="#a8762011afffc5da1c9904e51330668c2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_event.html#a95cc6efcc7ab4325936dc935ac92549f">getDate</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the date a release took place.  <a href="#a95cc6efcc7ab4325936dc935ac92549f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_event.html#a466031e72a590d5e925b5e3ded6062fc">setDate</a> (const std::string &amp;dateStr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the date a release took place.  <a href="#a466031e72a590d5e925b5e3ded6062fc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_event.html#a7d84aa31494959506a90b89c678b59f8">setCatalogNumber</a> (const std::string &amp;catalogNumber)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_event.html#a95dff0dfa105f56c69423dd269f36e36">getCatalogNumber</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_event.html#a7a35032e79a3054ca53f0373f2f2cf47">setBarcode</a> (const std::string &amp;barcode)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_event.html#a23eecf9b40c2c736cf1be8c93cc48dd4">getBarcode</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_event.html#a311d7e961199f3fb58d2ee90a784a046">setLabel</a> (<a class="el" href="class_music_brainz_1_1_label.html">Label</a> *label)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_label.html">Label</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_release_event.html#a9e108b5530495d596548652d46bc484b">getLabel</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A release event, indicating where and when a release took place. </p>
<p>All country codes used must be valid ISO-3166 country codes (i.e. "DE", "UK" or "FR"). The dates are strings and must have the format "YYYY", "YYYY-MM" or "YYYY-MM-DD". </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af2c468c39b7d6d6f07d6d957866e13b8"></a><!-- doxytag: member="MusicBrainz::ReleaseEvent::ReleaseEvent" ref="af2c468c39b7d6d6f07d6d957866e13b8" args="(const std::string &amp;country=std::string(), const std::string &amp;dateStr=std::string())" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">MusicBrainz::ReleaseEvent::ReleaseEvent </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>country</em> = <code>std::string()</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>dateStr</em> = <code>std::string()</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>country</em>&nbsp;</td><td>a string containing an ISO-3166 country code </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>dateStr</em>&nbsp;</td><td>a string containing a date string </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a8b29772bf4a2df3d332818101ca0e586"></a><!-- doxytag: member="MusicBrainz::ReleaseEvent::~ReleaseEvent" ref="a8b29772bf4a2df3d332818101ca0e586" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual MusicBrainz::ReleaseEvent::~ReleaseEvent </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Destructor. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a23eecf9b40c2c736cf1be8c93cc48dd4"></a><!-- doxytag: member="MusicBrainz::ReleaseEvent::getBarcode" ref="a23eecf9b40c2c736cf1be8c93cc48dd4" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string MusicBrainz::ReleaseEvent::getBarcode </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a95dff0dfa105f56c69423dd269f36e36"></a><!-- doxytag: member="MusicBrainz::ReleaseEvent::getCatalogNumber" ref="a95dff0dfa105f56c69423dd269f36e36" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string MusicBrainz::ReleaseEvent::getCatalogNumber </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a6d9b96da01506dd24575c43150f2a7af"></a><!-- doxytag: member="MusicBrainz::ReleaseEvent::getCountry" ref="a6d9b96da01506dd24575c43150f2a7af" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string MusicBrainz::ReleaseEvent::getCountry </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the country a release took place. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Due to a server limitation, the web service does not return country IDs for release collection queries. This only affects the <a class="el" href="class_music_brainz_1_1_query.html#a260cba6b0c688e6e7c65f4c19b5b5836" title="Returns releases matching given criteria.">Query::getReleases</a> query.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a string containing an ISO-3166 country code</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="namespace_music_brainz.html#aa261c6fec3927422b4da1ba95aa6ea12" title="Returns a country&#39;s name based on an ISO-3166 country code.">getCountryName</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a95cc6efcc7ab4325936dc935ac92549f"></a><!-- doxytag: member="MusicBrainz::ReleaseEvent::getDate" ref="a95cc6efcc7ab4325936dc935ac92549f" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string MusicBrainz::ReleaseEvent::getDate </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the date a release took place. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a string containing a date </dd></dl>

</div>
</div>
<a class="anchor" id="a9e108b5530495d596548652d46bc484b"></a><!-- doxytag: member="MusicBrainz::ReleaseEvent::getLabel" ref="a9e108b5530495d596548652d46bc484b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_music_brainz_1_1_label.html">Label</a>* MusicBrainz::ReleaseEvent::getLabel </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a7a35032e79a3054ca53f0373f2f2cf47"></a><!-- doxytag: member="MusicBrainz::ReleaseEvent::setBarcode" ref="a7a35032e79a3054ca53f0373f2f2cf47" args="(const std::string &amp;barcode)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void MusicBrainz::ReleaseEvent::setBarcode </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>barcode</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a7d84aa31494959506a90b89c678b59f8"></a><!-- doxytag: member="MusicBrainz::ReleaseEvent::setCatalogNumber" ref="a7d84aa31494959506a90b89c678b59f8" args="(const std::string &amp;catalogNumber)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void MusicBrainz::ReleaseEvent::setCatalogNumber </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>catalogNumber</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a8762011afffc5da1c9904e51330668c2"></a><!-- doxytag: member="MusicBrainz::ReleaseEvent::setCountry" ref="a8762011afffc5da1c9904e51330668c2" args="(const std::string &amp;country)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void MusicBrainz::ReleaseEvent::setCountry </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>country</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the country a release took place. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>country</em>&nbsp;</td><td>a string containing an ISO-3166 country code </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a466031e72a590d5e925b5e3ded6062fc"></a><!-- doxytag: member="MusicBrainz::ReleaseEvent::setDate" ref="a466031e72a590d5e925b5e3ded6062fc" args="(const std::string &amp;dateStr)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void MusicBrainz::ReleaseEvent::setDate </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>dateStr</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the date a release took place. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>dateStr</em>&nbsp;</td><td>a string containing a date </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a311d7e961199f3fb58d2ee90a784a046"></a><!-- doxytag: member="MusicBrainz::ReleaseEvent::setLabel" ref="a311d7e961199f3fb58d2ee90a784a046" args="(Label *label)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void MusicBrainz::ReleaseEvent::setLabel </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_music_brainz_1_1_label.html">Label</a> *&nbsp;</td>
          <td class="paramname"> <em>label</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</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>