http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_table.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_table.html b/docs/cpp/classarrow_1_1_table.html index 47b7a76..129ebc6 100644 --- a/docs/cpp/classarrow_1_1_table.html +++ b/docs/cpp/classarrow_1_1_table.html @@ -72,25 +72,28 @@ $(function() { </div><!--header--> <div class="contents"> +<p>Logical table as sequence of chunked arrays. + <a href="classarrow_1_1_table.html#details">More...</a></p> + <p><code>#include <<a class="el" href="table_8h_source.html">table.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a828a8f304ad397548b5ea60070e914e5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_table.html#a828a8f304ad397548b5ea60070e914e5">Table</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="classarrow_1_1_table.html#a8d8626acf4d00e2ac439c4f1cc7a054a">schema</a>, const std::vector< std::shared_ptr< <a class="el" href="classarrow_1_1_column.html">Column</a> >> &columns, int64_t <a class="el" href="classarrow_1_1_table.html#a14665d44a57c45343b54c7997d5c92e5">num_rows</a>=-1)</td></tr> -<tr class="memdesc:a828a8f304ad397548b5ea60070e914e5"><td class="mdescLeft"> </td><td class="mdescRight">Construct <a class="el" href="classarrow_1_1_table.html">Table</a> from schema and columns If columns is zero-length, the table's number of rows is zero. <a href="#a828a8f304ad397548b5ea60070e914e5">More...</a><br /></td></tr> +<tr class="memdesc:a828a8f304ad397548b5ea60070e914e5"><td class="mdescLeft"> </td><td class="mdescRight">Construct <a class="el" href="classarrow_1_1_table.html" title="Logical table as sequence of chunked arrays. ">Table</a> from schema and columns If columns is zero-length, the table's number of rows is zero. <a href="#a828a8f304ad397548b5ea60070e914e5">More...</a><br /></td></tr> <tr class="separator:a828a8f304ad397548b5ea60070e914e5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afc844e257095979c1b5c3843d16e5912"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_table.html#afc844e257095979c1b5c3843d16e5912">Table</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="classarrow_1_1_table.html#a8d8626acf4d00e2ac439c4f1cc7a054a">schema</a>, const std::vector< std::shared_ptr< <a class="el" href="classarrow_1_1_array.html">Array</a> >> &arrays, int64_t <a class="el" href="classarrow_1_1_table.html#a14665d44a57c45343b54c7997d5c92e5">num_rows</a>=-1)</td></tr> -<tr class="memdesc:afc844e257095979c1b5c3843d16e5912"><td class="mdescLeft"> </td><td class="mdescRight">Construct <a class="el" href="classarrow_1_1_table.html">Table</a> from schema and arrays. <a href="#afc844e257095979c1b5c3843d16e5912">More...</a><br /></td></tr> +<tr class="memdesc:afc844e257095979c1b5c3843d16e5912"><td class="mdescLeft"> </td><td class="mdescRight">Construct <a class="el" href="classarrow_1_1_table.html" title="Logical table as sequence of chunked arrays. ">Table</a> from schema and arrays. <a href="#afc844e257095979c1b5c3843d16e5912">More...</a><br /></td></tr> <tr class="separator:afc844e257095979c1b5c3843d16e5912"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8d8626acf4d00e2ac439c4f1cc7a054a"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_table.html#a8d8626acf4d00e2ac439c4f1cc7a054a">schema</a> () const</td></tr> <tr class="separator:a8d8626acf4d00e2ac439c4f1cc7a054a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa3a89f8fc24bfbb8805f46908fb13bb6"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_column.html">Column</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_table.html#aa3a89f8fc24bfbb8805f46908fb13bb6">column</a> (int i) const</td></tr> <tr class="separator:aa3a89f8fc24bfbb8805f46908fb13bb6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a95286e58ddd506b8be041b9c5ce55097"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_table.html#a95286e58ddd506b8be041b9c5ce55097">RemoveColumn</a> (int i, std::shared_ptr< <a class="el" href="classarrow_1_1_table.html">Table</a> > *out) const</td></tr> -<tr class="memdesc:a95286e58ddd506b8be041b9c5ce55097"><td class="mdescLeft"> </td><td class="mdescRight">Remove column from the table, producing a new <a class="el" href="classarrow_1_1_table.html">Table</a> (because tables and schemas are immutable) <a href="#a95286e58ddd506b8be041b9c5ce55097">More...</a><br /></td></tr> +<tr class="memdesc:a95286e58ddd506b8be041b9c5ce55097"><td class="mdescLeft"> </td><td class="mdescRight">Remove column from the table, producing a new <a class="el" href="classarrow_1_1_table.html" title="Logical table as sequence of chunked arrays. ">Table</a>. <a href="#a95286e58ddd506b8be041b9c5ce55097">More...</a><br /></td></tr> <tr class="separator:a95286e58ddd506b8be041b9c5ce55097"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a93d3e6b24cd468322de8c48bc0746dd8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_table.html#a93d3e6b24cd468322de8c48bc0746dd8">AddColumn</a> (int i, const std::shared_ptr< <a class="el" href="classarrow_1_1_column.html">Column</a> > &<a class="el" href="classarrow_1_1_table.html#aa3a89f8fc24bfbb8805f46908fb13bb6">column</a>, std::shared_ptr< <a class="el" href="classarrow_1_1_table.html">Table</a> > *out) const</td></tr> -<tr class="memdesc:a93d3e6b24cd468322de8c48bc0746dd8"><td class="mdescLeft"> </td><td class="mdescRight">Add column to the table, producing a new <a class="el" href="classarrow_1_1_table.html">Table</a>. <a href="#a93d3e6b24cd468322de8c48bc0746dd8">More...</a><br /></td></tr> +<tr class="memdesc:a93d3e6b24cd468322de8c48bc0746dd8"><td class="mdescLeft"> </td><td class="mdescRight">Add column to the table, producing a new <a class="el" href="classarrow_1_1_table.html" title="Logical table as sequence of chunked arrays. ">Table</a>. <a href="#a93d3e6b24cd468322de8c48bc0746dd8">More...</a><br /></td></tr> <tr class="separator:a93d3e6b24cd468322de8c48bc0746dd8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a62a28e0d6ece807e183af949b8ddd4f9"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_table.html">Table</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_table.html#a62a28e0d6ece807e183af949b8ddd4f9">ReplaceSchemaMetadata</a> (const std::shared_ptr< const <a class="el" href="classarrow_1_1_key_value_metadata.html">KeyValueMetadata</a> > &metadata) const</td></tr> <tr class="memdesc:a62a28e0d6ece807e183af949b8ddd4f9"><td class="mdescLeft"> </td><td class="mdescRight">Replace schema key-value metadata with new metadata (EXPERIMENTAL) <a href="#a62a28e0d6ece807e183af949b8ddd4f9">More...</a><br /></td></tr> @@ -100,16 +103,23 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a14665d44a57c45343b54c7997d5c92e5"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_table.html#a14665d44a57c45343b54c7997d5c92e5">num_rows</a> () const</td></tr> <tr class="separator:a14665d44a57c45343b54c7997d5c92e5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a88daefc3dd59b28fc23372db55b67378"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_table.html#a88daefc3dd59b28fc23372db55b67378">Equals</a> (const <a class="el" href="classarrow_1_1_table.html">Table</a> &other) const</td></tr> +<tr class="memdesc:a88daefc3dd59b28fc23372db55b67378"><td class="mdescLeft"> </td><td class="mdescRight">Determine if semantic contents of tables are exactly equal. <a href="#a88daefc3dd59b28fc23372db55b67378">More...</a><br /></td></tr> <tr class="separator:a88daefc3dd59b28fc23372db55b67378"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abecfd7d9ec9b470d65056cfb45ac3f31"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_table.html#abecfd7d9ec9b470d65056cfb45ac3f31">ValidateColumns</a> () const</td></tr> +<tr class="memdesc:abecfd7d9ec9b470d65056cfb45ac3f31"><td class="mdescLeft"> </td><td class="mdescRight">Perform any checks to validate the input arguments. <a href="#abecfd7d9ec9b470d65056cfb45ac3f31">More...</a><br /></td></tr> <tr class="separator:abecfd7d9ec9b470d65056cfb45ac3f31"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a04de0e0ddb470b0589163f93f1c5324c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_table.html#a04de0e0ddb470b0589163f93f1c5324c">IsChunked</a> () const</td></tr> +<tr class="memdesc:a04de0e0ddb470b0589163f93f1c5324c"><td class="mdescLeft"> </td><td class="mdescRight">Return true if any column has multiple chunks. <a href="#a04de0e0ddb470b0589163f93f1c5324c">More...</a><br /></td></tr> +<tr class="separator:a04de0e0ddb470b0589163f93f1c5324c"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:aec5f16e5671977e0d948d0e0865935fe"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_table.html#aec5f16e5671977e0d948d0e0865935fe">FromRecordBatches</a> (const std::vector< std::shared_ptr< <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> >> &batches, std::shared_ptr< <a class="el" href="classarrow_1_1_table.html">Table</a> > *table)</td></tr> <tr class="separator:aec5f16e5671977e0d948d0e0865935fe"><td class="memSeparator" colspan="2"> </td></tr> </table> -<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Logical table as sequence of chunked arrays. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a828a8f304ad397548b5ea60070e914e5"></a> <h2 class="memtitle"><span class="permalink"><a href="#a828a8f304ad397548b5ea60070e914e5">◆ </a></span>Table() <span class="overload">[1/2]</span></h2> @@ -142,12 +152,12 @@ Static Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Construct <a class="el" href="classarrow_1_1_table.html">Table</a> from schema and columns If columns is zero-length, the table's number of rows is zero. </p> +<p>Construct <a class="el" href="classarrow_1_1_table.html" title="Logical table as sequence of chunked arrays. ">Table</a> from schema and columns If columns is zero-length, the table's number of rows is zero. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">schema</td><td></td></tr> <tr><td class="paramname">columns</td><td></td></tr> - <tr><td class="paramname">num_rows</td><td>number of rows in table, -1 (default) to infer from columns </td></tr> + <tr><td class="paramname">number</td><td>of rows in table, -1 (default) to infer from columns </td></tr> </table> </dd> </dl> @@ -186,12 +196,12 @@ Static Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Construct <a class="el" href="classarrow_1_1_table.html">Table</a> from schema and arrays. </p> +<p>Construct <a class="el" href="classarrow_1_1_table.html" title="Logical table as sequence of chunked arrays. ">Table</a> from schema and arrays. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">schema</td><td></td></tr> <tr><td class="paramname">arrays</td><td></td></tr> - <tr><td class="paramname">num_rows</td><td>number of rows in table, -1 (default) to infer from columns </td></tr> + <tr><td class="paramname">number</td><td>of rows in table, -1 (default) to infer from columns </td></tr> </table> </dd> </dl> @@ -231,7 +241,7 @@ Static Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Add column to the table, producing a new <a class="el" href="classarrow_1_1_table.html">Table</a>. </p> +<p>Add column to the table, producing a new <a class="el" href="classarrow_1_1_table.html" title="Logical table as sequence of chunked arrays. ">Table</a>. </p> </div> </div> @@ -258,6 +268,12 @@ Static Public Member Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname"></td><td></td></tr> + </table> + </dd> +</dl> </div> </div> @@ -277,6 +293,8 @@ Static Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Determine if semantic contents of tables are exactly equal. </p> + </div> </div> <a id="aec5f16e5671977e0d948d0e0865935fe"></a> @@ -315,6 +333,25 @@ Static Public Member Functions</h2></td></tr> </div> </div> +<a id="a04de0e0ddb470b0589163f93f1c5324c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a04de0e0ddb470b0589163f93f1c5324c">◆ </a></span>IsChunked()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool arrow::Table::IsChunked </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Return true if any column has multiple chunks. </p> + +</div> +</div> <a id="abe71e003123973cdff9cfca40dc85e04"></a> <h2 class="memtitle"><span class="permalink"><a href="#abe71e003123973cdff9cfca40dc85e04">◆ </a></span>num_columns()</h2> @@ -337,6 +374,7 @@ Static Public Member Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>the number of columns in the table </dd></dl> </div> </div> @@ -362,6 +400,7 @@ Static Public Member Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>the number of rows (the corresponding length of each column) </dd></dl> </div> </div> @@ -391,7 +430,7 @@ Static Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Remove column from the table, producing a new <a class="el" href="classarrow_1_1_table.html">Table</a> (because tables and schemas are immutable) </p> +<p>Remove column from the table, producing a new <a class="el" href="classarrow_1_1_table.html" title="Logical table as sequence of chunked arrays. ">Table</a>. </p> </div> </div> @@ -419,7 +458,7 @@ Static Public Member Functions</h2></td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>new <a class="el" href="classarrow_1_1_table.html">Table</a> </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>new <a class="el" href="classarrow_1_1_table.html" title="Logical table as sequence of chunked arrays. ">Table</a> </dd></dl> </div> </div> @@ -445,6 +484,7 @@ Static Public Member Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>the table's schema </dd></dl> </div> </div> @@ -463,6 +503,8 @@ Static Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> +<p>Perform any checks to validate the input arguments. </p> + </div> </div> <hr/>The documentation for this class was generated from the following file:<ul>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_table_batch_reader-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_table_batch_reader-members.html b/docs/cpp/classarrow_1_1_table_batch_reader-members.html new file mode 100644 index 0000000..6b8e178 --- /dev/null +++ b/docs/cpp/classarrow_1_1_table_batch_reader-members.html @@ -0,0 +1,87 @@ +<!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"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): Member List</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacearrow.html">arrow</a></li><li class="navelem"><a class="el" href="classarrow_1_1_table_batch_reader.html">TableBatchReader</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">arrow::TableBatchReader Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classarrow_1_1_table_batch_reader.html">arrow::TableBatchReader</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_table_batch_reader.html#a31d001eabe7404ee8e3d7a568eae0e93">ReadNext</a>(std::shared_ptr< RecordBatch > *out) override</td><td class="entry"><a class="el" href="classarrow_1_1_table_batch_reader.html">arrow::TableBatchReader</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html#a8ac4623435d60509ac5a5ec22c98d59b">ReadNextRecordBatch</a>(std::shared_ptr< RecordBatch > *batch)</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html">arrow::RecordBatchReader</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_table_batch_reader.html#a278674b3b9a78fdbccc3f3d52fc5d470">schema</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1_table_batch_reader.html">arrow::TableBatchReader</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_table_batch_reader.html#a4ae1034b4c522d66da02ac1e17f30195">TableBatchReader</a>(const Table &table)</td><td class="entry"><a class="el" href="classarrow_1_1_table_batch_reader.html">arrow::TableBatchReader</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html#ad8660ce224397979fbf0da8898e55047">~RecordBatchReader</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html">arrow::RecordBatchReader</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_table_batch_reader.html#af0cf3eb2cb25fb87e367a3e5af5e367f">~TableBatchReader</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_table_batch_reader.html">arrow::TableBatchReader</a></td><td class="entry"></td></tr> +</table></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.13 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_table_batch_reader.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_table_batch_reader.html b/docs/cpp/classarrow_1_1_table_batch_reader.html new file mode 100644 index 0000000..38a95ce --- /dev/null +++ b/docs/cpp/classarrow_1_1_table_batch_reader.html @@ -0,0 +1,231 @@ +<!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"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): arrow::TableBatchReader Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacearrow.html">arrow</a></li><li class="navelem"><a class="el" href="classarrow_1_1_table_batch_reader.html">TableBatchReader</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classarrow_1_1_table_batch_reader-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">arrow::TableBatchReader Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Compute a sequence of record batches from a (possibly chunked) <a class="el" href="classarrow_1_1_table.html" title="Logical table as sequence of chunked arrays. ">Table</a>. + <a href="classarrow_1_1_table_batch_reader.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="table_8h_source.html">table.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for arrow::TableBatchReader:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarrow_1_1_table_batch_reader.png" usemap="#arrow::TableBatchReader_map" alt=""/> + <map id="arrow::TableBatchReader_map" name="arrow::TableBatchReader_map"> +<area href="classarrow_1_1_record_batch_reader.html" title="Abstract interface for reading stream of record batches. " alt="arrow::RecordBatchReader" shape="rect" coords="0,0,165,24"/> +</map> + </div></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:af0cf3eb2cb25fb87e367a3e5af5e367f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_table_batch_reader.html#af0cf3eb2cb25fb87e367a3e5af5e367f">~TableBatchReader</a> ()</td></tr> +<tr class="separator:af0cf3eb2cb25fb87e367a3e5af5e367f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4ae1034b4c522d66da02ac1e17f30195"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_table_batch_reader.html#a4ae1034b4c522d66da02ac1e17f30195">TableBatchReader</a> (const <a class="el" href="classarrow_1_1_table.html">Table</a> &table)</td></tr> +<tr class="memdesc:a4ae1034b4c522d66da02ac1e17f30195"><td class="mdescLeft"> </td><td class="mdescRight">Read batches with the maximum possible size. <a href="#a4ae1034b4c522d66da02ac1e17f30195">More...</a><br /></td></tr> +<tr class="separator:a4ae1034b4c522d66da02ac1e17f30195"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a278674b3b9a78fdbccc3f3d52fc5d470"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_table_batch_reader.html#a278674b3b9a78fdbccc3f3d52fc5d470">schema</a> () const override</td></tr> +<tr class="separator:a278674b3b9a78fdbccc3f3d52fc5d470"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a31d001eabe7404ee8e3d7a568eae0e93"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_table_batch_reader.html#a31d001eabe7404ee8e3d7a568eae0e93">ReadNext</a> (std::shared_ptr< <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> > *out) override</td></tr> +<tr class="memdesc:a31d001eabe7404ee8e3d7a568eae0e93"><td class="mdescLeft"> </td><td class="mdescRight">Read the next record batch in the stream. <a href="#a31d001eabe7404ee8e3d7a568eae0e93">More...</a><br /></td></tr> +<tr class="separator:a31d001eabe7404ee8e3d7a568eae0e93"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_classarrow_1_1_record_batch_reader"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarrow_1_1_record_batch_reader')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarrow_1_1_record_batch_reader.html">arrow::RecordBatchReader</a></td></tr> +<tr class="memitem:ad8660ce224397979fbf0da8898e55047 inherit pub_methods_classarrow_1_1_record_batch_reader"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch_reader.html#ad8660ce224397979fbf0da8898e55047">~RecordBatchReader</a> ()</td></tr> +<tr class="separator:ad8660ce224397979fbf0da8898e55047 inherit pub_methods_classarrow_1_1_record_batch_reader"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8ac4623435d60509ac5a5ec22c98d59b inherit pub_methods_classarrow_1_1_record_batch_reader"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch_reader.html#a8ac4623435d60509ac5a5ec22c98d59b">ReadNextRecordBatch</a> (std::shared_ptr< <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> > *batch)</td></tr> +<tr class="separator:a8ac4623435d60509ac5a5ec22c98d59b inherit pub_methods_classarrow_1_1_record_batch_reader"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Compute a sequence of record batches from a (possibly chunked) <a class="el" href="classarrow_1_1_table.html" title="Logical table as sequence of chunked arrays. ">Table</a>. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="af0cf3eb2cb25fb87e367a3e5af5e367f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af0cf3eb2cb25fb87e367a3e5af5e367f">◆ </a></span>~TableBatchReader()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">arrow::TableBatchReader::~TableBatchReader </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a4ae1034b4c522d66da02ac1e17f30195"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4ae1034b4c522d66da02ac1e17f30195">◆ </a></span>TableBatchReader()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">arrow::TableBatchReader::TableBatchReader </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classarrow_1_1_table.html">Table</a> & </td> + <td class="paramname"><em>table</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">explicit</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Read batches with the maximum possible size. </p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a31d001eabe7404ee8e3d7a568eae0e93"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a31d001eabe7404ee8e3d7a568eae0e93">◆ </a></span>ReadNext()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::TableBatchReader::ReadNext </td> + <td>(</td> + <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> > * </td> + <td class="paramname"><em>batch</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Read the next record batch in the stream. </p> +<p>Return nullptr for batch when reaching end of stream</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname"></td><td></td></tr> + </table> + </dd> +</dl> + +<p>Implements <a class="el" href="classarrow_1_1_record_batch_reader.html#aaffe944df9d8a4c3e6592eb2f8f78f9f">arrow::RecordBatchReader</a>.</p> + +</div> +</div> +<a id="a278674b3b9a78fdbccc3f3d52fc5d470"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a278674b3b9a78fdbccc3f3d52fc5d470">◆ </a></span>schema()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::shared_ptr<<a class="el" href="classarrow_1_1_schema.html">Schema</a>> arrow::TableBatchReader::schema </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>the shared schema of the record batches in the stream </dd></dl> + +<p>Implements <a class="el" href="classarrow_1_1_record_batch_reader.html#ad2ded865a6720e61e4685cfd34ed377f">arrow::RecordBatchReader</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>/home/wesm/code/arrow/cpp/src/arrow/<a class="el" href="table_8h_source.html">table.h</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.13 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_table_batch_reader.png ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_table_batch_reader.png b/docs/cpp/classarrow_1_1_table_batch_reader.png new file mode 100644 index 0000000..9413aec Binary files /dev/null and b/docs/cpp/classarrow_1_1_table_batch_reader.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_time32_type-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_time32_type-members.html b/docs/cpp/classarrow_1_1_time32_type-members.html index 64864f8..da987ae 100644 --- a/docs/cpp/classarrow_1_1_time32_type-members.html +++ b/docs/cpp/classarrow_1_1_time32_type-members.html @@ -82,14 +82,15 @@ $(function() { <tr><td class="entry"><a class="el" href="classarrow_1_1_fixed_width_type.html#a3e2714cd3cd0c7487e4f801880bd4c94">GetBufferLayout</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1_fixed_width_type.html">arrow::FixedWidthType</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#a5ec6a1c93420c68e9c8065d4a56ad645">id</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#aa2704f1cfc50018d02e109b32f67e422">id_</a></td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#ac8920179a6c1e7f434c495d5ec4662f1">num_children</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_time32_type.html#ae400a2b7657ae72ff1f866cd6de30040">Time32Type</a>(TimeUnit::type unit=TimeUnit::MILLI)</td><td class="entry"><a class="el" href="classarrow_1_1_time32_type.html">arrow::Time32Type</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#aa785014004bad89d088a5d5d55c11c61">TimeType</a>(Type::type type_id, TimeUnit::type unit)</td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_time32_type.html#af48861ed2f03de2ab932f5b4c987f4a7">ToString</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1_time32_type.html">arrow::Time32Type</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time32_type.html#a50eac064fb66811bc23e030ac1db8ddb">type_id</a></td><td class="entry"><a class="el" href="classarrow_1_1_time32_type.html">arrow::Time32Type</a></td><td class="entry"><span class="mlabel">static</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#a25ebbb923ec7c54cdf0a58bdc9625c65">unit</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#a4969fc68a0db512dbd75255f2731dc59">unit_</a></td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#abb9105c8087a4b19f53c61ddf3188c48">~DataType</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time32_type.html#a7ad35f94f66f2e2f6c718328d0b1e928">name</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1_time32_type.html">arrow::Time32Type</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#ac8920179a6c1e7f434c495d5ec4662f1">num_children</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time32_type.html#ae400a2b7657ae72ff1f866cd6de30040">Time32Type</a>(TimeUnit::type unit=TimeUnit::MILLI)</td><td class="entry"><a class="el" href="classarrow_1_1_time32_type.html">arrow::Time32Type</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#aa785014004bad89d088a5d5d55c11c61">TimeType</a>(Type::type type_id, TimeUnit::type unit)</td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time32_type.html#af48861ed2f03de2ab932f5b4c987f4a7">ToString</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1_time32_type.html">arrow::Time32Type</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_time32_type.html#a50eac064fb66811bc23e030ac1db8ddb">type_id</a></td><td class="entry"><a class="el" href="classarrow_1_1_time32_type.html">arrow::Time32Type</a></td><td class="entry"><span class="mlabel">static</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#a25ebbb923ec7c54cdf0a58bdc9625c65">unit</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#a4969fc68a0db512dbd75255f2731dc59">unit_</a></td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#abb9105c8087a4b19f53c61ddf3188c48">~DataType</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> </table></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_time32_type.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_time32_type.html b/docs/cpp/classarrow_1_1_time32_type.html index 044f348..34ed3c5 100644 --- a/docs/cpp/classarrow_1_1_time32_type.html +++ b/docs/cpp/classarrow_1_1_time32_type.html @@ -100,7 +100,11 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a61fc8d367e2cea569534c23efcbc4608"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_time32_type.html#a61fc8d367e2cea569534c23efcbc4608">Accept</a> (<a class="el" href="classarrow_1_1_type_visitor.html">TypeVisitor</a> *visitor) const override</td></tr> <tr class="separator:a61fc8d367e2cea569534c23efcbc4608"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af48861ed2f03de2ab932f5b4c987f4a7"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_time32_type.html#af48861ed2f03de2ab932f5b4c987f4a7">ToString</a> () const override</td></tr> +<tr class="memdesc:af48861ed2f03de2ab932f5b4c987f4a7"><td class="mdescLeft"> </td><td class="mdescRight">A string representation of the type, including any children. <a href="#af48861ed2f03de2ab932f5b4c987f4a7">More...</a><br /></td></tr> <tr class="separator:af48861ed2f03de2ab932f5b4c987f4a7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7ad35f94f66f2e2f6c718328d0b1e928"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_time32_type.html#a7ad35f94f66f2e2f6c718328d0b1e928">name</a> () const override</td></tr> +<tr class="memdesc:a7ad35f94f66f2e2f6c718328d0b1e928"><td class="mdescLeft"> </td><td class="mdescRight">A string name of the type, omitting any child fields. <a href="#a7ad35f94f66f2e2f6c718328d0b1e928">More...</a><br /></td></tr> +<tr class="separator:a7ad35f94f66f2e2f6c718328d0b1e928"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classarrow_1_1_time_type"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarrow_1_1_time_type')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td></tr> <tr class="memitem:a25ebbb923ec7c54cdf0a58bdc9625c65 inherit pub_methods_classarrow_1_1_time_type"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarrow_1_1_time_unit.html#a561ef51c3755bd873f8f86f5bc4ec1ff">TimeUnit::type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_time_type.html#a25ebbb923ec7c54cdf0a58bdc9625c65">unit</a> () const</td></tr> <tr class="separator:a25ebbb923ec7c54cdf0a58bdc9625c65 inherit pub_methods_classarrow_1_1_time_type"><td class="memSeparator" colspan="2"> </td></tr> @@ -242,6 +246,37 @@ Additional Inherited Members</h2></td></tr> </div> </div> +<a id="a7ad35f94f66f2e2f6c718328d0b1e928"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7ad35f94f66f2e2f6c718328d0b1e928">◆ </a></span>name()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::string arrow::Time32Type::name </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>A string name of the type, omitting any child fields. </p> +<dl class="section note"><dt>Note</dt><dd>Experimental API </dd></dl> +<dl class="section since"><dt>Since</dt><dd>0.7.0 </dd></dl> + +<p>Implements <a class="el" href="classarrow_1_1_data_type.html#a94985d12273f5dd353d6142921299d4d">arrow::DataType</a>.</p> + +</div> +</div> <a id="af48861ed2f03de2ab932f5b4c987f4a7"></a> <h2 class="memtitle"><span class="permalink"><a href="#af48861ed2f03de2ab932f5b4c987f4a7">◆ </a></span>ToString()</h2> @@ -265,6 +300,8 @@ Additional Inherited Members</h2></td></tr> </table> </div><div class="memdoc"> +<p>A string representation of the type, including any children. </p> + <p>Implements <a class="el" href="classarrow_1_1_data_type.html#a944727354fb11138ebd46368319598f2">arrow::DataType</a>.</p> </div> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_time64_type-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_time64_type-members.html b/docs/cpp/classarrow_1_1_time64_type-members.html index 5a9801e..f2ce9a0 100644 --- a/docs/cpp/classarrow_1_1_time64_type-members.html +++ b/docs/cpp/classarrow_1_1_time64_type-members.html @@ -82,14 +82,15 @@ $(function() { <tr><td class="entry"><a class="el" href="classarrow_1_1_fixed_width_type.html#a3e2714cd3cd0c7487e4f801880bd4c94">GetBufferLayout</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1_fixed_width_type.html">arrow::FixedWidthType</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#a5ec6a1c93420c68e9c8065d4a56ad645">id</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#aa2704f1cfc50018d02e109b32f67e422">id_</a></td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#ac8920179a6c1e7f434c495d5ec4662f1">num_children</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_time64_type.html#a845e7899e9a5a0813ff5d96561d8a0aa">Time64Type</a>(TimeUnit::type unit=TimeUnit::MILLI)</td><td class="entry"><a class="el" href="classarrow_1_1_time64_type.html">arrow::Time64Type</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#aa785014004bad89d088a5d5d55c11c61">TimeType</a>(Type::type type_id, TimeUnit::type unit)</td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_time64_type.html#a8c985ae014e16d79323c0a8899851091">ToString</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1_time64_type.html">arrow::Time64Type</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time64_type.html#a9f349dbf2b5d3613f60052f1d5d4041e">type_id</a></td><td class="entry"><a class="el" href="classarrow_1_1_time64_type.html">arrow::Time64Type</a></td><td class="entry"><span class="mlabel">static</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#a25ebbb923ec7c54cdf0a58bdc9625c65">unit</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#a4969fc68a0db512dbd75255f2731dc59">unit_</a></td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#abb9105c8087a4b19f53c61ddf3188c48">~DataType</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time64_type.html#abba4ccc76c566ee3f61997f78660dd79">name</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1_time64_type.html">arrow::Time64Type</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#ac8920179a6c1e7f434c495d5ec4662f1">num_children</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time64_type.html#a845e7899e9a5a0813ff5d96561d8a0aa">Time64Type</a>(TimeUnit::type unit=TimeUnit::MILLI)</td><td class="entry"><a class="el" href="classarrow_1_1_time64_type.html">arrow::Time64Type</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#aa785014004bad89d088a5d5d55c11c61">TimeType</a>(Type::type type_id, TimeUnit::type unit)</td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time64_type.html#a8c985ae014e16d79323c0a8899851091">ToString</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1_time64_type.html">arrow::Time64Type</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_time64_type.html#a9f349dbf2b5d3613f60052f1d5d4041e">type_id</a></td><td class="entry"><a class="el" href="classarrow_1_1_time64_type.html">arrow::Time64Type</a></td><td class="entry"><span class="mlabel">static</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#a25ebbb923ec7c54cdf0a58bdc9625c65">unit</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#a4969fc68a0db512dbd75255f2731dc59">unit_</a></td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#abb9105c8087a4b19f53c61ddf3188c48">~DataType</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> </table></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_time64_type.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_time64_type.html b/docs/cpp/classarrow_1_1_time64_type.html index 9de91ae..8fd4e03 100644 --- a/docs/cpp/classarrow_1_1_time64_type.html +++ b/docs/cpp/classarrow_1_1_time64_type.html @@ -100,7 +100,11 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a13313d8d26d175080fd7b48beb6bdf2e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_time64_type.html#a13313d8d26d175080fd7b48beb6bdf2e">Accept</a> (<a class="el" href="classarrow_1_1_type_visitor.html">TypeVisitor</a> *visitor) const override</td></tr> <tr class="separator:a13313d8d26d175080fd7b48beb6bdf2e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8c985ae014e16d79323c0a8899851091"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_time64_type.html#a8c985ae014e16d79323c0a8899851091">ToString</a> () const override</td></tr> +<tr class="memdesc:a8c985ae014e16d79323c0a8899851091"><td class="mdescLeft"> </td><td class="mdescRight">A string representation of the type, including any children. <a href="#a8c985ae014e16d79323c0a8899851091">More...</a><br /></td></tr> <tr class="separator:a8c985ae014e16d79323c0a8899851091"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abba4ccc76c566ee3f61997f78660dd79"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_time64_type.html#abba4ccc76c566ee3f61997f78660dd79">name</a> () const override</td></tr> +<tr class="memdesc:abba4ccc76c566ee3f61997f78660dd79"><td class="mdescLeft"> </td><td class="mdescRight">A string name of the type, omitting any child fields. <a href="#abba4ccc76c566ee3f61997f78660dd79">More...</a><br /></td></tr> +<tr class="separator:abba4ccc76c566ee3f61997f78660dd79"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classarrow_1_1_time_type"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarrow_1_1_time_type')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td></tr> <tr class="memitem:a25ebbb923ec7c54cdf0a58bdc9625c65 inherit pub_methods_classarrow_1_1_time_type"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarrow_1_1_time_unit.html#a561ef51c3755bd873f8f86f5bc4ec1ff">TimeUnit::type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_time_type.html#a25ebbb923ec7c54cdf0a58bdc9625c65">unit</a> () const</td></tr> <tr class="separator:a25ebbb923ec7c54cdf0a58bdc9625c65 inherit pub_methods_classarrow_1_1_time_type"><td class="memSeparator" colspan="2"> </td></tr> @@ -242,6 +246,37 @@ Additional Inherited Members</h2></td></tr> </div> </div> +<a id="abba4ccc76c566ee3f61997f78660dd79"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abba4ccc76c566ee3f61997f78660dd79">◆ </a></span>name()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::string arrow::Time64Type::name </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>A string name of the type, omitting any child fields. </p> +<dl class="section note"><dt>Note</dt><dd>Experimental API </dd></dl> +<dl class="section since"><dt>Since</dt><dd>0.7.0 </dd></dl> + +<p>Implements <a class="el" href="classarrow_1_1_data_type.html#a94985d12273f5dd353d6142921299d4d">arrow::DataType</a>.</p> + +</div> +</div> <a id="a8c985ae014e16d79323c0a8899851091"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8c985ae014e16d79323c0a8899851091">◆ </a></span>ToString()</h2> @@ -265,6 +300,8 @@ Additional Inherited Members</h2></td></tr> </table> </div><div class="memdoc"> +<p>A string representation of the type, including any children. </p> + <p>Implements <a class="el" href="classarrow_1_1_data_type.html#a944727354fb11138ebd46368319598f2">arrow::DataType</a>.</p> </div> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_time_type-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_time_type-members.html b/docs/cpp/classarrow_1_1_time_type-members.html index 5b1c294..09286ce 100644 --- a/docs/cpp/classarrow_1_1_time_type-members.html +++ b/docs/cpp/classarrow_1_1_time_type-members.html @@ -81,12 +81,13 @@ $(function() { <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_fixed_width_type.html#a3e2714cd3cd0c7487e4f801880bd4c94">GetBufferLayout</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1_fixed_width_type.html">arrow::FixedWidthType</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#a5ec6a1c93420c68e9c8065d4a56ad645">id</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#aa2704f1cfc50018d02e109b32f67e422">id_</a></td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#ac8920179a6c1e7f434c495d5ec4662f1">num_children</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#aa785014004bad89d088a5d5d55c11c61">TimeType</a>(Type::type type_id, TimeUnit::type unit)</td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#a944727354fb11138ebd46368319598f2">ToString</a>() const =0</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#a25ebbb923ec7c54cdf0a58bdc9625c65">unit</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#a4969fc68a0db512dbd75255f2731dc59">unit_</a></td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#abb9105c8087a4b19f53c61ddf3188c48">~DataType</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#a94985d12273f5dd353d6142921299d4d">name</a>() const =0</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#ac8920179a6c1e7f434c495d5ec4662f1">num_children</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#aa785014004bad89d088a5d5d55c11c61">TimeType</a>(Type::type type_id, TimeUnit::type unit)</td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#a944727354fb11138ebd46368319598f2">ToString</a>() const =0</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#a25ebbb923ec7c54cdf0a58bdc9625c65">unit</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_time_type.html#a4969fc68a0db512dbd75255f2731dc59">unit_</a></td><td class="entry"><a class="el" href="classarrow_1_1_time_type.html">arrow::TimeType</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#abb9105c8087a4b19f53c61ddf3188c48">~DataType</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> </table></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_time_type.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_time_type.html b/docs/cpp/classarrow_1_1_time_type.html index ac741fa..60a2825 100644 --- a/docs/cpp/classarrow_1_1_time_type.html +++ b/docs/cpp/classarrow_1_1_time_type.html @@ -114,7 +114,11 @@ Public Member Functions</h2></td></tr> <tr class="memitem:adb306e4a8a597a0ff017f4358942130d inherit pub_methods_classarrow_1_1_data_type"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_data_type.html#adb306e4a8a597a0ff017f4358942130d">Accept</a> (<a class="el" href="classarrow_1_1_type_visitor.html">TypeVisitor</a> *visitor) const =0</td></tr> <tr class="separator:adb306e4a8a597a0ff017f4358942130d inherit pub_methods_classarrow_1_1_data_type"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a944727354fb11138ebd46368319598f2 inherit pub_methods_classarrow_1_1_data_type"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_data_type.html#a944727354fb11138ebd46368319598f2">ToString</a> () const =0</td></tr> +<tr class="memdesc:a944727354fb11138ebd46368319598f2 inherit pub_methods_classarrow_1_1_data_type"><td class="mdescLeft"> </td><td class="mdescRight">A string representation of the type, including any children. <a href="classarrow_1_1_data_type.html#a944727354fb11138ebd46368319598f2">More...</a><br /></td></tr> <tr class="separator:a944727354fb11138ebd46368319598f2 inherit pub_methods_classarrow_1_1_data_type"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a94985d12273f5dd353d6142921299d4d inherit pub_methods_classarrow_1_1_data_type"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_data_type.html#a94985d12273f5dd353d6142921299d4d">name</a> () const =0</td></tr> +<tr class="memdesc:a94985d12273f5dd353d6142921299d4d inherit pub_methods_classarrow_1_1_data_type"><td class="mdescLeft"> </td><td class="mdescRight">A string name of the type, omitting any child fields. <a href="classarrow_1_1_data_type.html#a94985d12273f5dd353d6142921299d4d">More...</a><br /></td></tr> +<tr class="separator:a94985d12273f5dd353d6142921299d4d inherit pub_methods_classarrow_1_1_data_type"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5ec6a1c93420c68e9c8065d4a56ad645 inherit pub_methods_classarrow_1_1_data_type"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarrow_1_1_type.html#a00a041cb19a3be373da8eec7d4bf1f44">Type::type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_data_type.html#a5ec6a1c93420c68e9c8065d4a56ad645">id</a> () const</td></tr> <tr class="separator:a5ec6a1c93420c68e9c8065d4a56ad645 inherit pub_methods_classarrow_1_1_data_type"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_timestamp_type-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_timestamp_type-members.html b/docs/cpp/classarrow_1_1_timestamp_type-members.html index 4fcb825..81b520f 100644 --- a/docs/cpp/classarrow_1_1_timestamp_type-members.html +++ b/docs/cpp/classarrow_1_1_timestamp_type-members.html @@ -82,15 +82,15 @@ $(function() { <tr><td class="entry"><a class="el" href="classarrow_1_1_fixed_width_type.html#a3e2714cd3cd0c7487e4f801880bd4c94">GetBufferLayout</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1_fixed_width_type.html">arrow::FixedWidthType</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#a5ec6a1c93420c68e9c8065d4a56ad645">id</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#aa2704f1cfc50018d02e109b32f67e422">id_</a></td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html#a1dc8d8d6a9cc0797e9379e27ad84070e">name</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html">arrow::TimestampType</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html#acdca1b7fb9a7d6532dcbbfb6dee2172b">name</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html">arrow::TimestampType</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#ac8920179a6c1e7f434c495d5ec4662f1">num_children</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html#a88e0ba47b82571b3fc3798b6c099499b">TimestampType</a>(TimeUnit::type unit=TimeUnit::MILLI)</td><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html">arrow::TimestampType</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html#ad0be5cd4daf44dbbcecacfcdd6499a76">TimestampType</a>(TimeUnit::type unit, const std::string &timezone)</td><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html">arrow::TimestampType</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html#a1a603ac99c48a77cf8c09ba34a3102aa">timezone</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html">arrow::TimestampType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html#ae220b66f0778f17a26bb757e46a7e1a9">ToString</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html">arrow::TimestampType</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html#a21e64acc4074512b6f457692c4524738">type_id</a></td><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html">arrow::TimestampType</a></td><td class="entry"><span class="mlabel">static</span></td></tr> - <tr><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html#a895411d8d9ceffe0aa91d125aea7b429">Unit</a> typedef</td><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html">arrow::TimestampType</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html#a8785c01920871facc36e54f79fc53ade">unit</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html">arrow::TimestampType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html#a8785c01920871facc36e54f79fc53ade">unit</a>() const</td><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html">arrow::TimestampType</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html#a895411d8d9ceffe0aa91d125aea7b429">Unit</a> typedef</td><td class="entry"><a class="el" href="classarrow_1_1_timestamp_type.html">arrow::TimestampType</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classarrow_1_1_data_type.html#abb9105c8087a4b19f53c61ddf3188c48">~DataType</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_data_type.html">arrow::DataType</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> </table></div><!-- contents --> <!-- start footer part --> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1_timestamp_type.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_timestamp_type.html b/docs/cpp/classarrow_1_1_timestamp_type.html index ecfe188..37a2091 100644 --- a/docs/cpp/classarrow_1_1_timestamp_type.html +++ b/docs/cpp/classarrow_1_1_timestamp_type.html @@ -66,7 +66,6 @@ $(function() { <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | -<a href="#pub-static-methods">Static Public Member Functions</a> | <a href="#pub-static-attribs">Static Public Attributes</a> | <a href="classarrow_1_1_timestamp_type-members.html">List of all members</a> </div> <div class="headertitle"> @@ -104,7 +103,11 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a9a528987f6453a49187b613db115c437"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_timestamp_type.html#a9a528987f6453a49187b613db115c437">Accept</a> (<a class="el" href="classarrow_1_1_type_visitor.html">TypeVisitor</a> *visitor) const override</td></tr> <tr class="separator:a9a528987f6453a49187b613db115c437"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae220b66f0778f17a26bb757e46a7e1a9"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_timestamp_type.html#ae220b66f0778f17a26bb757e46a7e1a9">ToString</a> () const override</td></tr> +<tr class="memdesc:ae220b66f0778f17a26bb757e46a7e1a9"><td class="mdescLeft"> </td><td class="mdescRight">A string representation of the type, including any children. <a href="#ae220b66f0778f17a26bb757e46a7e1a9">More...</a><br /></td></tr> <tr class="separator:ae220b66f0778f17a26bb757e46a7e1a9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acdca1b7fb9a7d6532dcbbfb6dee2172b"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_timestamp_type.html#acdca1b7fb9a7d6532dcbbfb6dee2172b">name</a> () const override</td></tr> +<tr class="memdesc:acdca1b7fb9a7d6532dcbbfb6dee2172b"><td class="mdescLeft"> </td><td class="mdescRight">A string name of the type, omitting any child fields. <a href="#acdca1b7fb9a7d6532dcbbfb6dee2172b">More...</a><br /></td></tr> +<tr class="separator:acdca1b7fb9a7d6532dcbbfb6dee2172b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8785c01920871facc36e54f79fc53ade"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarrow_1_1_time_unit.html#a561ef51c3755bd873f8f86f5bc4ec1ff">TimeUnit::type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_timestamp_type.html#a8785c01920871facc36e54f79fc53ade">unit</a> () const</td></tr> <tr class="separator:a8785c01920871facc36e54f79fc53ade"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1a603ac99c48a77cf8c09ba34a3102aa"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_timestamp_type.html#a1a603ac99c48a77cf8c09ba34a3102aa">timezone</a> () const</td></tr> @@ -130,11 +133,6 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a5ec6a1c93420c68e9c8065d4a56ad645 inherit pub_methods_classarrow_1_1_data_type"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarrow_1_1_type.html#a00a041cb19a3be373da8eec7d4bf1f44">Type::type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_data_type.html#a5ec6a1c93420c68e9c8065d4a56ad645">id</a> () const</td></tr> <tr class="separator:a5ec6a1c93420c68e9c8065d4a56ad645 inherit pub_methods_classarrow_1_1_data_type"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> -Static Public Member Functions</h2></td></tr> -<tr class="memitem:a1dc8d8d6a9cc0797e9379e27ad84070e"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_timestamp_type.html#a1dc8d8d6a9cc0797e9379e27ad84070e">name</a> ()</td></tr> -<tr class="separator:a1dc8d8d6a9cc0797e9379e27ad84070e"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> Static Public Attributes</h2></td></tr> <tr class="memitem:a21e64acc4074512b6f457692c4524738"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="structarrow_1_1_type.html#a00a041cb19a3be373da8eec7d4bf1f44">Type::type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_timestamp_type.html#a21e64acc4074512b6f457692c4524738">type_id</a> = <a class="el" href="structarrow_1_1_type.html#a00a041cb19a3be373da8eec7d4bf1f44a1e41dddee4a6410c4d6fe164b36a230e">Type::TIMESTAMP</a></td></tr> @@ -296,8 +294,8 @@ Additional Inherited Members</h2></td></tr> </div> </div> -<a id="a1dc8d8d6a9cc0797e9379e27ad84070e"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a1dc8d8d6a9cc0797e9379e27ad84070e">◆ </a></span>name()</h2> +<a id="acdca1b7fb9a7d6532dcbbfb6dee2172b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#acdca1b7fb9a7d6532dcbbfb6dee2172b">◆ </a></span>name()</h2> <div class="memitem"> <div class="memproto"> @@ -306,19 +304,25 @@ Additional Inherited Members</h2></td></tr> <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">static std::string arrow::TimestampType::name </td> + <td class="memname">std::string arrow::TimestampType::name </td> <td>(</td> <td class="paramname"></td><td>)</td> - <td></td> + <td> const</td> </tr> </table> </td> <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> +<p>A string name of the type, omitting any child fields. </p> +<dl class="section note"><dt>Note</dt><dd>Experimental API </dd></dl> +<dl class="section since"><dt>Since</dt><dd>0.7.0 </dd></dl> + +<p>Implements <a class="el" href="classarrow_1_1_data_type.html#a94985d12273f5dd353d6142921299d4d">arrow::DataType</a>.</p> + </div> </div> <a id="a1a603ac99c48a77cf8c09ba34a3102aa"></a> @@ -369,6 +373,8 @@ Additional Inherited Members</h2></td></tr> </table> </div><div class="memdoc"> +<p>A string representation of the type, including any children. </p> + <p>Implements <a class="el" href="classarrow_1_1_data_type.html#a944727354fb11138ebd46368319598f2">arrow::DataType</a>.</p> </div>