<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.20" xml:lang="en-US">
  <compounddef id="classUserMetricsInput_1_1Metric" kind="class" language="C++" prot="public" abstract="yes">
    <compoundname>UserMetricsInput::Metric</compoundname>
    <basecompoundref prot="public" virt="non-virtual">QObject</basecompoundref>
    <includes refid="Metric_8h" local="no">libusermetricsinput/Metric.h</includes>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classUserMetricsInput_1_1Metric_1a33d519fb328c1372664dfdaa8cec8538" prot="public" static="no" const="no" explicit="yes" inline="no" virt="non-virtual">
        <type></type>
        <definition>UserMetricsInput::Metric::Metric</definition>
        <argsstring>(QObject *parent=0)</argsstring>
        <name>Metric</name>
        <param>
          <type>QObject *</type>
          <declname>parent</declname>
          <defval>0</defval>
        </param>
        <briefdescription>
<para>This constructor cannot be used - the class is pure-virtual. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="libusermetricsinput/Metric.h" line="55" column="10"/>
      </memberdef>
      <memberdef kind="function" id="classUserMetricsInput_1_1Metric_1a60793ca328456875f9a7a27c72e14e20" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type></type>
        <definition>virtual UserMetricsInput::Metric::~Metric</definition>
        <argsstring>()</argsstring>
        <name>~Metric</name>
        <briefdescription>
<para>Destructor. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="libusermetricsinput/Metric.h" line="60" column="9"/>
      </memberdef>
      <memberdef kind="function" id="classUserMetricsInput_1_1Metric_1adf28239b6ee21f1f22c98c2c9ed1ec77" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type><ref refid="classUserMetricsInput_1_1MetricUpdate" kindref="compound">MetricUpdate</ref> *</type>
        <definition>virtual MetricUpdate* UserMetricsInput::Metric::update</definition>
        <argsstring>(const QString &amp;username=&quot;&quot;)=0</argsstring>
        <name>update</name>
        <param>
          <type>const QString &amp;</type>
          <declname>username</declname>
          <defval>&quot;&quot;</defval>
        </param>
        <briefdescription>
<para>Create an <ref refid="classUserMetricsInput_1_1MetricUpdate" kindref="compound">MetricUpdate</ref> to a particular <ref refid="classUserMetricsInput_1_1Metric" kindref="compound">Metric</ref>. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>username</parametername>
</parameternamelist>
<parameterdescription>
<para>The user to update the data for. If blank (&quot;&quot;) or omitted then the current user is used.</para>
</parameterdescription>
</parameteritem>
</parameterlist>
The <ref refid="classUserMetricsInput_1_1MetricUpdate" kindref="compound">MetricUpdate</ref> object must be deleted - this is when the actual update will be sent to the storage service. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="libusermetricsinput/Metric.h" line="71" column="23"/>
      </memberdef>
      <memberdef kind="function" id="classUserMetricsInput_1_1Metric_1acb6a02587987a6148103f56fc9e4f8b5" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>void</type>
        <definition>virtual void UserMetricsInput::Metric::update</definition>
        <argsstring>(double value, const QString &amp;username=&quot;&quot;)=0</argsstring>
        <name>update</name>
        <param>
          <type>double</type>
          <declname>value</declname>
        </param>
        <param>
          <type>const QString &amp;</type>
          <declname>username</declname>
          <defval>&quot;&quot;</defval>
        </param>
        <briefdescription>
<para>Update the &quot;today&quot; value for a simple user metric. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>value</parametername>
</parameternamelist>
<parameterdescription>
<para>Today&apos;s value </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>username</parametername>
</parameternamelist>
<parameterdescription>
<para>The user to update the data for. If blank (&quot;&quot;) or omitted then the current user is used. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="libusermetricsinput/Metric.h" line="80" column="14"/>
      </memberdef>
      <memberdef kind="function" id="classUserMetricsInput_1_1Metric_1a28f907f811e37e522a253f1665355c5c" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>void</type>
        <definition>virtual void UserMetricsInput::Metric::increment</definition>
        <argsstring>(double amount=1.0f, const QString &amp;username=&quot;&quot;)=0</argsstring>
        <name>increment</name>
        <param>
          <type>double</type>
          <declname>amount</declname>
          <defval>1.0f</defval>
        </param>
        <param>
          <type>const QString &amp;</type>
          <declname>username</declname>
          <defval>&quot;&quot;</defval>
        </param>
        <briefdescription>
<para>Increment the &quot;today&quot; value for a simple user metric. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>amount</parametername>
</parameternamelist>
<parameterdescription>
<para>How much to increase the metric by - defaults to 1. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>username</parametername>
</parameternamelist>
<parameterdescription>
<para>The user to update the data for. If blank (&quot;&quot;) or omitted then the current user is used. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="libusermetricsinput/Metric.h" line="89" column="14"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>This class represents a single user metric. </para>
    </briefdescription>
    <detaileddescription>
<para>For example, &quot;number of e-mails today&quot; or &quot;photos taken today&quot;.</para>
<para>This is a long-lived class that can exist for the whole application lifecycle. </para>
    </detaileddescription>
    <inheritancegraph>
      <node id="2">
        <label>QObject</label>
      </node>
      <node id="1">
        <label>UserMetricsInput::Metric</label>
        <link refid="classUserMetricsInput_1_1Metric"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="2">
        <label>QObject</label>
      </node>
      <node id="1">
        <label>UserMetricsInput::Metric</label>
        <link refid="classUserMetricsInput_1_1Metric"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
    </collaborationgraph>
    <location file="libusermetricsinput/Metric.h" line="50" column="1" bodyfile="libusermetricsinput/Metric.h" bodystart="50" bodyend="91"/>
    <listofallmembers>
      <member refid="classUserMetricsInput_1_1Metric_1a28f907f811e37e522a253f1665355c5c" prot="public" virt="pure-virtual"><scope>UserMetricsInput::Metric</scope><name>increment</name></member>
      <member refid="classUserMetricsInput_1_1Metric_1a33d519fb328c1372664dfdaa8cec8538" prot="public" virt="non-virtual"><scope>UserMetricsInput::Metric</scope><name>Metric</name></member>
      <member refid="classUserMetricsInput_1_1Metric_1adf28239b6ee21f1f22c98c2c9ed1ec77" prot="public" virt="pure-virtual"><scope>UserMetricsInput::Metric</scope><name>update</name></member>
      <member refid="classUserMetricsInput_1_1Metric_1acb6a02587987a6148103f56fc9e4f8b5" prot="public" virt="pure-virtual"><scope>UserMetricsInput::Metric</scope><name>update</name></member>
      <member refid="classUserMetricsInput_1_1Metric_1a60793ca328456875f9a7a27c72e14e20" prot="public" virt="virtual"><scope>UserMetricsInput::Metric</scope><name>~Metric</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
