blob: 7e0300ded226c981ecbf98d7d8c509bf70043461 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Expression classes: Gandiva GLib Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Gandiva GLib Reference Manual">
<link rel="up" href="expression.html" title="Expression">
<link rel="prev" href="expression.html" title="Expression">
<link rel="next" href="filter.html" title="Filter">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#GGandivaCondition.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
<a href="#GGandivaCondition.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
<a href="#GGandivaCondition.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="expression.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="expression.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="filter.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GGandivaCondition"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GGandivaCondition.top_of_page"></a>Expression classes</span></h2>
<p>Expression classes</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GGandivaCondition.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GGandivaCondition.html#GGandivaExpression"><span class="returnvalue">GGandivaExpression</span></a> *
</td>
<td class="function_name">
<a class="link" href="GGandivaCondition.html#ggandiva-expression-new" title="ggandiva_expression_new ()">ggandiva_expression_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GGandivaCondition.html#ggandiva-expression-to-string" title="ggandiva_expression_to_string ()">ggandiva_expression_to_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GGandivaCondition.html" title="Expression classes"><span class="returnvalue">GGandivaCondition</span></a> *
</td>
<td class="function_name">
<a class="link" href="GGandivaCondition.html#ggandiva-condition-new" title="ggandiva_condition_new ()">ggandiva_condition_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GGandivaCondition.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td>
<td class="property_name"><a class="link" href="GGandivaCondition.html#GGandivaExpression--expression" title="The “expression” property">expression</a></td>
<td class="property_flags">Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a href="../arrow-glib/GArrowField.html#GArrowField-struct"><span class="type">GArrowField</span></a> *</td>
<td class="property_name"><a class="link" href="GGandivaCondition.html#GGandivaExpression--result-field" title="The “result-field” property">result-field</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="node-classes.html#GGandivaNode"><span class="type">GGandivaNode</span></a> *</td>
<td class="property_name"><a class="link" href="GGandivaCondition.html#GGandivaExpression--root-node" title="The “root-node” property">root-node</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<a name="GGandivaExpression"></a><div class="refsect1">
<a name="GGandivaCondition.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GGandivaCondition.html#GGANDIVA-TYPE-EXPRESSION:CAPS" title="GGANDIVA_TYPE_EXPRESSION">GGANDIVA_TYPE_EXPRESSION</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GGandivaCondition.html#GGandivaExpressionClass" title="struct GGandivaExpressionClass">GGandivaExpressionClass</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GGandivaCondition.html#GGANDIVA-TYPE-CONDITION:CAPS" title="GGANDIVA_TYPE_CONDITION">GGANDIVA_TYPE_CONDITION</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GGandivaCondition.html#GGandivaConditionClass" title="struct GGandivaConditionClass">GGandivaConditionClass</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GGandivaCondition.html#GGandivaCondition-struct" title="GGandivaCondition">GGandivaCondition</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GGandivaCondition.html#GGandivaExpression-struct" title="GGandivaExpression">GGandivaExpression</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GGandivaCondition.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> GGandivaExpression
<span class="lineart">├──</span> <a class="link" href="GGandivaCondition.html" title="Expression classes">GGandivaCondition</a>
<span class="lineart">╰──</span> GGandivaCondition
</pre>
</div>
<div class="refsect1">
<a name="GGandivaCondition.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gandiva-glib/gandiva-glib.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GGandivaCondition.description"></a><h2>Description</h2>
<p><a class="link" href="GGandivaCondition.html#GGandivaExpression"><span class="type">GGandivaExpression</span></a> is a class for an expression tree with a root node,
and a result field.</p>
<p><a class="link" href="GGandivaCondition.html" title="Expression classes"><span class="type">GGandivaCondition</span></a> is a class for an expression that returns boolean.</p>
</div>
<div class="refsect1">
<a name="GGandivaCondition.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ggandiva-expression-new"></a><h3>ggandiva_expression_new ()</h3>
<pre class="programlisting"><a class="link" href="GGandivaCondition.html#GGandivaExpression"><span class="returnvalue">GGandivaExpression</span></a> *
ggandiva_expression_new (<em class="parameter"><code><a class="link" href="node-classes.html#GGandivaNode"><span class="type">GGandivaNode</span></a> *root_node</code></em>,
<em class="parameter"><code><a href="../arrow-glib/GArrowField.html#GArrowField-struct"><span class="type">GArrowField</span></a> *result_field</code></em>);</pre>
<div class="refsect3">
<a name="ggandiva-expression-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>root_node</p></td>
<td class="parameter_description"><p>The root node for the expression.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result_field</p></td>
<td class="parameter_description"><p>The name and type of returned value as <a href="../arrow-glib/GArrowField.html#GArrowField-struct"><span class="type">GArrowField</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggandiva-expression-new.returns"></a><h4>Returns</h4>
<p> A newly created <a class="link" href="GGandivaCondition.html#GGandivaExpression"><span class="type">GGandivaExpression</span></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ggandiva-expression-to-string"></a><h3>ggandiva_expression_to_string ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
ggandiva_expression_to_string (<em class="parameter"><code><a class="link" href="GGandivaCondition.html#GGandivaExpression"><span class="type">GGandivaExpression</span></a> *expression</code></em>);</pre>
<div class="refsect3">
<a name="ggandiva-expression-to-string.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>expression</p></td>
<td class="parameter_description"><p>A <a class="link" href="GGandivaCondition.html#GGandivaExpression"><span class="type">GGandivaExpression</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggandiva-expression-to-string.returns"></a><h4>Returns</h4>
<p>The string representation of the node in the expression tree.</p>
<p> It should be freed with <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ggandiva-condition-new"></a><h3>ggandiva_condition_new ()</h3>
<pre class="programlisting"><a class="link" href="GGandivaCondition.html" title="Expression classes"><span class="returnvalue">GGandivaCondition</span></a> *
ggandiva_condition_new (<em class="parameter"><code><a class="link" href="node-classes.html#GGandivaNode"><span class="type">GGandivaNode</span></a> *root_node</code></em>);</pre>
<div class="refsect3">
<a name="ggandiva-condition-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>root_node</p></td>
<td class="parameter_description"><p>The root node for the condition.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ggandiva-condition-new.returns"></a><h4>Returns</h4>
<p> A newly created <a class="link" href="GGandivaCondition.html" title="Expression classes"><span class="type">GGandivaCondition</span></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-4-0-0.html#api-index-4.0.0">4.0.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GGandivaCondition.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GGANDIVA-TYPE-EXPRESSION:CAPS"></a><h3>GGANDIVA_TYPE_EXPRESSION</h3>
<pre class="programlisting">#define GGANDIVA_TYPE_EXPRESSION (ggandiva_expression_get_type())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GGandivaExpressionClass"></a><h3>struct GGandivaExpressionClass</h3>
<pre class="programlisting">struct GGandivaExpressionClass {
GObjectClass parent_class;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GGANDIVA-TYPE-CONDITION:CAPS"></a><h3>GGANDIVA_TYPE_CONDITION</h3>
<pre class="programlisting">#define GGANDIVA_TYPE_CONDITION (ggandiva_condition_get_type())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GGandivaConditionClass"></a><h3>struct GGandivaConditionClass</h3>
<pre class="programlisting">struct GGandivaConditionClass {
GGandivaExpressionClass parent_class;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GGandivaCondition-struct"></a><h3>GGandivaCondition</h3>
<pre class="programlisting">typedef struct _GGandivaCondition GGandivaCondition;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GGandivaExpression-struct"></a><h3>GGandivaExpression</h3>
<pre class="programlisting">typedef struct _GGandivaExpression GGandivaExpression;</pre>
</div>
</div>
<div class="refsect1">
<a name="GGandivaCondition.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GGandivaExpression--expression"></a><h3>The <code class="literal">“expression”</code> property</h3>
<pre class="programlisting"> “expression” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre>
<p>The raw std::shared&lt;gandiva::Expression&gt; *.</p>
<p>Owner: GGandivaExpression</p>
<p>Flags: Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="GGandivaExpression--result-field"></a><h3>The <code class="literal">“result-field”</code> property</h3>
<pre class="programlisting"> “result-field” <a href="../arrow-glib/GArrowField.html#GArrowField-struct"><span class="type">GArrowField</span></a> *</pre>
<p>The name and type of returned value as #GArrowField.</p>
<p>Owner: GGandivaExpression</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="GGandivaExpression--root-node"></a><h3>The <code class="literal">“root-node”</code> property</h3>
<pre class="programlisting"> “root-node” <a class="link" href="node-classes.html#GGandivaNode"><span class="type">GGandivaNode</span></a> *</pre>
<p>The root node for the expression.</p>
<p>Owner: GGandivaExpression</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>