]> granicus.if.org Git - postgis/commitdiff
Move over ST_Zmflag
authorRegina Obe <lr@pcorp.us>
Fri, 9 Jan 2009 13:17:28 +0000 (13:17 +0000)
committerRegina Obe <lr@pcorp.us>
Fri, 9 Jan 2009 13:17:28 +0000 (13:17 +0000)
git-svn-id: http://svn.osgeo.org/postgis/trunk@3504 b70326c6-7e19-0410-871a-916f4a2858ee

doc/reference.xml
doc/reference_new.xml

index 7564422f0fac01f35005fe3323c9d8d7c97cf3f8..cc3a5b236b9fd9322fdd5a06ff3c461ea5604a2f 100644 (file)
 
       <variablelist>
 
-        <varlistentry id="zmflag">
-          <term>ST_zmflag(geometry)</term>
-
-          <listitem>
-            <para>Returns ZM (dimension semantic) flag of the geometries as a
-            small int. Values are: 0=2d, 1=3dm, 2=3dz, 3=4d.</para>
-          </listitem>
-        </varlistentry>
-
         <varlistentry>
           <term>ST_nrings(geometry)</term>
 
index 321eb2d4379e9e781f3cea0cf46ecdd93b374f82..7174ae88e30f90873874cdf3b62c36d55f03d665 100644 (file)
@@ -4358,7 +4358,7 @@ SELECT ST_Y(ST_Centroid(ST_GeomFromEWKT('LINESTRING(1 2 3 4, 1 1 1 1)')));
          <refsection>
            <title>Examples</title>
            <programlisting>SELECT ST_Z(ST_GeomFromEWKT('POINT(1 2 3 4)'));
- st_y 
+ st_z 
 ------
     3
 (1 row)
@@ -4374,6 +4374,70 @@ SELECT ST_Y(ST_Centroid(ST_GeomFromEWKT('LINESTRING(1 2 3 4, 1 1 1 1)')));
          </refsection>
        </refentry>
 
+       <refentry id="ST_Zmflag">
+         <refnamediv>
+           <refname>ST_Zmflag</refname>
+       
+           <refpurpose>Returns ZM (dimension semantic) flag of the geometries as a
+            small int. Values are: 0=2d, 1=3dm, 2=3dz, 3=4d.</refpurpose>
+         </refnamediv>
+       
+         <refsynopsisdiv>
+           <funcsynopsis>
+             <funcprototype>
+               <funcdef>smallint <function>ST_Zmflag</function></funcdef>
+               <paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
+             </funcprototype>
+           </funcsynopsis>
+         </refsynopsisdiv>
+       
+         <refsection>
+           <title>Description</title>
+       
+           <para>Returns ZM (dimension semantic) flag of the geometries as a
+            small int. Values are: 0=2d, 1=3dm, 2=3dz, 3=4d.</para>
+               
+               <!-- Optionally mention 3d support -->
+           <para><inlinemediaobject>
+               <imageobject>
+                 <imagedata fileref="images/check.png" />
+               </imageobject>
+             </inlinemediaobject> This function supports 3d and will not drop the z-index.</para>
+         </refsection>
+         
+       
+         <refsection>
+           <title>Examples</title>
+       
+           <programlisting>SELECT ST_Zmflag(ST_GeomFromEWKT('LINESTRING(1 2, 3 4)'));
+ st_zmflag
+-----------
+         0
+               
+SELECT ST_Zmflag(ST_GeomFromEWKT('LINESTRINGM(1 2 3, 3 4 3)'));
+ st_zmflag
+-----------
+         1
+       
+SELECT ST_Zmflag(ST_GeomFromEWKT('CIRCULARSTRING(1 2 3, 3 4 3, 5 6 3)'));
+ st_zmflag
+-----------
+         2
+SELECT ST_Zmflag(ST_GeomFromEWKT('POINT(1 2 3 4)'));
+ st_zmflag
+-----------
+         3
+</programlisting>
+         </refsection>
+       
+         <!-- Optionally add a "See Also" section -->
+         <refsection>
+           <title>See Also</title>
+       
+           <para><xref linkend="ST_CoordDim" /></para>
+         </refsection>
+       </refentry>
+
 
   </sect1>