mkdocs/docs/api/xml/classiceberg_1_1YearTransform.xml

<?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.9.8" xml:lang="en-US">
  <compounddef id="classiceberg_1_1YearTransform" kind="class" language="C++" prot="public">
    <compoundname>iceberg::YearTransform</compoundname>
    <basecompoundref refid="classiceberg_1_1TransformFunction" prot="public" virt="non-virtual">iceberg::TransformFunction</basecompoundref>
    <includes refid="transform__function_8h" local="no">transform_function.h</includes>
    <sectiondef kind="public-func">
      <memberdef kind="function" id="classiceberg_1_1YearTransform_1a8435fbd3092b91a3c64e16d9e1b23781" prot="public" static="no" const="no" explicit="yes" inline="no" virt="non-virtual">
        <type></type>
        <definition>iceberg::YearTransform::YearTransform</definition>
        <argsstring>(std::shared_ptr&lt; Type &gt; const &amp;source_type)</argsstring>
        <name>YearTransform</name>
        <qualifiedname>iceberg::YearTransform::YearTransform</qualifiedname>
        <param>
          <type>std::shared_ptr&lt; <ref refid="classiceberg_1_1Type" kindref="compound">Type</ref> &gt; const &amp;</type>
          <declname>source_type</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>source_type</parametername>
</parameternamelist>
<parameterdescription>
<para>Must be a timestamp type. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/transform_function.h" line="108" column="12" bodyfile="iceberg/transform_function.cc" bodystart="131" bodyend="132"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1YearTransform_1ab6a9e6cb09b2b642d45e87022e4eafd6" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>Result&lt; <ref refid="classiceberg_1_1Literal" kindref="compound">Literal</ref> &gt;</type>
        <definition>Result&lt; Literal &gt; iceberg::YearTransform::Transform</definition>
        <argsstring>(const Literal &amp;literal) override</argsstring>
        <name>Transform</name>
        <qualifiedname>iceberg::YearTransform::Transform</qualifiedname>
        <reimplements refid="classiceberg_1_1TransformFunction_1afb1c573d9bd098c76d858f476ef16f3f">Transform</reimplements>
        <param>
          <type>const <ref refid="classiceberg_1_1Literal" kindref="compound">Literal</ref> &amp;</type>
          <declname>literal</declname>
        </param>
        <briefdescription>
<para>Extract a date or timestamp year, as years from 1970. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/transform_function.h" line="111" column="10" bodyfile="iceberg/transform_function.cc" bodystart="134" bodyend="138"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1YearTransform_1a4bb19208b08037ec41081009a4c7f21a" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type>std::shared_ptr&lt; <ref refid="classiceberg_1_1Type" kindref="compound">Type</ref> &gt;</type>
        <definition>std::shared_ptr&lt; Type &gt; iceberg::YearTransform::ResultType</definition>
        <argsstring>() const override</argsstring>
        <name>ResultType</name>
        <qualifiedname>iceberg::YearTransform::ResultType</qualifiedname>
        <reimplements refid="classiceberg_1_1TransformFunction_1a82841b58ce6380a7467bccf57e18e0d5">ResultType</reimplements>
        <briefdescription>
<para>Returns INT32 as the output type. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/transform_function.h" line="114" column="19" bodyfile="iceberg/transform_function.cc" bodystart="140" bodyend="140"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-static-func">
      <memberdef kind="function" id="classiceberg_1_1YearTransform_1ab10de3ee59a285c18a2848b823f1d76b" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>Result&lt; std::unique_ptr&lt; <ref refid="classiceberg_1_1TransformFunction" kindref="compound">TransformFunction</ref> &gt; &gt;</type>
        <definition>Result&lt; std::unique_ptr&lt; TransformFunction &gt; &gt; iceberg::YearTransform::Make</definition>
        <argsstring>(std::shared_ptr&lt; Type &gt; const &amp;source_type)</argsstring>
        <name>Make</name>
        <qualifiedname>iceberg::YearTransform::Make</qualifiedname>
        <param>
          <type>std::shared_ptr&lt; <ref refid="classiceberg_1_1Type" kindref="compound">Type</ref> &gt; const &amp;</type>
          <declname>source_type</declname>
        </param>
        <briefdescription>
<para>Create a <ref refid="classiceberg_1_1YearTransform" kindref="compound">YearTransform</ref>. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>source_type</parametername>
</parameternamelist>
<parameterdescription>
<para><ref refid="classiceberg_1_1Type" kindref="compound">Type</ref> of the input data. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A Result containing the <ref refid="classiceberg_1_1YearTransform" kindref="compound">YearTransform</ref> or an error. </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/transform_function.h" line="119" column="17" bodyfile="iceberg/transform_function.cc" bodystart="142" bodyend="157"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
<para>Year transform that extracts the number of years from timestamp inputs since the epoch. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="2">
        <label>iceberg::TransformFunction</label>
        <link refid="classiceberg_1_1TransformFunction"/>
      </node>
      <node id="1">
        <label>iceberg::YearTransform</label>
        <link refid="classiceberg_1_1YearTransform"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="2">
        <label>iceberg::TransformFunction</label>
        <link refid="classiceberg_1_1TransformFunction"/>
      </node>
      <node id="1">
        <label>iceberg::YearTransform</label>
        <link refid="classiceberg_1_1YearTransform"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
    </collaborationgraph>
    <location file="iceberg/transform_function.h" line="105" column="1" bodyfile="iceberg/transform_function.h" bodystart="105" bodyend="121"/>
    <listofallmembers>
      <member refid="classiceberg_1_1YearTransform_1ab10de3ee59a285c18a2848b823f1d76b" prot="public" virt="non-virtual"><scope>iceberg::YearTransform</scope><name>Make</name></member>
      <member refid="classiceberg_1_1YearTransform_1a4bb19208b08037ec41081009a4c7f21a" prot="public" virt="virtual"><scope>iceberg::YearTransform</scope><name>ResultType</name></member>
      <member refid="classiceberg_1_1TransformFunction_1a5fb6043200973c2a68f1b59b52f3dc91" prot="public" virt="non-virtual"><scope>iceberg::YearTransform</scope><name>source_type</name></member>
      <member refid="classiceberg_1_1YearTransform_1ab6a9e6cb09b2b642d45e87022e4eafd6" prot="public" virt="virtual"><scope>iceberg::YearTransform</scope><name>Transform</name></member>
      <member refid="classiceberg_1_1TransformFunction_1abf4c9031fa1b0de214e6aa7ffc717c56" prot="public" virt="non-virtual"><scope>iceberg::YearTransform</scope><name>transform_type</name></member>
      <member refid="classiceberg_1_1TransformFunction_1a3e97589741424abf0fb1c0c01117bb5e" prot="public" virt="non-virtual"><scope>iceberg::YearTransform</scope><name>TransformFunction</name></member>
      <member refid="classiceberg_1_1YearTransform_1a8435fbd3092b91a3c64e16d9e1b23781" prot="public" virt="non-virtual"><scope>iceberg::YearTransform</scope><name>YearTransform</name></member>
      <member refid="classiceberg_1_1TransformFunction_1a523fa272f921de4a2b69a7b6277b39f4" prot="public" virt="virtual"><scope>iceberg::YearTransform</scope><name>~TransformFunction</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>