#2593: document topology relationship functions intersects and equals.

git-svn-id: http://svn.osgeo.org/postgis/trunk@12170 b70326c6-7e19-0410-871a-916f4a2858ee

diff --git a/doc/extras_topology.xml b/doc/extras_topology.xml
index f40c0768a2386336fb6734b286ba8a2d448652ac..509302f891e1556fdf8ca0a2341886a86559ee49 100644 (file)
--- a/doc/extras_topology.xml
+++ b/doc/extras_topology.xml
@@ -3228,4 +3228,111 @@ UNION ALL SELECT ']}'::text as t;
             </refsection>
          </refentry>
 </sect1>
+
+<sect1 id="Topology_Relationships">
+            <sect1info>
+            <abstract>
+                <para>This section lists the Topology functions used to check relationships between topogeometries and topology primitives</para>
+            </abstract>
+        </sect1info>
+           <title>Topology Spatial Relationships</title>
+           <refentry id="TG_Equals">
+        <refnamediv>
+          <refname>Equals</refname>
+      
+          <refpurpose>Returns true if two topogeometries are composed of the same topology primitives.</refpurpose>
+        </refnamediv>
+      
+        <refsynopsisdiv>
+          <funcsynopsis>
+            <funcprototype>
+              <funcdef>boolean <function>Equals</function></funcdef>
+              <paramdef><type>topogeometry </type> <parameter>tg1</parameter></paramdef>
+              <paramdef><type>topogeometry </type> <parameter>tg2</parameter></paramdef>
+            </funcprototype>
+          </funcsynopsis>
+        </refsynopsisdiv>
+      
+        <refsection>
+          <title>Description</title>
+      
+          <para>Returns true if two topogeometries are composed of the same topology primitives: faces, edges, nodes.</para>
+      
+          <!-- optionally mention that this function uses indexes if appropriate -->
+          <note>
+            <para>This function not supported for topogeometries that are geometry collections.  It also can not compare topogeometries from different topologies.</para>
+          </note>
+          <!-- use this format if new function -->
+        <para>Availability: 1.? </para>
+        
+       
+        <!-- Optionally mention 3d support -->
+        <para>&Z_support;</para>
+        </refsection>
+      
+      
+        <refsection>
+          <title>Examples</title>
+      
+          <programlisting><!--TODO: Need example --></programlisting>
+        </refsection>
+      
+        <!-- Optionally add a "See Also" section -->
+        <refsection>
+          <title>See Also</title>
+      
+          <para><xref linkend="GetTopoGeomElements" />, <xref linkend="ST_Equals" /></para>
+        </refsection>
+      </refentry>
+      
+      <refentry id="TG_Intersects">
+        <refnamediv>
+          <refname>Intersects</refname>
+      
+          <refpurpose>Returns true if two topogeometries are composed of the same topology primitives.</refpurpose>
+        </refnamediv>
+      
+        <refsynopsisdiv>
+          <funcsynopsis>
+            <funcprototype>
+              <funcdef>boolean <function>Equals</function></funcdef>
+              <paramdef><type>topogeometry </type> <parameter>tg1</parameter></paramdef>
+              <paramdef><type>topogeometry </type> <parameter>tg2</parameter></paramdef>
+            </funcprototype>
+          </funcsynopsis>
+        </refsynopsisdiv>
+      
+        <refsection>
+          <title>Description</title>
+      
+          <para>Returns true if two topogeometries share primitives or primitives intersect</para>
+      
+          <!-- optionally mention that this function uses indexes if appropriate -->
+          <note>
+            <para>This function not supported for topogeometries that are geometry collections.  It also can not compare topogeometries from different topologies.
+            Also not currently supported for hierarchichal topogeometries (topogeometries composed of other topogeometries).</para>
+          </note>
+          <!-- use this format if new function -->
+        <para>Availability: 1.? </para>
+        
+       
+        <!-- Optionally mention 3d support -->
+        <para>&Z_support;</para>
+        </refsection>
+      
+      
+        <refsection>
+          <title>Examples</title>
+      
+          <programlisting><!--TODO: Need example --></programlisting>
+        </refsection>
+      
+        <!-- Optionally add a "See Also" section -->
+        <refsection>
+          <title>See Also</title>
+      
+          <para><xref linkend="ST_Intersects" /></para>
+        </refsection>
+      </refentry>
+</sect1>
 </chapter>