mkdocs/docs/api/xml/classiceberg_1_1UnboundTransform.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_1UnboundTransform" kind="class" language="C++" prot="public">
    <compoundname>iceberg::UnboundTransform</compoundname>
    <basecompoundref refid="classiceberg_1_1UnboundTerm" prot="public" virt="non-virtual">iceberg::UnboundTerm&lt; class BoundTransform &gt;</basecompoundref>
    <includes refid="term_8h" local="no">term.h</includes>
    <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classiceberg_1_1UnboundTransform_1aa7d3feaeb690d2df1261d319f6ade410" prot="private" static="no" mutable="no">
        <type>std::shared_ptr&lt; <ref refid="classiceberg_1_1NamedReference" kindref="compound">NamedReference</ref> &gt;</type>
        <definition>std::shared_ptr&lt;NamedReference&gt; iceberg::UnboundTransform::ref_</definition>
        <argsstring></argsstring>
        <name>ref_</name>
        <qualifiedname>iceberg::UnboundTransform::ref_</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/expression/term.h" line="198" column="19" bodyfile="iceberg/expression/term.h" bodystart="198" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classiceberg_1_1UnboundTransform_1af43cd60fe1725352ae67f7a2121c8a38" prot="private" static="no" mutable="no">
        <type>std::shared_ptr&lt; <ref refid="classiceberg_1_1Transform" kindref="compound">Transform</ref> &gt;</type>
        <definition>std::shared_ptr&lt;Transform&gt; iceberg::UnboundTransform::transform_</definition>
        <argsstring></argsstring>
        <name>transform_</name>
        <qualifiedname>iceberg::UnboundTransform::transform_</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/expression/term.h" line="199" column="19" bodyfile="iceberg/expression/term.h" bodystart="199" bodyend="-1"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-static-func">
      <memberdef kind="function" id="classiceberg_1_1UnboundTransform_1a6310481c32ff955e0aba82369a23e604" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>Result&lt; std::unique_ptr&lt; <ref refid="classiceberg_1_1UnboundTransform" kindref="compound">UnboundTransform</ref> &gt; &gt;</type>
        <definition>Result&lt; std::unique_ptr&lt; UnboundTransform &gt; &gt; iceberg::UnboundTransform::Make</definition>
        <argsstring>(std::shared_ptr&lt; NamedReference &gt; ref, std::shared_ptr&lt; Transform &gt; transform)</argsstring>
        <name>Make</name>
        <qualifiedname>iceberg::UnboundTransform::Make</qualifiedname>
        <param>
          <type>std::shared_ptr&lt; <ref refid="classiceberg_1_1NamedReference" kindref="compound">NamedReference</ref> &gt;</type>
          <declname>ref</declname>
        </param>
        <param>
          <type>std::shared_ptr&lt; <ref refid="classiceberg_1_1Transform" kindref="compound">Transform</ref> &gt;</type>
          <declname>transform</declname>
        </param>
        <briefdescription>
<para>Create an unbound transform. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>ref</parametername>
</parameternamelist>
<parameterdescription>
<para>The term to apply the transformation to </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>transform</parametername>
</parameternamelist>
<parameterdescription>
<para>The transformation function to apply </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/expression/term.h" line="178" column="17" bodyfile="iceberg/expression/term.cc" bodystart="122" bodyend="130"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-func">
      <memberdef kind="function" id="classiceberg_1_1UnboundTransform_1ad6baa8b473f154daca991c84a0aaf89c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>iceberg::UnboundTransform::~UnboundTransform</definition>
        <argsstring>() override</argsstring>
        <name>~UnboundTransform</name>
        <qualifiedname>iceberg::UnboundTransform::~UnboundTransform</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/expression/term.h" line="181" column="3"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1UnboundTransform_1aac2547c880112427e20259f84d4f2d80" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type>std::string</type>
        <definition>std::string iceberg::UnboundTransform::ToString</definition>
        <argsstring>() const override</argsstring>
        <name>ToString</name>
        <qualifiedname>iceberg::UnboundTransform::ToString</qualifiedname>
        <reimplements refid="classiceberg_1_1util_1_1Formattable_1a79618aca5b3bf63610d9c87ac5ae0386">ToString</reimplements>
        <briefdescription>
<para>Get a user-readable string representation. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/expression/term.h" line="183" column="15" bodyfile="iceberg/expression/term.cc" bodystart="141" bodyend="143"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1UnboundTransform_1aa6559c7e9a4b4c46cf58730d467327b2" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
        <type>Result&lt; std::shared_ptr&lt; <ref refid="classiceberg_1_1BoundTransform" kindref="compound">BoundTransform</ref> &gt; &gt;</type>
        <definition>Result&lt; std::shared_ptr&lt; BoundTransform &gt; &gt; iceberg::UnboundTransform::Bind</definition>
        <argsstring>(const Schema &amp;schema, bool case_sensitive) const override</argsstring>
        <name>Bind</name>
        <qualifiedname>iceberg::UnboundTransform::Bind</qualifiedname>
        <reimplements refid="classiceberg_1_1Unbound_1a3af63f1670bd36266714c7cf3296fc83">Bind</reimplements>
        <param>
          <type>const <ref refid="classiceberg_1_1Schema" kindref="compound">Schema</ref> &amp;</type>
          <declname>schema</declname>
        </param>
        <param>
          <type>bool</type>
          <declname>case_sensitive</declname>
        </param>
        <briefdescription>
<para>Bind this expression to a concrete schema. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>schema</parametername>
</parameternamelist>
<parameterdescription>
<para>The schema to bind against </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>case_sensitive</parametername>
</parameternamelist>
<parameterdescription>
<para>Whether field name matching should be case sensitive </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A bound expression or an error if binding fails </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/expression/term.h" line="185" column="10" bodyfile="iceberg/expression/term.cc" bodystart="145" bodyend="151"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1UnboundTransform_1adf473df852c9482a59530fd14c26a136" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
        <type>std::shared_ptr&lt; <ref refid="classiceberg_1_1NamedReference" kindref="compound">NamedReference</ref> &gt;</type>
        <definition>std::shared_ptr&lt; NamedReference &gt; iceberg::UnboundTransform::reference</definition>
        <argsstring>() override</argsstring>
        <name>reference</name>
        <qualifiedname>iceberg::UnboundTransform::reference</qualifiedname>
        <reimplements refid="classiceberg_1_1Unbound_1aba4992824a9033d7fa4e1c75bb2ed854">reference</reimplements>
        <briefdescription>
<para>Returns the underlying named reference for this unbound term. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/expression/term.h" line="188" column="19" bodyfile="iceberg/expression/term.h" bodystart="188" bodyend="188"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1UnboundTransform_1acd098a804670ca0ebe00c29948b91a51" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>const std::shared_ptr&lt; <ref refid="classiceberg_1_1Transform" kindref="compound">Transform</ref> &gt; &amp;</type>
        <definition>const std::shared_ptr&lt; Transform &gt; &amp; iceberg::UnboundTransform::transform</definition>
        <argsstring>() const</argsstring>
        <name>transform</name>
        <qualifiedname>iceberg::UnboundTransform::transform</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/expression/term.h" line="190" column="25" bodyfile="iceberg/expression/term.h" bodystart="190" bodyend="190"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1UnboundTransform_1a3f0a01c4063aa0b1bd544855de4f2350" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
        <type>Kind</type>
        <definition>Kind iceberg::UnboundTransform::kind</definition>
        <argsstring>() const override</argsstring>
        <name>kind</name>
        <qualifiedname>iceberg::UnboundTransform::kind</qualifiedname>
        <reimplements refid="classiceberg_1_1Term_1abc8368a414f930269b883a090869eb14">kind</reimplements>
        <briefdescription>
<para>Returns the kind of this term. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/expression/term.h" line="192" column="8" bodyfile="iceberg/expression/term.h" bodystart="192" bodyend="192"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="private-func">
      <memberdef kind="function" id="classiceberg_1_1UnboundTransform_1abcec092747f5945b643998f68ac93d08" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>iceberg::UnboundTransform::UnboundTransform</definition>
        <argsstring>(std::shared_ptr&lt; NamedReference &gt; ref, std::shared_ptr&lt; Transform &gt; transform)</argsstring>
        <name>UnboundTransform</name>
        <qualifiedname>iceberg::UnboundTransform::UnboundTransform</qualifiedname>
        <param>
          <type>std::shared_ptr&lt; <ref refid="classiceberg_1_1NamedReference" kindref="compound">NamedReference</ref> &gt;</type>
          <declname>ref</declname>
        </param>
        <param>
          <type>std::shared_ptr&lt; <ref refid="classiceberg_1_1Transform" kindref="compound">Transform</ref> &gt;</type>
          <declname>transform</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/expression/term.h" line="195" column="3" bodyfile="iceberg/expression/term.cc" bodystart="132" bodyend="137"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
<para>An unbound transform expression. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="2">
        <label>iceberg::UnboundTerm&lt; class BoundTransform &gt;</label>
        <link refid="classiceberg_1_1UnboundTerm"/>
        <childnode refid="3" relation="public-inheritance">
        </childnode>
        <childnode refid="4" relation="public-inheritance">
        </childnode>
      </node>
      <node id="4">
        <label>iceberg::Term</label>
        <link refid="classiceberg_1_1Term"/>
        <childnode refid="5" relation="public-inheritance">
        </childnode>
      </node>
      <node id="3">
        <label>iceberg::Unbound&lt; B &gt;</label>
        <link refid="classiceberg_1_1Unbound"/>
      </node>
      <node id="1">
        <label>iceberg::UnboundTransform</label>
        <link refid="classiceberg_1_1UnboundTransform"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
      <node id="5">
        <label>iceberg::util::Formattable</label>
        <link refid="classiceberg_1_1util_1_1Formattable"/>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="2">
        <label>iceberg::UnboundTerm&lt; class BoundTransform &gt;</label>
        <link refid="classiceberg_1_1UnboundTerm"/>
        <childnode refid="3" relation="public-inheritance">
        </childnode>
        <childnode refid="4" relation="public-inheritance">
        </childnode>
      </node>
      <node id="4">
        <label>iceberg::Term</label>
        <link refid="classiceberg_1_1Term"/>
        <childnode refid="5" relation="public-inheritance">
        </childnode>
      </node>
      <node id="3">
        <label>iceberg::Unbound&lt; B &gt;</label>
        <link refid="classiceberg_1_1Unbound"/>
      </node>
      <node id="1">
        <label>iceberg::UnboundTransform</label>
        <link refid="classiceberg_1_1UnboundTransform"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
      <node id="5">
        <label>iceberg::util::Formattable</label>
        <link refid="classiceberg_1_1util_1_1Formattable"/>
      </node>
    </collaborationgraph>
    <location file="iceberg/expression/term.h" line="172" column="1" bodyfile="iceberg/expression/term.h" bodystart="172" bodyend="200"/>
    <listofallmembers>
      <member refid="classiceberg_1_1UnboundTransform_1aa6559c7e9a4b4c46cf58730d467327b2" prot="public" virt="virtual"><scope>iceberg::UnboundTransform</scope><name>Bind</name></member>
      <member refid="classiceberg_1_1Unbound_1a032a320b067d50a56cfe7e5e6ed986e9" prot="public" virt="non-virtual" ambiguityscope="UnboundTerm&lt; class BoundTransform &gt;::"><scope>iceberg::UnboundTransform</scope><name>Bind</name></member>
      <member refid="classiceberg_1_1UnboundTerm_1a452fa3a99827b436edc28beb681e89bd" prot="public" virt="non-virtual"><scope>iceberg::UnboundTransform</scope><name>BoundType</name></member>
      <member refid="classiceberg_1_1UnboundTerm_1a7c94829ddcc3940ea31b8dd8b5008fdc" prot="public" virt="virtual"><scope>iceberg::UnboundTransform</scope><name>is_unbound</name></member>
      <member refid="classiceberg_1_1UnboundTransform_1a3f0a01c4063aa0b1bd544855de4f2350" prot="public" virt="virtual"><scope>iceberg::UnboundTransform</scope><name>kind</name></member>
      <member refid="classiceberg_1_1Term_1aafdab7cb8b14117f662d394450af6be8" prot="public" virt="non-virtual"><scope>iceberg::UnboundTransform</scope><name>Kind</name></member>
      <member refid="classiceberg_1_1UnboundTransform_1a6310481c32ff955e0aba82369a23e604" prot="public" virt="non-virtual"><scope>iceberg::UnboundTransform</scope><name>Make</name></member>
      <member refid="classiceberg_1_1UnboundTransform_1aa7d3feaeb690d2df1261d319f6ade410" prot="private" virt="non-virtual"><scope>iceberg::UnboundTransform</scope><name>ref_</name></member>
      <member refid="classiceberg_1_1UnboundTransform_1adf473df852c9482a59530fd14c26a136" prot="public" virt="virtual"><scope>iceberg::UnboundTransform</scope><name>reference</name></member>
      <member refid="classiceberg_1_1UnboundTransform_1aac2547c880112427e20259f84d4f2d80" prot="public" virt="virtual"><scope>iceberg::UnboundTransform</scope><name>ToString</name></member>
      <member refid="classiceberg_1_1UnboundTransform_1acd098a804670ca0ebe00c29948b91a51" prot="public" virt="non-virtual"><scope>iceberg::UnboundTransform</scope><name>transform</name></member>
      <member refid="classiceberg_1_1UnboundTransform_1af43cd60fe1725352ae67f7a2121c8a38" prot="private" virt="non-virtual"><scope>iceberg::UnboundTransform</scope><name>transform_</name></member>
      <member refid="classiceberg_1_1UnboundTransform_1abcec092747f5945b643998f68ac93d08" prot="private" virt="non-virtual"><scope>iceberg::UnboundTransform</scope><name>UnboundTransform</name></member>
      <member refid="classiceberg_1_1util_1_1Formattable_1acfe29264450018bab0ceab0828cf46f9" prot="public" virt="virtual"><scope>iceberg::UnboundTransform</scope><name>~Formattable</name></member>
      <member refid="classiceberg_1_1UnboundTransform_1ad6baa8b473f154daca991c84a0aaf89c" prot="public" virt="non-virtual"><scope>iceberg::UnboundTransform</scope><name>~UnboundTransform</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>