api/xml/classiceberg_1_1BoundingBox.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_1BoundingBox" kind="class" language="C++" prot="public">
    <compoundname>iceberg::BoundingBox</compoundname>
    <includes refid="geospatial_8h" local="no">geospatial.h</includes>
    <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classiceberg_1_1BoundingBox_1ab27f29268a13ea2c36266919c2ef1714" prot="private" static="no" mutable="no">
        <type><ref refid="classiceberg_1_1GeospatialBound" kindref="compound">GeospatialBound</ref></type>
        <definition>GeospatialBound iceberg::BoundingBox::lower_</definition>
        <argsstring></argsstring>
        <name>lower_</name>
        <qualifiedname>iceberg::BoundingBox::lower_</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/geospatial.h" line="95" column="19" bodyfile="iceberg/geospatial.h" bodystart="95" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classiceberg_1_1BoundingBox_1a9ef18468d0db934f5e36c95dedac7792" prot="private" static="no" mutable="no">
        <type><ref refid="classiceberg_1_1GeospatialBound" kindref="compound">GeospatialBound</ref></type>
        <definition>GeospatialBound iceberg::BoundingBox::upper_</definition>
        <argsstring></argsstring>
        <name>upper_</name>
        <qualifiedname>iceberg::BoundingBox::upper_</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/geospatial.h" line="96" column="19" bodyfile="iceberg/geospatial.h" bodystart="96" bodyend="-1"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-func">
      <memberdef kind="function" id="classiceberg_1_1BoundingBox_1a8621ff04b5cfc64e0d4091954bdb2f99" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>iceberg::BoundingBox::BoundingBox</definition>
        <argsstring>(GeospatialBound lower, GeospatialBound upper)</argsstring>
        <name>BoundingBox</name>
        <qualifiedname>iceberg::BoundingBox::BoundingBox</qualifiedname>
        <param>
          <type><ref refid="classiceberg_1_1GeospatialBound" kindref="compound">GeospatialBound</ref></type>
          <declname>lower</declname>
        </param>
        <param>
          <type><ref refid="classiceberg_1_1GeospatialBound" kindref="compound">GeospatialBound</ref></type>
          <declname>upper</declname>
        </param>
        <briefdescription>
<para>Create a bounding box from lower and upper bounds. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/geospatial.h" line="77" column="3"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1BoundingBox_1a5eb284857183355b2c61d0131e294865" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>const <ref refid="classiceberg_1_1GeospatialBound" kindref="compound">GeospatialBound</ref> &amp;</type>
        <definition>const GeospatialBound &amp; iceberg::BoundingBox::lower</definition>
        <argsstring>() const</argsstring>
        <name>lower</name>
        <qualifiedname>iceberg::BoundingBox::lower</qualifiedname>
        <briefdescription>
<para>Return the lower bound. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/geospatial.h" line="80" column="25" bodyfile="iceberg/geospatial.h" bodystart="80" bodyend="80"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1BoundingBox_1a7d90f3b7e330e732d44e640235df4d9d" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>const <ref refid="classiceberg_1_1GeospatialBound" kindref="compound">GeospatialBound</ref> &amp;</type>
        <definition>const GeospatialBound &amp; iceberg::BoundingBox::upper</definition>
        <argsstring>() const</argsstring>
        <name>upper</name>
        <qualifiedname>iceberg::BoundingBox::upper</qualifiedname>
        <briefdescription>
<para>Return the upper bound. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/geospatial.h" line="82" column="25" bodyfile="iceberg/geospatial.h" bodystart="82" bodyend="82"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1BoundingBox_1ac802e313aec39e53218026c7987bd9aa" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
        <type>std::vector&lt; uint8_t &gt;</type>
        <definition>std::vector&lt; uint8_t &gt; iceberg::BoundingBox::Serialize</definition>
        <argsstring>() const</argsstring>
        <name>Serialize</name>
        <qualifiedname>iceberg::BoundingBox::Serialize</qualifiedname>
        <briefdescription>
<para>Encode this bounding box using Iceberg&apos;s combined encoding. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/geospatial.h" line="90" column="15"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-static-func">
      <memberdef kind="function" id="classiceberg_1_1BoundingBox_1a215a796d9b9b327e80af97da01919ae6" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="namespaceiceberg_1a9d5594e371beb516b0120e07e69d3af6" kindref="member">Result</ref>&lt; <ref refid="classiceberg_1_1BoundingBox" kindref="compound">BoundingBox</ref> &gt;</type>
        <definition>static Result&lt; BoundingBox &gt; iceberg::BoundingBox::Deserialize</definition>
        <argsstring>(std::span&lt; const uint8_t &gt; lower, std::span&lt; const uint8_t &gt; upper)</argsstring>
        <name>Deserialize</name>
        <qualifiedname>iceberg::BoundingBox::Deserialize</qualifiedname>
        <param>
          <type>std::span&lt; const uint8_t &gt;</type>
          <declname>lower</declname>
        </param>
        <param>
          <type>std::span&lt; const uint8_t &gt;</type>
          <declname>upper</declname>
        </param>
        <briefdescription>
<para>Decode a bounding box from separate lower and upper encodings. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/geospatial.h" line="85" column="17"/>
      </memberdef>
      <memberdef kind="function" id="classiceberg_1_1BoundingBox_1aabbe9ac86320de3540300c2bf0ad6ae8" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="namespaceiceberg_1a9d5594e371beb516b0120e07e69d3af6" kindref="member">Result</ref>&lt; <ref refid="classiceberg_1_1BoundingBox" kindref="compound">BoundingBox</ref> &gt;</type>
        <definition>static Result&lt; BoundingBox &gt; iceberg::BoundingBox::Deserialize</definition>
        <argsstring>(std::span&lt; const uint8_t &gt; bytes)</argsstring>
        <name>Deserialize</name>
        <qualifiedname>iceberg::BoundingBox::Deserialize</qualifiedname>
        <param>
          <type>std::span&lt; const uint8_t &gt;</type>
          <declname>bytes</declname>
        </param>
        <briefdescription>
<para>Decode a bounding box from Iceberg&apos;s combined encoding. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/geospatial.h" line="88" column="17"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="friend">
      <memberdef kind="friend" id="classiceberg_1_1BoundingBox_1a461a33e0b355811c3d03397fa2d98133" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>bool</type>
        <definition>bool operator==</definition>
        <argsstring>(const BoundingBox &amp;, const BoundingBox &amp;)=default</argsstring>
        <name>operator==</name>
        <qualifiedname>iceberg::BoundingBox::operator==</qualifiedname>
        <param>
          <type>const <ref refid="classiceberg_1_1BoundingBox" kindref="compound">BoundingBox</ref> &amp;</type>
        </param>
        <param>
          <type>const <ref refid="classiceberg_1_1BoundingBox" kindref="compound">BoundingBox</ref> &amp;</type>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="iceberg/geospatial.h" line="92" column="15"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
<para>A pair of lower and upper geospatial column bounds. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="iceberg/geospatial.h" line="74" column="1" bodyfile="iceberg/geospatial.h" bodystart="74" bodyend="97"/>
    <listofallmembers>
      <member refid="classiceberg_1_1BoundingBox_1a8621ff04b5cfc64e0d4091954bdb2f99" prot="public" virt="non-virtual"><scope>iceberg::BoundingBox</scope><name>BoundingBox</name></member>
      <member refid="classiceberg_1_1BoundingBox_1a215a796d9b9b327e80af97da01919ae6" prot="public" virt="non-virtual"><scope>iceberg::BoundingBox</scope><name>Deserialize</name></member>
      <member refid="classiceberg_1_1BoundingBox_1aabbe9ac86320de3540300c2bf0ad6ae8" prot="public" virt="non-virtual"><scope>iceberg::BoundingBox</scope><name>Deserialize</name></member>
      <member refid="classiceberg_1_1BoundingBox_1a5eb284857183355b2c61d0131e294865" prot="public" virt="non-virtual"><scope>iceberg::BoundingBox</scope><name>lower</name></member>
      <member refid="classiceberg_1_1BoundingBox_1ab27f29268a13ea2c36266919c2ef1714" prot="private" virt="non-virtual"><scope>iceberg::BoundingBox</scope><name>lower_</name></member>
      <member refid="classiceberg_1_1BoundingBox_1a461a33e0b355811c3d03397fa2d98133" prot="public" virt="non-virtual"><scope>iceberg::BoundingBox</scope><name>operator==</name></member>
      <member refid="classiceberg_1_1BoundingBox_1ac802e313aec39e53218026c7987bd9aa" prot="public" virt="non-virtual"><scope>iceberg::BoundingBox</scope><name>Serialize</name></member>
      <member refid="classiceberg_1_1BoundingBox_1a7d90f3b7e330e732d44e640235df4d9d" prot="public" virt="non-virtual"><scope>iceberg::BoundingBox</scope><name>upper</name></member>
      <member refid="classiceberg_1_1BoundingBox_1a9ef18468d0db934f5e36c95dedac7792" prot="private" virt="non-virtual"><scope>iceberg::BoundingBox</scope><name>upper_</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>